diff --git a/.speakeasy/logs/changes/changes.html b/.speakeasy/logs/changes/changes.html index 01dc1842..b4096317 100644 --- a/.speakeasy/logs/changes/changes.html +++ b/.speakeasy/logs/changes/changes.html @@ -98,7 +98,15 @@

Csharp SDK Changes:

\ No newline at end of file diff --git a/.speakeasy/logs/changes/changes.md b/.speakeasy/logs/changes/changes.md index db664c66..56ff270b 100644 --- a/.speakeasy/logs/changes/changes.md +++ b/.speakeasy/logs/changes/changes.md @@ -1,2 +1,10 @@ ## Csharp SDK Changes: -* `Codat.bankFeeds.SourceAccounts.GenerateOtp()`: **Added** +* `Codat.lending.Companies.List()`: `response.results[].DataConnections[].IntegrationKey` **Changed** +* `Codat.lending.Companies.Create()`: `response.dataConnections[].IntegrationKey` **Changed** +* `Codat.lending.Companies.Replace()`: `response.dataConnections[].IntegrationKey` **Changed** +* `Codat.lending.Companies.Update()`: `response.dataConnections[].IntegrationKey` **Changed** +* `Codat.lending.Companies.Get()`: `response.dataConnections[].IntegrationKey` **Changed** +* `Codat.lending.Connections.List()`: `response.results[].IntegrationKey` **Changed** +* `Codat.lending.Connections.Create()`: `response.integrationKey` **Changed** +* `Codat.lending.Connections.Get()`: `response.integrationKey` **Changed** +* `Codat.lending.Connections.Unlink()`: `response.integrationKey` **Changed** diff --git a/.speakeasy/logs/changes/new.openapi.yaml b/.speakeasy/logs/changes/new.openapi.yaml index 6318d4d2..1b668801 100644 --- a/.speakeasy/logs/changes/new.openapi.yaml +++ b/.speakeasy/logs/changes/new.openapi.yaml @@ -3,19 +3,14 @@ servers: - description: Production url: 'https://api.codat.io' info: - title: Bank Feeds - version: 3.0.0 - contact: - email: support@codat.io - name: Codat + title: Lending description: |- - Bank Feeds solution enables your SMB users to set up bank feeds from accounts in your application to supported accounting software. + Our Lending solution helps you make smarter credit decisions on small businesses by enabling you to pull your customers' latest data from accounting, banking, and commerce software they are already using. It also includes features to help providers verify the accuracy of data and process it more efficiently. - 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 Lending solution is built on top of the latest accounting, commerce, and banking data, providing you with the most important data points you need to get a full picture of SMB creditworthiness and make a comprehensive assessment of your customers. - [Explore solution](https://docs.codat.io/bank-feeds-api/overview) | [See OpenAPI spec](https://github.com/codatio/oas) + [Explore solution](https://docs.codat.io/lending/overview) | [See OpenAPI spec](https://github.com/codatio/oas) - --- ## Endpoints @@ -23,10 +18,19 @@ 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. | + | Bank statements | Retrieve banking data from linked bank accounts. | + | Sales | Retrieve standardized sales data from a linked commerce software. | + | Financial statements | Financial data and reports from a linked accounting software. | + | Liabilities | Debt and other liabilities. | + | Accounts payable | Data from a linked accounting software representing money the business owes money to its suppliers. | + | Accounts receivable | Data from a linked accounting software representing money owed to the business for sold goods or services. | + | Transactions | Data from a linked accounting software representing transactions. | + | Company info | View company information fetched from the source platform. | + | Data integrity | Match mutable accounting data with immutable banking data to increase confidence in financial data. | + | Excel reports | Download reports in Excel format. | + | Manage data | Control how data is retrieved from an integration. | + | File upload | Endpoints to manage uploaded files. | + | Loan writeback | Implement the [loan writeback](https://docs.codat.io/lending/guides/loan-writeback/introduction) procedure in your lending process to maintain an accurate position of a loan during the entire lending cycle. | version: 3.0.0 contact: @@ -72,7 +76,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: lending-api x-codat-keep-docs-paths-local: true x-codat-speakeasy-pagination: type: offsetLimit @@ -87,103 +91,40 @@ 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: Bank statements + description: Retrieve banking data from linked bank accounts. + - name: Sales + description: Retrieve standardized sales data from a linked commerce software. + - name: Financial statements + description: Financial data and reports from a linked accounting software. + - name: Liabilities + description: Debt and other liabilities. + - name: Accounts payable + description: Data from a linked accounting software representing money the business owes money to its suppliers. + - name: Accounts receivable + description: Data from a linked accounting software representing money owed to the business for sold goods or services. + - name: Accounting bank data + description: Access bank transactions from an accounting software. - 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: Data from a linked accounting software representing transactions. + - name: Company info + description: View company information fetched from the source platform. + - name: Data integrity + description: Match mutable accounting data with immutable banking data to increase confidence in financial data. + - name: Excel reports + description: Download reports in Excel format. + - name: Manage data + description: Control how data is retrieved from an integration. + - name: File upload + description: Endpoints to manage uploaded files. + - name: Loan writeback + description: 'Implement the [loan writeback](https://docs.codat.io/lending/guides/loan-writeback/introduction) procedure in your lending process to maintain an accurate position of a loan during the entire lending cycle.' + - name: Manage reports + description: Generate and review generated reports for a company. + - name: Financial summary + description: 'View financial summary information for a company, including credit model reports and accounting score.' 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: @@ -351,7 +292,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/lending-api#/schemas/Company) associated to your instances.\n\nA [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/lending-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' @@ -363,136 +304,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/lending-api#/schemas/Company) that represents your customer in Codat. \n\nA [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/lending-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/lending-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/lending-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: @@ -535,7 +433,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/lending-api#/schemas/Company) represents a business sharing access to their data." operationId: update-company parameters: - $ref: '#/components/parameters/companyId' @@ -575,32 +473,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/lending-api#/schemas/Company), its [connections](https://docs.codat.io/lending-api#/schemas/Connection) and any cached data. This operation is irreversible.\n\nA [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/lending-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': @@ -615,51 +498,152 @@ 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/lending-api#/schemas/Company) represents a business sharing access to their data.\nEach company can have multiple [connections](https://docs.codat.io/lending-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 - totalResults: 0 - _links: - self: - href: string - current: - href: string - next: - href: string - previous: + 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: + href: string + current: + href: string + next: + href: string + previous: href: string '400': $ref: '#/components/responses/Malformed-Query' @@ -851,439 +835,550 @@ paths: value: status: Unlinked description: '' - '/companies/{companyId}/connections/{connectionId}/data/bankAccounts': + '/companies/{companyId}/data/all': + parameters: + - $ref: '#/components/parameters/companyId' + post: + summary: Refresh all data + operationId: refresh-all-data-types + x-speakeasy-group: manage-data.refresh + x-speakeasy-name-override: all-data-types + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + Refreshes all data types with `fetch on first link` set to `true` for a given company. + + This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. + + [Read more](https://docs.codat.io/core-concepts/data-type-settings) about data type settings and `fetch on first link`. + tags: + - Manage data + '/companies/{companyId}/dataStatus': parameters: - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' get: - x-internal: true + summary: Get data status + operationId: get-data-status + x-speakeasy-group: manage-data + x-speakeasy-name-override: get-status + description: Get the state of each data type for a company tags: - - Bank accounts - summary: List bank accounts - operationId: list-bank-accounts + - Manage data + responses: + '200': + description: OK + content: + application/json: + schema: + title: Data statuses + x-internal: true + type: object + properties: + accountTransactions: + $ref: '#/components/schemas/DataStatus' + nullable: true + balanceSheet: + $ref: '#/components/schemas/DataStatus' + nullable: true + bankAccounts: + $ref: '#/components/schemas/DataStatus' + nullable: true + bankTransactions: + $ref: '#/components/schemas/DataStatus' + nullable: true + billCreditNotes: + $ref: '#/components/schemas/DataStatus' + nullable: true + billPayments: + $ref: '#/components/schemas/DataStatus' + nullable: true + bills: + $ref: '#/components/schemas/DataStatus' + nullable: true + cashFlowStatement: + $ref: '#/components/schemas/DataStatus' + nullable: true + chartOfAccounts: + $ref: '#/components/schemas/DataStatus' + nullable: true + company: + $ref: '#/components/schemas/DataStatus' + nullable: true + creditNotes: + $ref: '#/components/schemas/DataStatus' + nullable: true + customers: + $ref: '#/components/schemas/DataStatus' + nullable: true + directCosts: + $ref: '#/components/schemas/DataStatus' + nullable: true + directIncomes: + $ref: '#/components/schemas/DataStatus' + nullable: true + invoices: + $ref: '#/components/schemas/DataStatus' + nullable: true + itemReceipts: + $ref: '#/components/schemas/DataStatus' + nullable: true + items: + $ref: '#/components/schemas/DataStatus' + nullable: true + journalEntries: + $ref: '#/components/schemas/DataStatus' + nullable: true + journals: + $ref: '#/components/schemas/DataStatus' + nullable: true + paymentMethods: + $ref: '#/components/schemas/DataStatus' + nullable: true + payments: + $ref: '#/components/schemas/DataStatus' + nullable: true + profitAndLoss: + $ref: '#/components/schemas/DataStatus' + nullable: true + purchaseOrders: + $ref: '#/components/schemas/DataStatus' + nullable: true + salesOrders: + $ref: '#/components/schemas/DataStatus' + nullable: true + suppliers: + $ref: '#/components/schemas/DataStatus' + nullable: true + taxRates: + $ref: '#/components/schemas/DataStatus' + nullable: true + trackingCategories: + $ref: '#/components/schemas/DataStatus' + nullable: true + transfers: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-accountBalances: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-accounts: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-transactionCategories: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-transactions: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-companyInfo: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-customers: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-disputes: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-locations: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-orders: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-paymentMethods: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-payments: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-productCategories: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-products: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-taxComponents: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-transactions: + $ref: '#/components/schemas/DataStatus' + nullable: true + examples: + Example: + value: + accountTransactions: + dataType: accountTransactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + balanceSheet: + dataType: balanceSheet + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + bankAccounts: + dataType: bankAccounts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + bankTransactions: + dataType: bankTransactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + billCreditNotes: + dataType: billCreditNotes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + billPayments: + dataType: billPayments + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + bills: + dataType: bills + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + cashFlowStatement: + dataType: cashFlowStatement + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + chartOfAccounts: + dataType: chartOfAccounts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + company: + dataType: company + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + creditNotes: + dataType: creditNotes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + customers: + dataType: customers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + directCosts: + dataType: directCosts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + directIncomes: + dataType: directIncomes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + invoices: + dataType: invoices + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + itemReceipts: + dataType: itemReceipts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + items: + dataType: items + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + journalEntries: + dataType: journalEntries + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + journals: + dataType: journals + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + paymentMethods: + dataType: paymentMethods + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + payments: + dataType: payments + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + profitAndLoss: + dataType: profitAndLoss + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + purchaseOrders: + dataType: purchaseOrders + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + salesOrders: + dataType: salesOrders + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + suppliers: + dataType: suppliers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + taxRates: + dataType: taxRates + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + trackingCategories: + dataType: trackingCategories + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + transfers: + dataType: transfers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-accountBalances: + dataType: banking-accountBalances + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-accounts: + dataType: banking-accounts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-transactionCategories: + dataType: banking-transactionCategories + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-transactions: + dataType: banking-transactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-companyInfo: + dataType: commerce-companyInfo + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-customers: + dataType: commerce-customers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-disputes: + dataType: commerce-disputes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-locations: + dataType: commerce-locations + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-orders: + dataType: commerce-orders + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-paymentMethods: + dataType: commerce-paymentMethods + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-payments: + dataType: commerce-payments + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-productCategories: + dataType: commerce-productCategories + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-products: + dataType: commerce-products + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-taxComponents: + dataType: commerce-taxComponents + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-transactions: + dataType: commerce-transactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/queue/{dataType}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/dataType' + post: + summary: Refresh data type + operationId: refresh-data-type + x-speakeasy-group: manage-data.refresh + x-speakeasy-name-override: data-type + description: |- + Refreshes a given data type for a given company. + + This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. + tags: + - Manage data parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/pageSize' - - $ref: '#/components/parameters/query' - - $ref: '#/components/parameters/orderBy' + - schema: + type: string + format: uuid + in: query + name: connectionId + description: 'Optionally, provide a data connection id to only queue pull operations on that connection.' responses: '200': - description: Success + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PullOperation' + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/history': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: List pull operations + tags: + - Manage data + operationId: list-pull-operations + x-speakeasy-group: manage-data.pull-operations + responses: + '200': + description: OK content: application/json: schema: - $ref: '#/components/schemas/BankAccounts' + $ref: '#/components/schemas/PullOperations' examples: - Dynamics 365 Business Central: + Example: 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 + - id: 97d60846-f07a-4d42-b5a0-0bdcc6ebf56b + companyId: 4645bd78-8988-45bc-ac9e-67ba5df6e4e5 + connectionId: 51baa045-4836-4317-a42e-3542e991e581 + dataType: invoices + status: Initial + requested: '2022-11-14T11:18:37.2798351Z' + progress: 10 + isCompleted: false + isErrored: false _links: current: - href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts?page=1&pageSize=2 + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=1&pageSize=2 self: - href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history next: - href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts?page=2&pageSize=2 - Sage Business Cloud Accounting: - value: - results: - - id: 154d05abe9f24c4babe0f6a741dec1b9 - accountName: Abdi Internet Bank - accountType: Unknown - nominalCode: '1560' - sortCode: '010101' - accountNumber: '11111' - currency: GBP - balance: 49.61 - availableBalance: 49.61 - modifiedDate: '2022-10-24T14:52:53Z' - sourceModifiedDate: '2020-01-27T10:53:26Z' - - id: 565ce07212bc492c8c2d04f43f9f67e3 - accountName: Abdi Live Test - accountType: Unknown - nominalCode: '147852' - sortCode: '123456' - accountNumber: '1234567' - currency: GBP - balance: -225830.75 - availableBalance: -225830.75 - modifiedDate: '2022-10-24T14:52:53Z' - sourceModifiedDate: '2020-01-28T14:00:20Z' - pageNumber: 1 - pageSize: 2 - totalResults: 45 - _links: - current: - href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts - next: - href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts?page=2&pageSize=2 - Sage Intacct: - value: - results: - - id: 'CREDITCARD:55' - accountName: CoT Credit Card - accountType: Credit - nominalCode: '10021' - currency: GBP - modifiedDate: '2023-04-04T16:31:46Z' - sourceModifiedDate: '2023-03-27T14:11:48' - metadata: - isDeleted: false - - id: 'CREDITCARD:58' - accountName: Cot Credit Card 2 - accountType: Credit - nominalCode: '11112' - currency: GBP - modifiedDate: '2023-04-04T16:31:46Z' - sourceModifiedDate: '2023-03-27T14:15:11' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 14 - _links: - current: - href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts - next: - href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts?page=2&pageSize=2 - Xero: - value: - results: - - id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 - accountName: Business Bank Account - accountType: Debit - sortCode: '990404' - accountNumber: '987654321' - currency: GBP - balance: 6681.79 - modifiedDate: '2023-03-15T20:36:09Z' - sourceModifiedDate: '2023-03-15T20:35:07' - metadata: - isDeleted: false - - id: a8d6fb1a-8c5d-4683-90ce-bf9d28fc62ba - accountName: Business Savings Account - accountType: Debit - sortCode: '890303' - accountNumber: '876543210' - currency: GBP - balance: 0 - modifiedDate: '2023-03-15T20:36:09Z' - sourceModifiedDate: '2023-03-15T20:36:06' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 2 - _links: - current: - href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts - Zoho Books: - value: - results: - - id: '104957000000060010' - accountName: Abdi Test - accountType: Unknown - sortCode: '112233' - accountNumber: xxxx5678 - currency: GBP - balance: 69858.44 - modifiedDate: '2022-10-03T08:40:38Z' - institution: Test Bank - - id: '104957000000065002' - accountName: Abdi Test 2 - accountType: Unknown - sortCode: '' - accountNumber: '' - currency: AED - balance: 98.03 - modifiedDate: '2022-10-03T08:40:38Z' - institution: '' - pageNumber: 1 - pageSize: 2 - totalResults: 4 - _links: - current: - href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts - next: - href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts?page=2&pageSize=2 + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=2&pageSize=2 + pageNumber: 0 + pageSize: 0 + totalResults: 0 '400': $ref: '#/components/responses/Malformed-Query' '401': @@ -1294,852 +1389,73149 @@ paths: $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/Not-Found' - '409': - $ref: '#/components/responses/Conflict' '429': $ref: '#/components/responses/Too-Many-Requests' '500': $ref: '#/components/responses/Internal-Server-Error' '503': $ref: '#/components/responses/Service-Unavailable' + description: Gets the pull operation history (datasets) for a given company. + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + '/companies/{companyId}/data/history/{datasetId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/datasetId' + get: + summary: Get pull operation + operationId: get-pull-operation + x-speakeasy-group: manage-data.pull-operations + tags: + - Manage data + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PullOperation' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: Retrieve information about a single dataset or pull operation. + '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/status': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/dataIntegrityDataType' + get: + summary: Get data integrity status + tags: + - Data integrity + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/DataIntegrityStatuses' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-data-integrity-status + x-speakeasy-name-override: status 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. + The *Get data integrity status* endpoint returns the [status](https://docs.codat.io/lending-api#/schemas/DataIntegrityStatus) for the company’s match results between the data type provided in the URL and other data types that Data Integrity uses to support matching. + This endpoint helps you understand whether match data is available and, if so, how to usefully query it. - [Bank accounts](https://docs.codat.io/bank-feeds-api#/schemas/BankAccount) are financial accounts maintained by a bank or other financial institution. + The response tells you: - 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': + - Whether match results are available. + - When the results were generated, and their status. + - The connection IDs, amounts, and dates involved to support useful querying. + '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/summaries': parameters: - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/dataIntegrityDataType' get: - summary: Get create/update bank account model - x-internal: true + summary: Get data integrity summaries tags: - - Bank accounts + - Data integrity responses: '200': description: OK content: application/json: schema: - $ref: '#/components/schemas/PushOption' - examples: - Dynamics 365 Business Central: - value: - type: Object - displayName: Bank Account - description: An account that bank transactions may be recorded against - properties: - accountName: - type: String - displayName: Name - description: The name of the bank account in the originating system - required: true - validation: - warnings: [] - information: - - field: AccountName - details: 'Needs to be of the format ''{No.}-{Name}''' - currency: - type: String - displayName: Currency - description: The currency of the bank account - required: true - accountNumber: - type: String - displayName: Account Number - description: The account number for the bank account - required: false - nominalCode: - type: String - displayName: Nominal Code - description: The external reference given to each nominal account for a business - required: false - validation: - warnings: [] - information: - - field: NominalCode - details: Bank Account Posting Group with Nominal Account must exist - sortCode: - type: String - displayName: Sort Code - description: The sort code for the bank account - required: false - validation: - warnings: [] - information: - - field: SortCode - details: Must have a length between 0 and 20 characters - iBan: - type: String - displayName: IBAN - description: The international bank account number of the account. Often used when making or receiving international payments - required: false - overdraftLimit: - type: Number - displayName: Overdraft Limit - description: The pre-arranged overdraft limit of the account - required: false - validation: - warnings: [] - information: - - field: OverdraftLimit - details: Default value is 0 - required: true - Exact (Netherlands): - value: - type: Object - displayName: Bank Account - description: An account that bank transactions may be recorded against - properties: - accountName: - type: String + $ref: '#/components/schemas/DataIntegritySummaries' + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-data-integrity-summaries + x-speakeasy-name-override: summaries + description: |- + The *Get data integrity summary* endpoint returns a [summary](https://docs.codat.io/lending-api#/schemas/DataIntegritySummary) of match results for a given data type filtered by a query string in the [Codat query language](https://docs.codat.io/using-the-api/querying). + + For example, if you wanted to see summary match results only for transactions after 1 December 2020, you could include a query parameter of `query=date>2020-12-01`. + + The endpoint response includes only the summary results, not transactions. To view match data for transactions, use the [List data integrity details](https://docs.codat.io/lending-api#/operations/get-data-integrity-summaries) endpoint. + parameters: + - $ref: '#/components/parameters/query' + '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/details': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/dataIntegrityDataType' + get: + summary: List data integrity details + tags: + - Data integrity + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/DataIntegrityDetails' + 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' + operationId: list-data-integrity-details + x-speakeasy-name-override: details + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + description: |- + The *List data integrity details* endpoint returns the match result record by record for a given data type, filtered based on a query string in the same way as summary results. + + The [details](https://docs.codat.io/lending-api#/schemas/DataIntegrityDetail) are paginated and support ordering, following the same conventions as our other data endpoints. + '/companies/{companyId}/reports/enhancedProfitAndLoss/accounts': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: Get categorized profit and loss statement + description: |- + The *Get categorized profit and loss statement* endpoint returns a list of categorized accounts that appear on a company’s Profit and Loss statement. It also includes a balance as of the financial statement date. + + Codat suggests a category for each account automatically, but you can [change it](https://docs.codat.io/lending/features/financial-statements-overview#recategorizing-accounts) to a more suitable one. + tags: + - Financial statements + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/EnhancedFinancialReport' + example: + reportInfo: + currency: GBP + reportName: EnhancedProfitAndLossAccounts + companyName: Biscuits + generatedDate: '2023-03-24T16:40:59.0847354Z' + reportItems: + - date: '2022-08-31T00:00:00' + balance: 830.93 + accountId: 04f7111b-55d4-4efc-b329-1bd5c791933a + accountName: Repairs & Maintenance + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 12000 + accountId: 7f6a0e92-65be-4333-9a0a-d981b03bedd1 + accountName: Wages + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: CostOfSales + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 28937.71 + accountId: 7403e960-5b72-42ff-abf4-c870ad8910bd + accountName: Purchases + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: CostOfSales + confidence: 99.99 + - levelName: Inventory + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 582.4 + accountId: e8a0a24e-2dab-46b1-bfe1-6e92551c04e8 + accountName: Purchase Discounts + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: CostOfSales + confidence: 99.99 + - levelName: Inventory + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 350.44 + accountId: cbf82e0d-87a7-464d-b567-9274ea94a1c0 + accountName: Charitable and Political Donations + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: NonOperating + confidence: 99.99 + - levelName: Donations + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 535.81 + accountId: 78785fd7-f197-4c34-aa17-6e76b9255d34 + accountName: Interest Paid (operating) + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: NonOperating + confidence: 99.99 + - levelName: Interest + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 633.05 + accountId: fb3210ef-edeb-48af-bb49-b85d40c1e6bb + accountName: Corporation Tax + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: NonOperating + confidence: 99.99 + - levelName: Taxes + confidence: 99.99 + - levelName: CorporationTaxes + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 782.61 + accountId: f3aa84fe-5c31-4107-b207-7e0419f636d7 + accountName: Bank Fees + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: BankCharges + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 8000 + accountId: 9cbe5fe4-ca60-4792-8bf1-de01fb7010aa + accountName: Rent + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Leases + confidence: 99.99 + - levelName: BuildingRentLease + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1090.68 + accountId: 138a8eb3-5c08-4e59-a3bc-892119694447 + accountName: Motor Vehicle Expenses + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Leases + confidence: 99.99 + - levelName: EquipmentRentLease + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 26307.02 + accountId: 868591ad-f9c2-4956-a5ec-c32c1d48c6f3 + accountName: Advertising & Marketing + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Marketing + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1128.85 + accountId: 1734ff00-2a17-45b4-8db6-2dc2e832c460 + accountName: 'Postage, Freight & Courier' + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Marketing + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 40 + accountId: 7d8d0322-f452-47de-a8e8-54b0130e6f38 + accountName: Subscriptions + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Marketing + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 5.72 + accountId: 4378ddba-36b4-4b35-9970-bd972b20d137 + accountName: Amortization + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: NonCash + confidence: 99.99 + - levelName: Amortization + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1539.18 + accountId: 940c8a59-3348-4a0b-a1b1-781d9f29cc8b + accountName: Depreciation Expense + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: NonCash + confidence: 99.99 + - levelName: Depreciation + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1416.05 + accountId: e7ac3baa-cfbe-40c1-a172-83d22e84435b + accountName: Entertainment-100% business + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Personnel + confidence: 99.99 + - levelName: EmployeeBenefits + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1465.61 + accountId: b5e801e8-8dbc-4390-ac99-3b0fff54a89f + accountName: General Expenses + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 7347.35 + accountId: 5360066d-1474-49f6-a7a5-c66d5f6032ba + accountName: 'Light, Power, Heating' + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1027.25 + accountId: 7aa7988a-ff61-4cb8-bef3-15395355d108 + accountName: Printing & Stationery + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 45 + accountId: 043b6bcb-dfe6-4c97-9b4c-f9b300fe3f03 + accountName: Telephone & Internet + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 0 + accountId: eef78ed1-dfed-447c-bdba-3a49fb2c044b + accountName: Audit & Accountancy fees + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 130 + accountId: c16f5c35-8283-47da-9d09-5fecb183b0cb + accountName: Cleaning + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 860.02 + accountId: df62060b-41cc-4bf2-9de7-c7e537b5663a + accountName: Travel - National + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Travel + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 850.22 + accountId: 68794a8f-b22d-4520-b97b-025b7cb10f94 + accountName: Other Revenue + accountCategory: + status: Suggested + levels: + - levelName: Income + confidence: 99.99 + - levelName: Revenue + confidence: 99.99 + - levelName: Online + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 138457.98 + accountId: 72df89d2-512b-4455-af51-a6b563733842 + accountName: Sales + accountCategory: + status: Suggested + levels: + - levelName: Income + confidence: 99.99 + - levelName: Revenue + confidence: 99.99 + - levelName: Wholesale + confidence: 99.99 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-categorized-profit-and-loss-statement + x-speakeasy-name-override: get-categorized-accounts + x-speakeasy-group: financial-statements.profit-and-loss + parameters: + - $ref: '#/components/parameters/reportDate' + - $ref: '#/components/parameters/numberOfPeriods' + '/companies/{companyId}/reports/enhancedBalanceSheet/accounts': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: Get categorized balance sheet statement + operationId: get-categorized-balance-sheet-statement + x-speakeasy-name-override: get-categorized-accounts + x-speakeasy-group: financial-statements.balance-sheet + description: |- + The *Get categorized balance sheet statement* endpoint returns a list of categorized accounts that appear on a company’s Balance Sheet along with a balance per financial statement date. + + Codat suggests a category for each account automatically, but you can [change it](https://docs.codat.io/lending/features/financial-statements-overview#recategorizing-accounts) to a more suitable one. + tags: + - Financial statements + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/EnhancedFinancialReport' + example: + reportInfo: + currency: GBP + reportName: EnhancedBalanceSheetAccounts + companyName: Biscuits + generatedDate: '2023-03-24T16:42:09.2973105Z' + reportItems: + - date: '2022-08-31T00:00:00' + balance: 12973.03 + accountId: 22de1660-d745-4809-a363-16b134607e66 + accountName: Prepayments + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: AccruedDeferredAssets + confidence: 99.99 + - levelName: PrepaidExpenses + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 316065.92 + accountId: dbcaf288-2b39-4b95-8ab3-42202ab15918 + accountName: Business Current Account + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Bank + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 65945.07 + accountId: e5d7612c-1671-47b4-b733-5db48363fcd0 + accountName: Inventory + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Inventory + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 71937.95 + accountId: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + accountName: Accounts Receivable + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Receivables + confidence: 99.99 + - levelName: AccountsReceivables + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 2180148.56 + accountId: 724ca578-8b5d-4bdb-ad45-e3820eee9de9 + accountName: Office Equipment + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: NonCurrent + confidence: 99.99 + - levelName: AccumulatedDepreciationDepletionAmortization + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1804674.9 + accountId: be3eb911-034b-42de-95db-0d58ac978b7f + accountName: Computer Equipment + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: NonCurrent + confidence: 99.99 + - levelName: AccumulatedDepreciationDepletionAmortization + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 3417424.16 + accountId: 39225d6f-3722-4508-ac3f-a2f6ec96ad31 + accountName: Retained Earnings + accountCategory: + status: Suggested + levels: + - levelName: Equity + confidence: 99.99 + - levelName: RetainedEarnings + confidence: 99.99 + - levelName: CapitalIncomeReserve + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 44252.52 + accountId: 78828dd9-6008-4662-b43c-e9d87907fd2b + accountName: Current Year Earnings + accountCategory: + status: Suggested + levels: + - levelName: Equity + confidence: 99.99 + - levelName: ShareCapital + confidence: 99.99 + - levelName: CommonStock + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 75835.64 + accountId: 53bf27a7-7497-4c61-9887-dfaad5c6d80a + accountName: Accounts Payable + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: AccountsPayable + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 208264.65 + accountId: e2530acd-91c8-48f8-a35f-935dbd7432e2 + accountName: Accruals + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: AccruedLiabilities + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 0 + accountId: d19852a2-e292-4eb9-a909-9dadb95c0e76 + accountName: Rounding + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Bank + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 25184.57 + accountId: 62060aae-e5a6-4db5-a3bb-6abec6d47959 + accountName: Credit Card Control Account + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Debt + confidence: 99.99 + - levelName: CreditCards + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 9650.58 + accountId: 9be6382f-6b33-402d-b448-0db1dbf67a98 + accountName: Historical Adjustment + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Debt + confidence: 99.99 + - levelName: LoansPayable + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 2022.41 + accountId: 8636effc-50fb-45ba-8b2b-18336fa29b6b + accountName: John Smith + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Debt + confidence: 99.99 + - levelName: LoansPayable + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 29034.75 + accountId: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + accountName: VAT + accountCategory: + status: Confirmed + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Personnel + confidence: 99.99 + - levelName: PensionPayable + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1076.55 + accountId: 3b58f7ff-fa16-453a-9931-f020816d76e7 + accountName: Interest Payables + accountCategory: + status: Confirmed + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Personnel + confidence: 99.99 + - levelName: PensionPayable + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 0 + accountId: 8852a857-aa9d-4706-839f-638e9d6b5a66 + accountName: Unpaid Expense Claims + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: NonCurrent + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 638999.6 + accountId: 55008233-40e7-41ac-84af-2255fa028c2e + accountName: Loan + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: NonCurrent + confidence: 99.99 + '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' + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/numberOfPeriods' + '/companies/{companyId}/reports/enhancedCashFlow/transactions': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: Get categorized bank statement + operationId: get-categorized-bank-statement + x-speakeasy-group: banking.categorized-statement + description: "\uFEFF> **Categorization engine**\n>\n> The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source.\n\nThe _Get categorized bank statement_ endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources." + tags: + - Bank statements + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/EnhancedCashFlowTransactions' + examples: + Categorized bank statement: + $ref: '#/components/examples/EnhancedCashflowExample' + '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' + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + '/companies/{companyId}/reports/enhancedInvoices': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: List reconciled invoices + tags: + - Accounts receivable + operationId: list-reconciled-invoices + x-speakeasy-name-override: list-reconciled + x-speakeasy-group: accounts-receivable.invoices + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + responses: + '200': + description: OK + content: + application/json: + x-speakeasy-usage-example: true + schema: + $ref: '#/components/schemas/EnhancedInvoicesReport' + example: + reportInfo: + pageNumber: 1 + pageSize: 10 + totalResults: 101 + reportName: Invoices report + companyName: Small Sandbox + generatedDate: '2023-05-10T10:50:23.9437977Z' + reportItems: + - id: 15221fa4-e91a-4f64-a2bb-caeab4db85a4 + invoiceNumber: UDs5KlfE + customerRef: + id: ee4d0eee-063d-4c9f-8226-2c9a6a816249 + customerName: Serena Keeling + issueDate: '2021-04-06T09:44:00' + dueDate: '2021-04-06T09:44:00' + status: Paid + currency: GBP + totalAmount: 7044.83 + amountDue: 0 + paidOnDate: '2021-04-06T09:44:00' + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2022-02-27T18:28:00' + payments: [] + - id: 58aea1cb-5b31-4eed-ba16-489dfa67a831 + invoiceNumber: 1IU1PMoT + customerRef: + id: 81e9c0df-3e5e-4180-b20c-c8e58100cdf3 + customerName: Quinton Kovacek + issueDate: '2021-04-06T09:44:00' + dueDate: '2021-04-06T09:44:00' + status: Paid + currency: GBP + totalAmount: 3567.59 + amountDue: 0 + paidOnDate: '2021-04-06T09:44:00' + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2021-06-23T22:47:00' + payments: [] + - id: 9ecd07bc-9cab-4516-bad0-a0cd565cdbaf + invoiceNumber: eEIWyPN4 + customerRef: + id: c7326084-cd56-48e6-bcfa-be8919e024e1 + customerName: Antwon Dach + issueDate: '2021-04-08T01:27:00' + dueDate: '2021-04-18T01:27:00' + status: Paid + currency: GBP + totalAmount: 153233.36 + amountDue: 0 + paidOnDate: '2021-04-10T12:31:00' + modifiedDate: '2022-08-01T09:44:59Z' + sourceModifiedDate: '2021-11-11T12:10:00' + payments: + - id: 0878e8be-6746-4347-80ba-5491328c8411 + date: '2021-04-10T12:31:00' + paymentType: payments + amount: 153233.36 + currency: GBP + currencyRate: 1 + - id: 7cea078a-5c9a-4788-ae72-9bb60c5cc184 + invoiceNumber: BXb8mYQW + customerRef: + id: 44e8516d-bcb0-459f-9e5d-7beaa56d57d0 + customerName: Dolores Rath + issueDate: '2021-04-16T17:30:00' + dueDate: '2021-04-23T17:30:00' + status: Paid + currency: GBP + totalAmount: 12657.69 + amountDue: 0 + paidOnDate: '2021-04-23T17:30:00' + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2021-12-08T11:32:00' + payments: + - id: 17b42934-13f6-4738-a506-2e253b1a606f + date: '2021-04-23T17:30:00' + paymentType: payments + amount: 12657.69 + currency: GBP + currencyRate: 1 + - id: aa4503d7-fe01-49fe-ba42-259b421ac640 + invoiceNumber: wdjwiL5B + customerRef: + id: 5cbaf1af-4f02-4206-85ab-c525bd9b4f99 + customerName: Bryana Douglas + issueDate: '2021-04-20T06:46:00' + dueDate: '2021-04-27T06:46:00' + status: PartiallyPaid + currency: GBP + totalAmount: 12935.39 + amountDue: 381.09 + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2022-03-11T20:03:00' + payments: + - id: 1c03986b-9b6c-4220-bde6-4e3eba6cef9f + date: '2021-04-23T14:59:00' + paymentType: payments + amount: 12554.3 + currency: GBP + currencyRate: 1 + - id: d8a0e26e-4ec8-4fb5-887d-8b7531e3bedf + invoiceNumber: cTjJcu8x + customerRef: + id: 6f5290e5-70aa-4d0c-816e-9d2312cf217f + customerName: Brady Wilderman + issueDate: '2021-04-23T09:32:00' + dueDate: '2021-05-03T09:32:00' + status: Paid + currency: GBP + totalAmount: 21526.72 + amountDue: 0 + paidOnDate: '2021-05-03T09:32:00' + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2021-03-12T22:37:00' + payments: + - id: 93c9c11b-3ec0-4314-85f6-0751763e752a + date: '2021-05-03T09:32:00' + paymentType: payments + amount: 21506.72 + currency: GBP + currencyRate: 1 + - id: 06890e67-35fb-4276-9857-95db40cfd15d + invoiceNumber: htXJuUDb + customerRef: + id: 44e8516d-bcb0-459f-9e5d-7beaa56d57d0 + customerName: Dolores Rath + issueDate: '2021-05-01T23:23:00' + dueDate: '2021-05-11T23:23:00' + status: PartiallyPaid + currency: GBP + totalAmount: 7151.41 + amountDue: 1225.06 + modifiedDate: '2022-08-01T09:44:59Z' + sourceModifiedDate: '2022-02-24T23:02:00' + payments: + - id: 82865077-0857-46db-b9a1-6d21da43b6aa + date: '2021-05-04T17:57:00' + paymentType: payments + amount: 5926.35 + currency: GBP + currencyRate: 1 + - id: 160e8b51-1fa0-46b9-98fe-1ff5399ce99b + invoiceNumber: 9wegEXpG + customerRef: + id: 44e8516d-bcb0-459f-9e5d-7beaa56d57d0 + customerName: Dolores Rath + issueDate: '2021-05-18T08:53:00' + dueDate: '2021-05-25T08:53:00' + status: PartiallyPaid + currency: GBP + totalAmount: 22522.34 + amountDue: 14408.54 + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2022-01-13T07:52:00' + payments: + - id: 75bd7205-bc12-4517-9964-aae159fdfaee + date: '2021-05-23T04:04:00' + paymentType: payments + amount: 8113.8 + currency: GBP + currencyRate: 1 + - id: 5a934955-561d-436a-a564-fd624a79f54c + invoiceNumber: l7YwGxG7 + customerRef: + id: cc96af36-e2f5-49f7-bf40-271503f45071 + customerName: Ignacio Moore + issueDate: '2021-05-25T19:51:00' + dueDate: '2021-06-04T19:51:00' + status: Paid + currency: GBP + totalAmount: 11047.08 + amountDue: 0 + paidOnDate: '2021-05-28T07:31:00' + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2021-08-06T05:50:00' + payments: + - id: 608fd022-f7d0-44a9-90c4-bebe0573f206 + date: '2021-05-28T07:31:00' + paymentType: payments + amount: 11047.08 + currency: GBP + currencyRate: 1 + - id: 17690788-2936-46b5-ba46-ba6a36a87483 + invoiceNumber: ntH1cRYz + customerRef: + id: e1ecc8f2-8a63-4fe9-97c9-c87fd90ca0a6 + customerName: Freida Ebert + issueDate: '2021-05-27T19:07:00' + dueDate: '2021-06-03T19:07:00' + status: PartiallyPaid + currency: GBP + totalAmount: 7191.32 + amountDue: 5036.83 + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2021-03-27T08:54:00' + payments: + - id: a343b2a0-d327-41b0-993e-7b6b92fde425 + date: '2021-06-03T19:07:00' + paymentType: payments + amount: 2154.49 + currency: GBP + currencyRate: 1 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: Gets a list of invoices linked to the corresponding banking transaction + '/companies/{companyId}/reports/liabilities/loans/transactions': + parameters: + - $ref: '#/components/parameters/companyId' + - schema: + type: string + enum: + - banking + - commerce + - accounting + in: query + name: sourceType + description: Data source type. + required: true + post: + summary: Generate loan transactions report + description: | + The _Generate loan transactions_ endpoint requests the generation of the Loan Transactions report. + + Learn more about Codat's liabilities feature [here](https://docs.codat.io/lending/features/liabilities-overview). + + Make sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint. + tags: + - Liabilities + responses: + '202': + description: Accepted + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: generate-loan-transactions + x-speakeasy-name-override: generate-loan-transactions + get: + summary: List loan transactions + description: | + The *List loan transactions* endpoint returns all [loan transactions](https://docs.codat.io/lending-api#/schemas/LoanTransactions) identified from a company's accounting, banking, and commerce integrations. + + This detail gives analysts a better idea of the loan obligations a company may have. + + Make sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint. + tags: + - Liabilities + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/LoanTransactions' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: list-loan-transactions + x-speakeasy-name-override: list-loan-transactions + '/companies/{companyId}/reports/liabilities/loans': + parameters: + - $ref: '#/components/parameters/companyId' + - schema: + type: string + enum: + - banking + - commerce + - accounting + in: query + name: sourceType + description: Data source type. + required: true + post: + summary: Generate loan summaries report + description: | + The _Generate loan summaries_ endpoint requests the generation of the Loan Summaries report. + + Learn more about Codat's liabilities feature [here](https://docs.codat.io/lending/features/liabilities-overview). + + Make sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint. + tags: + - Liabilities + responses: + '202': + description: Accepted + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: generate-loan-summary + x-speakeasy-name-override: generate-loan-summary + get: + summary: Get loan summaries + description: | + The *Get loan summaries* endpoint returns a summary by integration type of all loans identified from a company's accounting, banking, and commerce integrations. + + The endpoint returns a list of a company's [loan summaries](https://docs.codat.io/lending-api#/schemas/LoanSummary) for each valid data connection. + + Make sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint. + tags: + - Liabilities + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/LoanSummary' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-loan-summary + x-speakeasy-name-override: get-loan-summary + '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/revenue': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get commerce revenue metrics + tags: + - Sales + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceReport' + example: + - reportInfo: + name: revenue + displayName: Revenue + dimensions: + - index: 0 + displayName: Period + type: datespan + items: + - index: 0 + displayName: Period 0 + start: '2022-01-01' + end: '2022-12-31' + - index: 1 + displayName: Revenue metrics + type: string + items: + - index: 0 + value: Revenue + - index: 1 + value: Revenue growth + measures: + - displayName: Value + units: GBP + index: 0 + type: currency + - displayName: Percentage change vs. previous period + units: '%' + index: 1 + type: percentage + reportData: + - dimension: 0 + dimensionDisplayName: Period + item: 0 + itemDisplayName: Period 0 + components: + - dimension: 1 + dimensionDisplayName: Revenue metrics + item: 0 + itemDisplayName: Revenue + measures: + - index: 0 + measureDisplayName: Value + value: 2392.48 + - dimension: 1 + dimensionDisplayName: Revenue metrics + item: 1 + itemDisplayName: Revenue growth + measures: + - index: 1 + measureDisplayName: Percentage change vs. previous period + value: 276.65 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-commerce-revenue-metrics + x-speakeasy-name-override: get-revenue + x-speakeasy-group: sales.metrics + description: | + The *Get revenue report* endpoint returns the revenue and revenue growth for a specific company connection over one or more periods of time. + + This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. + + [Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate the revenue metrics. + + #### Response structure + + The Revenue report's dimensions and measures are: + + | Index | Dimensions | + |---------------|------------| + | `index` = 0 | Period | + | `index` = 1 | Revenue | + + | Index | Measures | + |---------------|--------------------------------------------------------------------------------------------------------------------------| + | `index` = 0 | Value | + | `index` = 1 | Percentage change, defined as the change between the current and previous periods' values and expressed as a percentage. | + + The report data then combines multiple reporting dimensions and measures and outputs the value of each combination. + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/periodLength' + - $ref: '#/components/parameters/numberOfPeriodsRequired' + - $ref: '#/components/parameters/periodUnit' + - $ref: '#/components/parameters/includeDisplayNames' + '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/orders': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get orders report + tags: + - Sales + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceReport' + example: + - reportInfo: + name: orders + displayName: Orders + dimensions: + - index: 0 + displayName: Period + type: datespan + items: + - index: 0 + displayName: Period 0 + start: '2022-01-01' + end: '2022-12-31' + - index: 1 + displayName: Order metrics + type: string + items: + - index: 0 + value: Number of orders + - index: 1 + value: Total value + - index: 2 + value: Average order value + measures: + - displayName: Count + index: 0 + type: int + - displayName: Value + units: GBP + index: 1 + type: currency + reportData: + - dimension: 0 + dimensionDisplayName: Period + item: 0 + itemDisplayName: Period 0 + components: + - dimension: 1 + dimensionDisplayName: Order metrics + item: 0 + itemDisplayName: Number of orders + measures: + - index: 0 + measureDisplayName: Count + value: 94 + - dimension: 1 + dimensionDisplayName: Order metrics + item: 1 + itemDisplayName: Total value + measures: + - index: 1 + measureDisplayName: Value + value: 3315.18 + - dimension: 1 + dimensionDisplayName: Order metrics + item: 2 + itemDisplayName: Average order value + measures: + - index: 1 + measureDisplayName: Value + value: 35.27 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-commerce-orders-report + x-speakeasy-name-override: get-orders + x-speakeasy-group: sales.reports + description: | + The *Get orders report* endpoint returns the number of orders, total value, and average order value for a specific company's commerce connection over one or more periods of time. + + This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. + + [Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate the order metrics. + + #### Response structure + + The Orders report's dimensions and measures are: + + | Index | Dimensions | + |---------------|----------------| + | `index` = 0 | Period | + | `index` = 1 | Order metrics | + + | Index | Measures | + |---------------|------------| + | `index` = 0 | Count | + | `index` = 1 | Value | + + The report data then combines multiple reporting dimensions and measures and outputs the value of each combination. + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/periodLength' + - $ref: '#/components/parameters/numberOfPeriodsRequired' + - $ref: '#/components/parameters/periodUnit' + - $ref: '#/components/parameters/includeDisplayNames' + '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/refunds': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get refunds report + tags: + - Sales + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceReport' + example: + - reportInfo: + name: refunds + displayName: Refunds + dimensions: + - index: 0 + displayName: Period + type: datespan + items: + - index: 0 + displayName: Period 0 + start: '2022-01-01' + end: '2022-12-31' + - index: 1 + displayName: Refund metrics + type: string + items: + - index: 0 + value: Number of refunds + - index: 1 + value: Value of refunds + - index: 2 + value: Refund rate + measures: + - displayName: Count + index: 0 + type: int + - displayName: Value + units: GBP + index: 1 + type: currency + - displayName: Percentage + units: '%' + index: 2 + type: percentage + reportData: + - dimension: 0 + dimensionDisplayName: Period + item: 0 + itemDisplayName: Period 0 + components: + - dimension: 1 + dimensionDisplayName: Refund metrics + item: 0 + itemDisplayName: Number of refunds + measures: + - index: 0 + measureDisplayName: Count + value: 39 + - dimension: 1 + dimensionDisplayName: Refund metrics + item: 1 + itemDisplayName: Value of refunds + measures: + - index: 1 + measureDisplayName: Value + value: 642.82 + - dimension: 1 + dimensionDisplayName: Refund metrics + item: 2 + itemDisplayName: Refund rate + measures: + - index: 2 + measureDisplayName: Percentage + value: 0.41 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-commerce-refunds-report + x-speakeasy-name-override: get-refunds + x-speakeasy-group: sales.reports + description: | + The *Get refunds report* endpoint returns the number and total value of refunds and the refund rate for a specific company's commerce connection over one or more periods of time. + + This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. + + [Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate the refunds metrics. + + #### Response structure + + The Refunds report's dimensions and measures are: + + | Index | Dimensions | + |----------------|----------------| + | `index` = 0 | Period | + | `index` = 1 | Refund metrics | + + | Index | Measures | + |----------------|------------| + | `index` = 0 | Count | + | `index` = 1 | Value | + | `index` = 2 | Percentage | + + The report data then combines multiple reporting dimensions and measures and outputs the value of each combination. + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/periodLength' + - $ref: '#/components/parameters/numberOfPeriodsRequired' + - $ref: '#/components/parameters/periodUnit' + - $ref: '#/components/parameters/includeDisplayNames' + '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/customerRetention': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get customer retention metrics + tags: + - Sales + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceReport' + example: + - reportInfo: + name: customer_retention + displayName: Customer Retention + dimensions: + - index: 0 + displayName: Period + type: datespan + items: + - index: 0 + displayName: Period 0 + start: '2022-01-01' + end: '2022-12-31' + - index: 1 + displayName: Customer retention metrics + type: string + items: + - index: 0 + value: Existing customers + - index: 1 + value: New customers + - index: 2 + value: Total customers + - index: 3 + value: Retention rate + - index: 4 + value: Repeat rate + measures: + - displayName: Count + index: 0 + type: int + - displayName: Percentage + index: 1 + type: percentage + reportData: + - dimension: 0 + dimensionDisplayName: Period + item: 0 + itemDisplayName: Period 0 + components: + - dimension: 1 + dimensionDisplayName: Customer retention metrics + item: 0 + itemDisplayName: Existing customers + measures: + - index: 0 + measureDisplayName: Count + value: 13 + - dimension: 1 + dimensionDisplayName: Customer retention metrics + item: 1 + itemDisplayName: New customers + measures: + - index: 0 + measureDisplayName: Count + value: 47 + - dimension: 1 + dimensionDisplayName: Customer retention metrics + item: 2 + itemDisplayName: Total customers + measures: + - index: 0 + measureDisplayName: Count + value: 60 + - dimension: 1 + dimensionDisplayName: Customer retention metrics + item: 3 + itemDisplayName: Retention rate + measures: + - index: 1 + measureDisplayName: Percentage + value: 0 + - dimension: 1 + dimensionDisplayName: Customer retention metrics + item: 4 + itemDisplayName: Repeat rate + measures: + - index: 1 + measureDisplayName: Percentage + value: 21.67 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-commerce-customer-retention-metrics + x-speakeasy-name-override: get-customer-retention + x-speakeasy-group: sales.metrics + description: |- + The *Get customer retention metrics* endpoint returns customer retention insights for a specific company's commerce connection over one or more periods of time. + + This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. + + #### Customer retention metrics + + - __Existing customers__: the number of unique customers that have placed an order(s) in the specified period and any previous period. + - __New customers__: the number of unique customers that have placed an order(s) in the specified period and none in any previous period. + - __Total customers__: the total number of existing and new customers within the specified period. + - __Retention rate__: the ratio of existing customers within the specified period compared to the total customers at the end of the previous period represented as a percentage. + - __Repeat rate__: the ratio of existing customers to total customers over the specified period represented as a percentage. + + [Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate customer retention metrics. + + #### Response structure + + The Customer retention report's dimensions and measures are: + + | Index | Dimensions | + |-----------------------------|----------------------------| + | `index` = 0 | Period | + | `index` = 1 | Customer retention metrics | + + | Index | Measures | + |----------------------|------------| + | `index` = 0 | Count | + | `index` = 1 | Percentage | + + The report data then combines multiple reporting dimensions and measures and outputs the value of each combination. + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/periodLength' + - $ref: '#/components/parameters/numberOfPeriodsRequired' + - $ref: '#/components/parameters/periodUnit' + - $ref: '#/components/parameters/includeDisplayNames' + '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/lifetimeValue': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get lifetime value metrics + tags: + - Sales + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceReport' + example: + - reportInfo: + name: lifetime_value + displayName: Lifetime Value + dimensions: + - index: 0 + displayName: Period + type: datespan + items: + - index: 0 + displayName: Period 0 + start: '2022-01-01' + end: '2022-12-31' + - index: 1 + displayName: Lifetime value metrics + type: string + items: + - index: 0 + value: Lifetime value + measures: + - displayName: Value + units: GBP + index: 0 + type: currency + reportData: + - dimension: 0 + dimensionDisplayName: Period + item: 0 + itemDisplayName: Period 0 + components: + - dimension: 1 + dimensionDisplayName: Lifetime value metrics + item: 0 + itemDisplayName: Lifetime value + measures: + - index: 0 + measureDisplayName: Value + value: 3782.07 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-commerce-lifetime-value-metrics + x-speakeasy-name-override: get-lifetime-value + x-speakeasy-group: sales.metrics + description: | + The *Get lifetime value metrics* endpoint returns the average revenue that a specific company will generate throughout its lifespan over one or more periods of time. + + This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. + + [Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate the lifetime value metrics. + + #### Response structure + + The Lifetime value report's dimensions and measures are: + + | Index | Dimensions | + |---------------|------------------------| + | `index` = 0 | Period | + | `index` = 1 | Lifetime value metrics | + + | Index | Measures | + |-------------------|---------| + | `index` = 1 | Value | + + The report data then combines multiple reporting dimensions and measures and outputs the value of each combination. + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/periodLength' + - $ref: '#/components/parameters/numberOfPeriodsRequired' + - $ref: '#/components/parameters/periodUnit' + - $ref: '#/components/parameters/includeDisplayNames' + '/data/companies/{companyId}/assess/excel': + parameters: + - $ref: '#/components/parameters/companyId' + post: + summary: Generate Excel report + tags: + - Excel reports + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ExcelStatus' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: generate-excel-report + x-speakeasy-name-override: generate + description: |+ + The *Generate Excel report* endpoint requests the production of a downloadable Excel file for a report type specified in the `reportType` query parameter. + + In response, the endpoint returns the [status](https://docs.codat.io/lending-api#/schemas/ExcelStatus) detailing the current state of the report generation request. + + ### Report types + + | reportType | Description | + |--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| + | `audit` | Identifies inaccurate or out-of-date accounts, helping you to make decisions with confidence. || [audit](https://docs.codat.io/lending/excel/audit-report) | Identify inaccurate or out-of-date accounts, helping you to make decisions with confidence. | + | `enhancedCashFlow` | Provides a fully categorized list of bank transactions for a company, allowing lenders to accurately forecast a company's cash flow. | + | `enhancedFinancials` | Supports decision-making using fully categorized financial statements to allow lenders to automate their underwriting processes. | + | `enhancedInvoices` | Helps verify that payments have been made against historic invoices. Great for invoice finance lenders. | + + [Learn more](https://docs.codat.io/lending/features/excel-download-overview#feature-components) about valid Excel report types. + + + parameters: + - $ref: '#/components/parameters/excelReportType' + get: + summary: Get Excel report status + tags: + - Excel reports + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ExcelStatus' + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-excel-report-generation-status + x-speakeasy-name-override: get-status + description: "\uFEFFThe *Get Excel report status* returns the status of the report mostly recently requested for Excel generation. It does not return the status of any historical report requests. \n\nPoll this endpoint to check the progress of the report once you have requested its generation. This will not affect the generation of the report. \n\nWhen the report generation completes successfully, the `inProgress` property will be marked as `false` and the `success` field will be marked as `true`." + parameters: + - $ref: '#/components/parameters/excelReportType' + '/data/companies/{companyId}/assess/excel/download': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: Download Excel report + tags: + - Excel reports + responses: + '200': + description: OK + content: + application/octet-stream: + schema: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: download-excel-report + x-speakeasy-name-override: download + description: "\uFEFFThe *Download Excel report* endpoint downloads the latest successfully generated Excel report of a specified report type for a given company. \n\nThe downloadable Excel file is returned in the response. You can save it to your local machine.\n\nYou can [learn more](https://docs.codat.io/lending/features/excel-download-overview#feature-components) about valid Excel report types." + parameters: + - $ref: '#/components/parameters/excelReportType' + '/companies/{companyId}/connections/{connectionId}/data/accountTransactions': + get: + tags: + - Transactions + summary: List account transactions + description: |- + The *List account transactions* endpoint returns a list of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) for a given company's connection. + + [Account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) represent bank activity within an accounting software. All transactions that go through a bank account are recorded as account transactions. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-account-transactions + x-speakeasy-group: transactions.account-transactions + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAccountTransactions' + examples: + Clear Books: + value: + results: + - id: 062b3a9b-b04f-4d9c-9ebc-81dcb5bbf285 + transactionId: 356deb9f-98e6-4d6f-8db3-b378241895a1 + note: Direct income 38e8c917-0afc-4583-8ffe-1b53ad601197 + bankAccountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + date: '2022-04-19T00:00:00' + status: Unreconciled + currency: GBP + currencyRate: 1 + lines: + - description: Payment for direct income $38e8c917-0afc-4583-8ffe-1b53ad601197 + recordRef: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + dataType: directIncomes + amount: 188.33 + totalAmount: 188.33 + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2022-05-13T01:06:00' + metadata: + isDeleted: false + - id: f2656119-9521-4d51-a24d-003b44c1410b + transactionId: 1fde4f8f-68ca-48fc-8fe7-79ac467d2946 + note: Direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + bankAccountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + date: '2022-04-19T00:00:00' + status: Void + currency: GBP + currencyRate: 1 + lines: + - description: Payment for direct income $c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + recordRef: + id: c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + dataType: directIncomes + amount: 32095.91 + totalAmount: 32095.91 + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2023-02-13T00:34:00' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1745 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/accountTransactions?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/accountTransactions + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/accountTransactions?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: D7B-933784104 + transactionId: D7B-933784104 + bankAccountRef: + id: 20000-933270541 + name: Checking + date: '2022-12-01T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: D7B-933784104 + dataType: directCosts + amount: -1200 + totalAmount: -1200 + modifiedDate: '2023-04-26T09:13:23' + sourceModifiedDate: '2023-12-16T05:04:10' + metadata: + isDeleted: false + - id: DFA-933785132 + transactionId: DFA-933785132 + bankAccountRef: + id: 20000-933270541 + name: Checking + date: '2022-12-05T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: DFA-933785132 + dataType: directCosts + amount: -35 + totalAmount: -35 + modifiedDate: '2023-04-26T09:13:23' + sourceModifiedDate: '2023-12-16T05:04:11' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 652 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/accountTransactions?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/accountTransactions + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/accountTransactions?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '85' + transactionId: '85' + note: Opening Balance from Bank + bankAccountRef: + id: '57' + name: Visa Credit Card + date: '2015-08-12T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - description: Opening Balance from Bank + recordRef: + id: PUR-85 + dataType: directCosts + amount: -3831.8 + totalAmount: -3831.8 + modifiedDate: '2023-04-26T09:37:16' + sourceModifiedDate: '2016-09-12T18:13:07Z' + metadata: + isDeleted: false + - id: '5' + transactionId: '5' + bankAccountRef: + id: '81' + name: Current + date: '2015-11-24T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - description: contribution to start business + recordRef: + id: 5-1 + dataType: directIncomes + amount: 10000 + - description: funds borrowed to start business + recordRef: + id: 5-2 + dataType: directIncomes + amount: 25000 + totalAmount: 35000 + modifiedDate: '2023-04-26T09:37:17' + sourceModifiedDate: '2016-09-12T15:26:26Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 9141 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/accountTransactions?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/accountTransactions + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/accountTransactions?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '1' + transactionId: '1' + note: Opening Balance from Bank + bankAccountRef: + id: '61' + name: Dave PP Current + date: '2018-09-21T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: '1' + dataType: directIncomes + amount: 170.23 + totalAmount: 170.23 + modifiedDate: '2023-01-18T11:03:12' + sourceModifiedDate: '2018-12-17T14:56:20Z' + - id: '15' + transactionId: '15' + note: Payment to Google + bankAccountRef: + id: '61' + name: Dave PP Current + date: '2018-09-21T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - description: Payment to Google + recordRef: + id: PUR-15 + dataType: directCosts + amount: -1.59 + totalAmount: -1.59 + modifiedDate: '2023-01-18T11:03:11' + sourceModifiedDate: '2018-12-17T14:56:44Z' + pageNumber: 1 + pageSize: 2 + totalResults: 5984 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/accountTransactions?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/accountTransactions + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/accountTransactions?page=2&pageSize=2 + Xero: + value: + results: + - id: 74004690-82a1-4810-aaca-6ce575af94b4 + transactionId: 74004690-82a1-4810-aaca-6ce575af94b4 + bankAccountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + date: '2021-12-20T00:00:00' + status: Reconciled + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + dataType: billPayments + amount: -7267.2 + totalAmount: -7267.2 + modifiedDate: '2023-03-15T20:37:10' + sourceModifiedDate: '2021-01-02T22:51:40' + metadata: + isDeleted: false + - id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + transactionId: 65b746c8-9a5d-4a95-8096-d2316fcff592 + bankAccountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + date: '2022-02-17T00:00:00' + status: Reconciled + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + dataType: payments + amount: 4200 + totalAmount: 4200 + modifiedDate: '2023-03-15T20:37:10' + sourceModifiedDate: '2021-01-02T22:50:58' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 70 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/accountTransactions?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/accountTransactions + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/accountTransactions?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/accountTransactions/{accountTransactionId}': + get: + tags: + - Transactions + summary: Get account transaction + operationId: get-accounting-account-transaction + x-speakeasy-group: transactions.account-transactions + description: | + The *Get account transaction* endpoint returns a single account transaction for a given accountTransactionId. + + [Account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) represent bank activity within an accounting software. All transactions that go through a bank account are recorded as account transactions. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: accountTransactionId + in: path + required: true + schema: + type: string + description: Unique identifier for an account transaction. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAccountTransaction' + examples: + Clear Books: + value: + id: 062b3a9b-b04f-4d9c-9ebc-81dcb5bbf285 + transactionId: 356deb9f-98e6-4d6f-8db3-b378241895a1 + note: Direct income 38e8c917-0afc-4583-8ffe-1b53ad601197 + bankAccountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + date: '2022-04-19T00:00:00' + status: Unreconciled + currency: GBP + currencyRate: 1 + lines: + - description: Payment for direct income $38e8c917-0afc-4583-8ffe-1b53ad601197 + recordRef: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + dataType: directIncomes + amount: 188.33 + totalAmount: 188.33 + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2022-05-13T01:06:00' + metadata: + isDeleted: false + QuickBooks Desktop: + value: + id: D7B-933784104 + transactionId: D7B-933784104 + bankAccountRef: + id: 20000-933270541 + name: Checking + date: '2022-12-01T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: D7B-933784104 + dataType: directCosts + amount: -1200 + totalAmount: -1200 + modifiedDate: '2023-04-26T09:13:23' + sourceModifiedDate: '2023-12-16T05:04:10' + metadata: + isDeleted: false + QuickBooks Online Sandbox: + value: + id: '85' + transactionId: '85' + note: Opening Balance from Bank + bankAccountRef: + id: '57' + name: Visa Credit Card + date: '2015-08-12T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - description: Opening Balance from Bank + recordRef: + id: PUR-85 + dataType: directCosts + amount: -3831.8 + totalAmount: -3831.8 + modifiedDate: '2023-04-26T09:37:16' + sourceModifiedDate: '2016-09-12T18:13:07Z' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '1' + transactionId: '1' + note: Opening Balance from Bank + bankAccountRef: + id: '61' + name: Dave PP Current + date: '2018-09-21T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: '1' + dataType: directIncomes + amount: 170.23 + totalAmount: 170.23 + modifiedDate: '2023-01-18T11:03:12' + sourceModifiedDate: '2018-12-17T14:56:20Z' + Xero: + value: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + transactionId: 74004690-82a1-4810-aaca-6ce575af94b4 + bankAccountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + date: '2021-12-20T00:00:00' + status: Reconciled + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + dataType: billPayments + amount: -7267.2 + totalAmount: -7267.2 + modifiedDate: '2023-03-15T20:37:10' + sourceModifiedDate: '2021-01-02T22:51:40' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/accounts': + get: + tags: + - Financial statements + summary: List accounts + description: "\uFEFFThe *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/lending-api#/schemas/Account) for a given company's connection.\n\n[Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data)." + operationId: list-accounting-accounts + x-speakeasy-group: financial-statements.accounts + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + x-speakeasy-usage-example: true + schema: + $ref: '#/components/schemas/AccountingAccounts' + examples: + Clear Books: + value: + results: + - id: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + nominalCode: '610' + name: Accounts Receivable + description: Invoices the business has issued but has not yet collected payment on. + fullyQualifiedCategory: Asset.Current + fullyQualifiedName: Asset.Current.Accounts Receivable + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T12:38:15Z' + sourceModifiedDate: '2022-12-10T16:39:00' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: 76d5f23b-9623-4e3b-89cd-da57228764d3 + nominalCode: '611' + name: Accounts Receivable + description: A provision anticipating that a portion of accounts receivable will never be collected. + fullyQualifiedCategory: Asset.Current + fullyQualifiedName: Asset.Current.Accounts Receivable + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T12:38:15Z' + sourceModifiedDate: '2022-10-19T05:49:00' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 98 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/accounts?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/accounts + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/accounts?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 8eaed16d-c69f-ec11-80f1-0022481b4546 + nominalCode: 45422026-68CA-4EF2-9 + name: '' + fullyQualifiedCategory: ' .' + fullyQualifiedName: .. + currency: GBP + currentBalance: 0 + type: Unknown + status: Active + isBankAccount: false + modifiedDate: '2023-03-27T14:21:18Z' + sourceModifiedDate: '2022-03-09T16:31:54Z' + validDatatypeLinks: + - property: Id + links: + - DirectCost.LineItems.AccountRef.Id + metadata: + isDeleted: false + - id: c0861a65-c69f-ec11-80f1-0022481b4546 + nominalCode: '10' + name: Account no cat Balance Sheet + fullyQualifiedCategory: ' .' + fullyQualifiedName: ..Account no cat Balance Sheet + currency: GBP + currentBalance: 27.34 + type: Unknown + status: Active + isBankAccount: false + modifiedDate: '2023-03-27T14:21:18Z' + sourceModifiedDate: '2022-09-13T14:45:01Z' + validDatatypeLinks: + - property: Id + links: + - DirectCost.LineItems.AccountRef.Id + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 122 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/accounts?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/accounts + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/accounts?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: ef2fde36-4416-4bc5-b239-315b2929348c + nominalCode: '1300' + name: Debiteuren + description: Debiteuren + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.Debiteuren.PaymentsEnabled + currency: EUR + currentBalance: 864435.44 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:36:17Z' + sourceModifiedDate: '2020-01-08T09:42:54Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - id: 2052b65b-20e9-4da1-85d8-fd5ca0ea3d38 + nominalCode: '888777888' + name: One more AR account + description: One more AR account + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.One more AR account.PaymentsEnabled + currency: EUR + currentBalance: 2174.82 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:36:17Z' + sourceModifiedDate: '2021-06-10T11:00:20Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + pageNumber: 1 + pageSize: 2 + totalResults: 230 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/accounts?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/accounts + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/accounts?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: ca2b96b7-cc45-4e35-9fa3-82a2ba1eec40 + nominalCode: THING + name: Some thing account + description: Some thing account + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.Some thing account.PaymentsEnabled + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:35:15Z' + sourceModifiedDate: '2017-08-01T17:31:12Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - id: cf9572e7-8afa-4339-9113-af32a66d9df9 + nominalCode: '15400' + name: Trade Debtors + description: Trade Debtors + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.Trade Debtors.PaymentsEnabled + currency: GBP + currentBalance: 4484655.39 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:35:15Z' + sourceModifiedDate: '2020-01-08T13:48:38Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + pageNumber: 1 + pageSize: 2 + totalResults: 121 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/accounts?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/accounts + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/accounts?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '601' + nominalCode: '601' + name: Capital Asset Brought Forward + fullyQualifiedCategory: Asset.Capital + fullyQualifiedName: Asset.Capital.Capital Asset Brought Forward + currency: GBP + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-25T14:19:12Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: '605' + nominalCode: '605' + name: Capital Asset Depreciation Brought Forward + fullyQualifiedCategory: Asset.Capital + fullyQualifiedName: Asset.Capital.Capital Asset Depreciation Brought Forward + currency: GBP + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-25T14:19:12Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 292 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/accounts?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/accounts + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/accounts?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '67357' + nominalCode: '1200' + name: Accounts Receivable + fullyQualifiedCategory: Asset + fullyQualifiedName: Asset.Accounts Receivable + currency: GBP + currentBalance: 51445.53 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-24T16:07:24Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: '128611' + nominalCode: 1200-1 + name: Accounts Receivable + fullyQualifiedCategory: Asset.Accounts Receivable + fullyQualifiedName: Asset.Accounts Receivable.Accounts Receivable + currency: GBP + currentBalance: 51445.53 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-24T16:07:24Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 96 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/accounts?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/accounts + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/accounts?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '27840056' + nominalCode: '70700' + name: 16th Account + fullyQualifiedCategory: Asset.BankAccount + fullyQualifiedName: Asset.BankAccount.16th Account + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-09-30T10:29:16Z' + validDatatypeLinks: [] + - id: '27840049' + nominalCode: '70600' + name: 1a1a + fullyQualifiedCategory: Asset.BankAccount + fullyQualifiedName: Asset.BankAccount.1a1a + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-09-30T10:29:16Z' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 157 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/accounts?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/accounts + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/accounts?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '111' + name: Accounts Payable + fullyQualifiedCategory: AcctPay.AcctPay + fullyQualifiedName: AcctPay.AcctPay.Accounts Payable + currentBalance: -635.55 + type: Liability + status: Active + isBankAccount: false + modifiedDate: '2023-01-30T14:48:33Z' + sourceModifiedDate: '2021-08-11T12:51:21' + validDatatypeLinks: [] + - id: '119' + name: Accounts Receivable + fullyQualifiedCategory: AcctRec.AcctRec + fullyQualifiedName: AcctRec.AcctRec.Accounts Receivable + currentBalance: -565 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-01-30T14:48:33Z' + sourceModifiedDate: '2021-09-08T15:23:31' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 44 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/accounts?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/accounts + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/accounts?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 40000-933270541 + nominalCode: '11000' + name: Accounts Receivable + description: Accounts Receivable + fullyQualifiedCategory: Asset.CurrentAsset.AccountsReceivable + fullyQualifiedName: Asset.CurrentAsset.AccountsReceivable.Accounts Receivable + currency: GBP + currentBalance: 93007.93 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T09:06:23Z' + sourceModifiedDate: '2023-12-16T05:06:45' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: 20000-933270541 + nominalCode: '10100' + name: Checking + description: Cash + fullyQualifiedCategory: Asset.CurrentAsset.Bank + fullyQualifiedName: Asset.CurrentAsset.Bank.Checking + currency: GBP + currentBalance: 46954.1 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2023-04-26T09:06:23Z' + sourceModifiedDate: '2023-12-16T05:06:45' + validDatatypeLinks: + - property: Id + links: + - BillLineItem.AccountRef.Id + - BillPayment.AccountRef.Id + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 116 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/accounts?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/accounts + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/accounts?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '62' + nominalCode: '246' + name: Debtors + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors + currency: GBP + currentBalance: 41289.37 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-01-18T11:02:34Z' + sourceModifiedDate: '2022-12-08T15:42:59Z' + validDatatypeLinks: [] + - id: '92' + nominalCode: '247' + name: Debtors - AED + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors - AED + currency: AED + currentBalance: -1533.44 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-01-18T11:02:34Z' + sourceModifiedDate: '2021-02-19T14:04:45Z' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 234 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/accounts?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/accounts + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/accounts?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '70' + name: Debtors + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors + currency: GBP + currentBalance: 3041173.77 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-26T01:18:15Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: '80' + name: Debtors - USD + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors - USD + currency: USD + currentBalance: 54822.37 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-12T15:10:38Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 186 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/accounts?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/accounts + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/accounts?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '2864' + nominalCode: '1200' + name: Bank Account + description: Bank Account + fullyQualifiedCategory: Asset.Bank Account + fullyQualifiedName: Asset.Bank Account.Bank Account + type: Asset + status: Archived + isBankAccount: false + modifiedDate: '2022-10-14T09:35:52Z' + validDatatypeLinks: [] + metadata: + isDeleted: true + - id: '2368' + nominalCode: '1200' + name: Bank Current Account + description: Bank Current Account + fullyQualifiedCategory: Asset.Bank Account + fullyQualifiedName: Asset.Bank Account.Bank Current Account + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-10-14T09:35:52Z' + sourceModifiedDate: '2020-09-11T13:53:12Z' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 344 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/accounts?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/accounts + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/accounts?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '1100' + nominalCode: '1100' + name: Debtors Control Account + fullyQualifiedCategory: Asset.CurrentAssets.Debtors + fullyQualifiedName: Asset.CurrentAssets.Debtors.Debtors Control Account + currency: GBP + currentBalance: 90640.61 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: '1102' + nominalCode: '1102' + name: Other Debtors + fullyQualifiedCategory: Asset.CurrentAssets.Debtors + fullyQualifiedName: Asset.CurrentAssets.Debtors.Other Debtors + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 155 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/accounts?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/accounts + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/accounts?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: e5889b459f544926ac5b8e6756df2ad4 + nominalCode: '1560' + name: Abdi Internet Bank + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Abdi Internet Bank + currency: GBP + currentBalance: 49.61 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-27T10:53:26Z' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - id: b17083bc9b2748b4ab321b024e260eda + nominalCode: '147852' + name: Abdi Live Test + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Abdi Live Test + currency: GBP + currentBalance: 225830.75 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-28T14:00:20Z' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + pageNumber: 1 + pageSize: 2 + totalResults: 283 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/accounts?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/accounts + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/accounts?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '2' + nominalCode: '12100' + name: Accounts Receivable + fullyQualifiedCategory: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable' + fullyQualifiedName: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable.Accounts Receivable' + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-04T16:31:51Z' + sourceModifiedDate: '2020-01-29T01:42:43' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: '155' + nominalCode: '12710' + name: AR - Retainage + fullyQualifiedCategory: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable' + fullyQualifiedName: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable.AR - Retainage' + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-04T16:31:51Z' + sourceModifiedDate: '2020-10-15T15:33:15' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 181 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/accounts?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/accounts + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/accounts?page=2&pageSize=2 + Wave: + value: + results: + - id: QWNjb3VudDo5MjIzNDE3NjkzMzk3NjA2MzM7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Abdi Bank + description: Test Balance Sheet + fullyQualifiedCategory: Asset.CashAndBank + fullyQualifiedName: Asset.CashAndBank.Abdi Bank + currency: GBP + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-11-16T18:15:17Z' + validDatatypeLinks: [] + - id: QWNjb3VudDo3OTE3NTA1OTcwOTQxNzQ3MTU7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Cash on Hand + description: Cash you haven�t deposited in the bank. Add your bank and credit card accounts to accurately categorize transactions that aren't cash. + fullyQualifiedCategory: Asset.CashAndBank + fullyQualifiedName: Asset.CashAndBank.Cash on Hand + currency: GBP + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-11-16T18:15:17Z' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 85 + _links: + current: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/accounts?page=1&pageSize=2 + self: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/accounts + next: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/accounts?page=2&pageSize=2 + Xero: + value: + results: + - id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + nominalCode: A090 + name: Business Bank Account + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Business Bank Account + currency: GBP + currentBalance: 924.25 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2023-03-15T20:35:08Z' + sourceModifiedDate: '2023-02-17T11:10:49' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - DirectIncome.LineItems.AccountRef.Id + - DirectCost.LineItems.AccountRef.Id + metadata: + isDeleted: false + - id: a8d6fb1a-8c5d-4683-90ce-bf9d28fc62ba + nominalCode: A091 + name: Business Savings Account + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Business Savings Account + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2023-03-15T20:35:08Z' + sourceModifiedDate: '2023-02-17T11:10:49' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - DirectIncome.LineItems.AccountRef.Id + - DirectCost.LineItems.AccountRef.Id + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 90 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/accounts?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/accounts + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/accounts?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000000352' + nominalCode: '' + name: Accounts Receivable + description: The money that customers owe you becomes the accounts receivable. A good example of this is a payment expected from an invoice sent to your customer. + fullyQualifiedCategory: Asset.accounts_receivable + fullyQualifiedName: Asset.accounts_receivable.Accounts Receivable + currency: GBP + currentBalance: -959.64 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-02-05T14:58:44' + validDatatypeLinks: [] + - id: '104957000000060010' + nominalCode: '' + name: Abdi Test + description: '' + fullyQualifiedCategory: Asset.bank + fullyQualifiedName: Asset.bank.Abdi Test + currency: GBP + currentBalance: 69858.44 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-02-17T12:19:47' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 68 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/accounts?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/accounts + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/accounts?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/accounts/{accountId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/accountingAccountId' + get: + tags: + - Financial statements + summary: Get account + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAccount' + examples: + Clear Books: + value: + id: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + nominalCode: '610' + name: Accounts Receivable + description: Invoices the business has issued but has not yet collected payment on. + fullyQualifiedCategory: Asset.Current + fullyQualifiedName: Asset.Current.Accounts Receivable + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T12:38:15Z' + sourceModifiedDate: '2022-12-10T16:39:00' + validDatatypeLinks: [] + Dynamics 365 Business Central: + value: + id: 8eaed16d-c69f-ec11-80f1-0022481b4546 + nominalCode: 45422026-68CA-4EF2-9 + name: '' + fullyQualifiedCategory: ' .' + fullyQualifiedName: .. + currency: GBP + currentBalance: 0 + type: Unknown + status: Active + isBankAccount: false + modifiedDate: '2023-03-27T14:21:18Z' + sourceModifiedDate: '2022-03-09T16:31:54Z' + validDatatypeLinks: + - property: Id + links: + - DirectCost.LineItems.AccountRef.Id + Exact (Netherlands): + value: + id: ef2fde36-4416-4bc5-b239-315b2929348c + nominalCode: '1300' + name: Debiteuren + description: Debiteuren + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.Debiteuren.PaymentsEnabled + currency: EUR + currentBalance: 864435.44 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:36:17Z' + sourceModifiedDate: '2020-01-08T09:42:54Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + Exact (UK): + value: + id: ca2b96b7-cc45-4e35-9fa3-82a2ba1eec40 + nominalCode: THING + name: Some thing account + description: Some thing account + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.Some thing account.PaymentsEnabled + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:35:15Z' + sourceModifiedDate: '2017-08-01T17:31:12Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + FreeAgent: + value: + id: '601' + nominalCode: '601' + name: Capital Asset Brought Forward + fullyQualifiedCategory: Asset.Capital + fullyQualifiedName: Asset.Capital.Capital Asset Brought Forward + currency: GBP + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-25T14:19:12Z' + validDatatypeLinks: [] + FreshBooks: + value: + id: '67357' + nominalCode: '1200' + name: Accounts Receivable + fullyQualifiedCategory: Asset + fullyQualifiedName: Asset.Accounts Receivable + currency: GBP + currentBalance: 51445.53 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-24T16:07:24Z' + validDatatypeLinks: [] + KashFlow: + value: + id: '27840056' + nominalCode: '70700' + name: 16th Account + fullyQualifiedCategory: Asset.BankAccount + fullyQualifiedName: Asset.BankAccount.16th Account + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-09-30T10:29:16Z' + validDatatypeLinks: [] + Oracle NetSuite: + value: + id: '111' + name: Accounts Payable + fullyQualifiedCategory: AcctPay.AcctPay + fullyQualifiedName: AcctPay.AcctPay.Accounts Payable + currentBalance: -635.55 + type: Liability + status: Active + isBankAccount: false + modifiedDate: '2023-01-30T14:48:33Z' + sourceModifiedDate: '2021-08-11T12:51:21' + validDatatypeLinks: [] + QuickBooks Desktop: + value: + id: 40000-933270541 + nominalCode: '11000' + name: Accounts Receivable + description: Accounts Receivable + fullyQualifiedCategory: Asset.CurrentAsset.AccountsReceivable + fullyQualifiedName: Asset.CurrentAsset.AccountsReceivable.Accounts Receivable + currency: GBP + currentBalance: 93007.93 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T09:06:23Z' + sourceModifiedDate: '2023-12-16T05:06:45' + validDatatypeLinks: [] + QuickBooks Online: + value: + id: '62' + nominalCode: '246' + name: Debtors + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors + currency: GBP + currentBalance: 41289.37 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-01-18T11:02:34Z' + sourceModifiedDate: '2022-12-08T15:42:59Z' + validDatatypeLinks: [] + QuickBooks Online Sandbox: + value: + id: '70' + name: Debtors + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors + currency: GBP + currentBalance: 3041173.77 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-26T01:18:15Z' + validDatatypeLinks: [] + Sage 200cloud: + value: + id: '2864' + nominalCode: '1200' + name: Bank Account + description: Bank Account + fullyQualifiedCategory: Asset.Bank Account + fullyQualifiedName: Asset.Bank Account.Bank Account + type: Asset + status: Archived + isBankAccount: false + modifiedDate: '2022-10-14T09:35:52Z' + validDatatypeLinks: [] + Sage 50 (UK): + value: + id: '1100' + nominalCode: '1100' + name: Debtors Control Account + fullyQualifiedCategory: Asset.CurrentAssets.Debtors + fullyQualifiedName: Asset.CurrentAssets.Debtors.Debtors Control Account + currency: GBP + currentBalance: 90640.61 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + validDatatypeLinks: [] + Sage Business Cloud Accounting: + value: + id: e5889b459f544926ac5b8e6756df2ad4 + nominalCode: '1560' + name: Abdi Internet Bank + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Abdi Internet Bank + currency: GBP + currentBalance: 49.61 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-27T10:53:26Z' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + Sage Intacct: + value: + id: '2' + nominalCode: '12100' + name: Accounts Receivable + fullyQualifiedCategory: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable' + fullyQualifiedName: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable.Accounts Receivable' + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-04T16:31:51Z' + sourceModifiedDate: '2020-01-29T01:42:43' + validDatatypeLinks: [] + Wave: + value: + id: QWNjb3VudDo5MjIzNDE3NjkzMzk3NjA2MzM7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Abdi Bank + description: Test Balance Sheet + fullyQualifiedCategory: Asset.CashAndBank + fullyQualifiedName: Asset.CashAndBank.Abdi Bank + currency: GBP + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-11-16T18:15:17Z' + validDatatypeLinks: [] + Xero: + value: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + nominalCode: A090 + name: Business Bank Account + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Business Bank Account + currency: GBP + currentBalance: 924.25 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2023-03-15T20:35:08Z' + sourceModifiedDate: '2023-02-17T11:10:49' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - DirectIncome.LineItems.AccountRef.Id + - DirectCost.LineItems.AccountRef.Id + Zoho Books: + value: + id: '104957000000000352' + nominalCode: '' + name: Accounts Receivable + description: The money that customers owe you becomes the accounts receivable. A good example of this is a payment expected from an invoice sent to your customer. + fullyQualifiedCategory: Asset.accounts_receivable + fullyQualifiedName: Asset.accounts_receivable.Accounts Receivable + currency: GBP + currentBalance: -959.64 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-02-05T14:58:44' + validDatatypeLinks: [] + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get account* endpoint returns a single account for a given accountId. + + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-account + x-speakeasy-group: financial-statements.accounts + '/companies/{companyId}/data/billCreditNotes': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + summary: List bill credit notes + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBillCreditNotes' + examples: + Dynamics 365 Business Central: + value: + results: + - id: 0deaed0a-9f51-eb11-89f9-00224800af18 + billCreditNoteNumber: '109001' + supplierRef: + id: be1217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: 'Fabrikam, Inc.' + withholdingTax: [] + totalAmount: 8 + totalDiscount: 0 + subTotal: 8 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 8 + status: Submitted + issueDate: '2020-12-21T00:00:00' + currency: GBP + lineItems: + - description: Abdi Item No VAT + unitAmount: 8 + quantity: 1 + discountAmount: 0 + subTotal: 8 + taxAmount: 0 + totalAmount: 8 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + discountPercentage: 0 + taxRateRef: + id: 6bbc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for EXPORT / ZERO + effectiveTaxRate: 0 + itemRef: + id: ITEM-dbc37b18-4209-eb11-bbf6-0022481ad2e8-EXPORT-EXPORT + name: 'Abdi Item No VAT / General Business Posting Group: ''EXPORT'' / VAT Business Posting Group: ''EXPORT''' + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2023-03-27T14:21:26Z' + metadata: + isDeleted: false + note: BCN001 + - id: 157c025f-a19e-eb11-8ce6-0022481a7bed + billCreditNoteNumber: '109002' + supplierRef: + id: be1217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: 'Fabrikam, Inc.' + withholdingTax: [] + totalAmount: 20 + totalDiscount: 0 + subTotal: 20 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 10 + status: PartiallyPaid + issueDate: '2021-01-26T00:00:00' + currency: GBP + lineItems: + - description: Abdi Item No VAT + unitAmount: 20 + quantity: 1 + discountAmount: 0 + subTotal: 20 + taxAmount: 0 + totalAmount: 20 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + discountPercentage: 0 + taxRateRef: + id: 6bbc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for EXPORT / ZERO + effectiveTaxRate: 0 + itemRef: + id: ITEM-dbc37b18-4209-eb11-bbf6-0022481ad2e8-EXPORT-EXPORT + name: 'Abdi Item No VAT / General Business Posting Group: ''EXPORT'' / VAT Business Posting Group: ''EXPORT''' + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 257c025f-a19e-eb11-8ce6-0022481a7bed + note: Credit Memo 1002 + reference: '109002' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-26T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-04-16T00:00:00' + totalAmount: 10 + modifiedDate: '2023-03-27T14:21:26Z' + metadata: + isDeleted: false + note: '16042021' + pageNumber: 1 + pageSize: 2 + totalResults: 224 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billCreditNotes + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billCreditNotes?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 443bd109-e1ed-4de2-b1ab-3b13e980d288 + billCreditNoteNumber: '19600007' + supplierRef: + id: 5e6f49b9-6489-4b82-83e7-291d308919bb + supplierName: Mickey Mouse + withholdingTax: [] + totalAmount: 12.1 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 2.1 + discountPercentage: 0 + remainingCredit: 12.1 + status: Submitted + issueDate: '2019-12-16T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Cheesecake + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + accountRef: + id: 5f139759-b554-4314-862e-b9d88e5b2e1b + name: Af te dragen loonheffing + taxRateRef: + id: 84277189-ad16-456c-b501-ca31f0a483cc + name: BTW prive gebruik + effectiveTaxRate: 21 + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-03T15:06:19Z' + - id: 6643f559-d7e9-4cfe-802f-60beddbc4ed9 + billCreditNoteNumber: '20600003' + supplierRef: + id: f87070e2-bbd7-4383-a7c9-824748c1d70e + supplierName: Exact Software Nederland B.V. + withholdingTax: [] + totalAmount: 13.57 + totalDiscount: 0 + subTotal: 13.57 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 13.57 + status: Submitted + issueDate: '2020-01-20T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: 1 transactions of type CARD_PAYMENT_FEE_REFUND + unitAmount: 13.57 + quantity: 1 + discountAmount: 0 + subTotal: 13.57 + totalAmount: 13.57 + accountRef: + id: f6c251f5-21d0-4164-9b8f-17789fd2fee9 + name: Kosten werkgeverslasten vakantiegeld + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-20T19:38:37Z' + pageNumber: 1 + pageSize: 2 + totalResults: 42 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billCreditNotes + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billCreditNotes?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: f9083d38-40c7-4b5f-a693-f4670e3d85bc + billCreditNoteNumber: '19600008' + supplierRef: + id: 1c703cce-967c-4476-a86a-32e35341a8f5 + supplierName: Customer Bill Supplier + withholdingTax: [] + totalAmount: 99999 + totalDiscount: 0 + subTotal: 99999 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 99999 + status: Submitted + issueDate: '2019-10-30T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Oil Change + unitAmount: -150 + quantity: 1000.5 + discountAmount: 0 + subTotal: -150075 + totalAmount: -150075 + accountRef: + id: 885ff551-664d-451b-995b-cb114c9877d0 + name: Unallocated Cash + itemRef: + id: '3001' + trackingCategoryRefs: [] + - description: description + unitAmount: 250074 + quantity: 1 + discountAmount: 0 + subTotal: 250074 + totalAmount: 250074 + accountRef: + id: 885ff551-664d-451b-995b-cb114c9877d0 + name: Unallocated Cash + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:33:23Z' + sourceModifiedDate: '2019-10-30T13:12:56Z' + - id: 05023688-5bd5-4034-ae4c-5e3e5099bbfb + billCreditNoteNumber: '19600009' + supplierRef: + id: 1c703cce-967c-4476-a86a-32e35341a8f5 + supplierName: Customer Bill Supplier + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 10 + status: Submitted + issueDate: '2019-11-01T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Credit note line item #5' + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + totalAmount: 10 + accountRef: + id: 62be6536-f4ea-49b8-9797-1adc23982334 + name: Depreciation + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:33:23Z' + sourceModifiedDate: '2019-11-01T15:07:18Z' + pageNumber: 1 + pageSize: 2 + totalResults: 40 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billCreditNotes + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billCreditNotes?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '10665024' + billCreditNoteNumber: Bill Credit + supplierRef: + id: '6161941' + supplierName: A & J Fabtech Ltd + withholdingTax: [] + totalAmount: 1500 + totalDiscount: 0 + subTotal: 1250 + totalTaxAmount: 250 + discountPercentage: 0 + remainingCredit: 1500 + status: Submitted + issueDate: '2018-08-22T00:00:00' + currency: GBP + lineItems: + - description: A & J Fabtech Ltd - Bill Credit Note Bill Credit + unitAmount: 1250 + quantity: 1 + taxAmount: 250 + totalAmount: 1500 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2018-08-22T13:22:08Z' + metadata: + isDeleted: false + - id: '11007024' + billCreditNoteNumber: Draft test + supplierRef: + id: '6161963' + supplierName: ABB Ltd + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 8.33 + totalTaxAmount: 1.67 + discountPercentage: 0 + remainingCredit: 10 + status: Submitted + issueDate: '2018-10-17T00:00:00' + currency: GBP + lineItems: + - description: ABB Ltd - Bill Credit Note Draft test + unitAmount: 8.33 + quantity: 1 + taxAmount: 1.67 + totalAmount: 10 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2018-10-17T12:56:54Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 45 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billCreditNotes + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billCreditNotes?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '91339087' + billCreditNoteNumber: '5' + supplierRef: + id: '6202387' + supplierName: Dell + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2020-02-25T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Oil refund + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: '21481832' + name: Oil + itemRef: + id: '114817740' + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-09-30T10:29:16Z' + - id: '91341939' + billCreditNoteNumber: '6' + supplierRef: + id: '6202387' + supplierName: Dell + withholdingTax: [] + totalAmount: 240 + totalDiscount: 0 + subTotal: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2020-02-25T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: -200 + quantity: -1 + subTotal: 200 + taxAmount: -40 + totalAmount: 240 + accountRef: + id: '21481820' + name: Materials purchased + itemRef: + id: '114821376' + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-09-30T10:29:16Z' + pageNumber: 1 + pageSize: 2 + totalResults: 8 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/billCreditNotes + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/billCreditNotes?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '1781' + billCreditNoteNumber: VENDCRED1 + supplierRef: + id: '749' + supplierName: Jo's Cheese + withholdingTax: [] + totalAmount: 174.6 + totalDiscount: 0 + subTotal: 145.5 + totalTaxAmount: 29.1 + discountPercentage: 0 + remainingCredit: 174.6 + status: Submitted + issueDate: '2021-11-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: billcredit_test + unitAmount: 145.5 + quantity: 1 + unitOfMeasurement: pack + subTotal: 145.5 + totalAmount: 145.5 + accountRef: + id: '713' + name: Inventory Asset + trackingCategoryRefs: + - id: department-1 + - id: location-1 + tracking: + categoryRefs: + - id: department-1 + - id: location-1 + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2022-09-20T08:16:22Z' + sourceModifiedDate: '2021-11-02T19:58:58' + note: Codat1 + - id: '1782' + billCreditNoteNumber: VENDCRED2 + supplierRef: + id: '749' + supplierName: Jo's Cheese + withholdingTax: [] + totalAmount: 642.3 + totalDiscount: 0 + subTotal: 535.25 + totalTaxAmount: 107.05 + discountPercentage: 0 + remainingCredit: 342.3 + status: PartiallyPaid + issueDate: '2021-11-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Cheese + unitAmount: 400 + quantity: 1 + unitOfMeasurement: pack + subTotal: 400 + totalAmount: 400 + accountRef: + id: '714' + name: Cost of Goods Sold + createdFromLineRef: + id: '7462' + dataType: bills + lineNumber: '1' + trackingCategoryRefs: + - id: location-1 + tracking: + categoryRefs: + - id: location-1 + isBilledTo: Unknown + isRebilledTo: Unknown + - description: double cream + unitAmount: 100 + quantity: 1 + subTotal: 100 + totalAmount: 100 + accountRef: + id: '714' + name: Cost of Goods Sold + trackingCategoryRefs: + - id: location-1 + tracking: + categoryRefs: + - id: location-1 + isBilledTo: Unknown + isRebilledTo: Unknown + - description: '' + unitAmount: 35.25 + quantity: 1 + subTotal: 35.25 + totalAmount: 35.25 + accountRef: + id: '54' + name: Sales + itemRef: + id: '128' + name: Test Item + trackingCategoryRefs: + - id: location-1 + tracking: + categoryRefs: + - id: location-1 + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: + - payment: + id: '1782' + note: Codat1 + reference: Bill Credit 02/11/2021 + currency: GBP + currencyRate: 1 + paidOnDate: '2021-11-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 300 + createdFromRefs: + - id: '7462' + dataType: bills + modifiedDate: '2022-09-20T08:16:22Z' + sourceModifiedDate: '2021-11-03T18:27:14' + note: Codat1 + pageNumber: 1 + pageSize: 2 + totalResults: 16 + _links: + current: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/billCreditNotes + next: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/billCreditNotes?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 6D2C-1197698059 + billCreditNoteNumber: Return + supplierRef: + id: E0000-933272656 + supplierName: Timberloft Lumber + withholdingTax: [] + totalAmount: 475 + totalDiscount: 0 + subTotal: 475 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 475 + status: Submitted + issueDate: '2024-10-30T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Lumber:Rough - Rough lumber' + unitAmount: 475 + quantity: 0 + discountAmount: 0 + subTotal: 475 + taxAmount: 0 + totalAmount: 475 + discountPercentage: 0 + itemRef: + id: 1C0000-933272656 + name: 'Lumber:Rough' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: + - payment: + id: 6D2C-1197698059 + reference: Return + currency: GBP + currencyRate: 1 + paidOnDate: '2024-10-30T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 475 + modifiedDate: '2023-04-26T09:12:30Z' + sourceModifiedDate: '2023-12-16T05:06:19' + metadata: + isDeleted: false + - id: F3A-933787869 + billCreditNoteNumber: CR-1098 + supplierRef: + id: 80000-933272656 + supplierName: Sloan Roofing + withholdingTax: [] + totalAmount: 850 + totalDiscount: 0 + subTotal: 850 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 850 + status: Submitted + issueDate: '2024-12-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Subs:Roofing - Roofing' + unitAmount: 850 + quantity: 0 + discountAmount: 0 + subTotal: 850 + taxAmount: 0 + totalAmount: 850 + discountPercentage: 0 + itemRef: + id: D0000-933272656 + name: 'Subs:Roofing' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: + - payment: + id: F3A-933787869 + reference: CR-1098 + currency: GBP + currencyRate: 1 + paidOnDate: '2024-12-12T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 850 + modifiedDate: '2023-04-26T09:12:30Z' + sourceModifiedDate: '2023-12-16T05:05:03' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billCreditNotes + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billCreditNotes?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '19' + billCreditNoteNumber: '19' + supplierRef: + id: '4' + supplierName: BILLy elliot + withholdingTax: [] + totalAmount: 5 + totalDiscount: 0 + subTotal: 5 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: + - payment: + id: '20' + currency: GBP + currencyRate: 1 + paidOnDate: '2019-05-13T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 5 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2019-05-13T13:14:06Z' + - id: '677' + billCreditNoteNumber: '677' + supplierRef: + id: '4' + supplierName: BILLy elliot + withholdingTax: [] + totalAmount: 5 + totalDiscount: 0 + subTotal: 5 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2020-03-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: + - payment: + id: '678' + note: payment note test + currency: GBP + currencyRate: 1 + paidOnDate: '2020-03-23T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 5 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2020-03-23T10:44:06Z' + note: Codat Note field + pageNumber: 1 + pageSize: 2 + totalResults: 11 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billCreditNotes + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billCreditNotes?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '424' + billCreditNoteNumber: '424' + supplierRef: + id: '24' + supplierName: Brijesh Jain + withholdingTax: [] + totalAmount: 69 + totalDiscount: 0 + subTotal: 69 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 69 + status: Submitted + issueDate: '2019-06-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refund of iZettle Fees + unitAmount: 69 + quantity: 1 + subTotal: 69 + taxAmount: 0 + totalAmount: 69 + accountRef: + id: '30' + name: Janitorial Expense + taxRateRef: + id: 20_Bills + name: 5.0% RC CIS Bills + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: [] + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2019-06-20T15:48:50Z' + metadata: + isDeleted: false + - id: '455' + billCreditNoteNumber: '455' + supplierRef: + id: '53' + supplierName: Bank of AnyCity + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-06-26T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: a + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: '11' + name: Ask My Accountant + taxRateRef: + id: 20_Bills + name: 5.0% RC CIS Bills + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: + - payment: + id: '530' + reference: '4' + accountRef: + id: '100' + name: Savings2 + currency: GBP + currencyRate: 1 + paidOnDate: '2019-07-16T00:00:00' + totalAmount: 170 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 10 + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2019-07-16T09:49:14Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 26 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billCreditNotes + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billCreditNotes?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '45391' + billCreditNoteNumber: Return 1 + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + withholdingTax: [] + totalAmount: 120 + totalDiscount: 2.5 + subTotal: 100 + totalTaxAmount: 20 + discountPercentage: 2.5 + remainingCredit: 109.5 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + allocatedOnDate: '2020-01-20T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0.5 + subTotal: 0 + taxAmount: 20 + totalAmount: 20 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 2.5 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '45391' + note: ret1 + reference: Return 1 + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.5 + modifiedDate: '2022-10-14T09:35:52Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: ret1 + - id: '45421' + billCreditNoteNumber: Return 2 + supplierRef: + id: QUA001 + supplierName: Quality Motors + withholdingTax: [] + totalAmount: 60 + totalDiscount: 1.25 + subTotal: 50 + totalTaxAmount: 10 + discountPercentage: 2.5 + remainingCredit: 60 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + allocatedOnDate: '2020-02-03T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0.25 + subTotal: 0 + taxAmount: 10 + totalAmount: 10 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 1.25 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-14T09:35:52Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: ret2 + pageNumber: 1 + pageSize: 2 + totalResults: 21 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billCreditNotes + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billCreditNotes?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '20' + billCreditNoteNumber: O/BAL + supplierRef: + id: NEW001 + supplierName: Newtown Builders Ltd + withholdingTax: [] + totalAmount: 0.01 + totalDiscount: 0 + subTotal: 0.01 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0.01 + status: Submitted + issueDate: '2021-12-31T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Opening Balance + unitAmount: 0.01 + quantity: 1 + subTotal: 0.01 + taxAmount: 0 + totalAmount: 0.01 + accountRef: + id: '9998' + name: Suspense Account + taxRateRef: + id: '9' + name: Non-Vatable Tax Code + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: department_0 + name: Default + tracking: + categoryRefs: + - id: department_0 + name: Default + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + note: Opening Balance + - id: '323' + billCreditNoteNumber: Return + supplierRef: + id: UNI001 + supplierName: Unique Systems + withholdingTax: [] + totalAmount: 103.4 + totalDiscount: 0 + subTotal: 88 + totalTaxAmount: 15.4 + discountPercentage: 0 + remainingCredit: 103.4 + status: Submitted + issueDate: '2022-02-28T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Returned Goods, damaged' + unitAmount: 103.4 + quantity: 1 + subTotal: 88 + taxAmount: 15.4 + totalAmount: 103.4 + accountRef: + id: '5000' + name: Materials Purchased + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_0 + name: Default + tracking: + categoryRefs: + - id: department_0 + name: Default + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + note: 'Returned Goods, damaged' + pageNumber: 1 + pageSize: 2 + totalResults: 12 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billCreditNotes + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billCreditNotes?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: b6c6fce9866849b0b44cac99ab7dc579 + billCreditNoteNumber: Supplier credit note + supplierRef: + id: ec716559789111e8aaa5027d54329956 + supplierName: Bagels Limited + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2018-11-23T00:00:00' + currency: USD + currencyRate: 0.776970973 + lineItems: + - description: Consulting services + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + discountPercentage: 0 + taxRateRef: + id: GB_ZERO + name: Zero Rated 0.00% + effectiveTaxRate: 0 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: bf6496aaf0294883b27c423ce8266113 + note: Supplier refund using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: USD + currencyRate: 0.771449236 + paidOnDate: '2019-11-19T00:00:00' + totalAmount: -10 + allocation: + currency: USD + currencyRate: 1 + totalAmount: 10 + modifiedDate: '2022-10-24T14:53:32Z' + sourceModifiedDate: '2019-11-19T14:17:32Z' + - id: 23d866f6367d4f11956a36a71e47bc37 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + withholdingTax: [] + totalAmount: 60 + totalDiscount: 0 + subTotal: 50 + totalTaxAmount: 10 + discountPercentage: 0 + remainingCredit: 60 + status: Submitted + issueDate: '2019-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 10 + quantity: 5 + discountAmount: 0 + subTotal: 50 + taxAmount: 10 + totalAmount: 60 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-24T14:53:32Z' + sourceModifiedDate: '2020-07-16T15:00:36Z' + pageNumber: 1 + pageSize: 2 + totalResults: 747 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billCreditNotes + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billCreditNotes?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '3359' + billCreditNoteNumber: APADJ0001 + supplierRef: + id: '3' + supplierName: ADP + withholdingTax: [] + totalAmount: 12 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 2 + discountPercentage: 0 + remainingCredit: 12 + status: Submitted + issueDate: '2021-09-20T00:00:00' + currency: USD + currencyRate: 0.7283 + lineItems: + - description: No Description Provided + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 1 + totalAmount: 6 + accountRef: + id: '197' + name: Software and Licenses + taxRateRef: + id: '47' + name: EC Purchase Goods Standard Rate Input + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + tracking: + categoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + isBilledTo: Unknown + isRebilledTo: Unknown + - description: No Description Provided + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 1 + totalAmount: 6 + accountRef: + id: '197' + name: Software and Licenses + taxRateRef: + id: '47' + name: EC Purchase Goods Standard Rate Input + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + tracking: + categoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2022-10-28T11:10:22Z' + sourceModifiedDate: '2021-09-20T13:50:16' + note: '' + - id: '3399' + billCreditNoteNumber: APADJ0002 + supplierRef: + id: '3' + supplierName: ADP + withholdingTax: [] + totalAmount: 360 + totalDiscount: 0 + subTotal: 300 + totalTaxAmount: 60 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2021-09-24T00:00:00' + allocatedOnDate: '2021-09-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: No Description Provided + unitAmount: 300 + quantity: 1 + subTotal: 300 + taxAmount: 60 + totalAmount: 360 + accountRef: + id: '197' + name: Software and Licenses + taxRateRef: + id: '81' + name: UK Purchase Goods Standard Rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + tracking: + categoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2022-10-28T11:10:22Z' + sourceModifiedDate: '2021-09-29T13:34:47' + note: '' + pageNumber: 1 + pageSize: 2 + totalResults: 82 + _links: + current: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/data/billCreditNotes + next: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/data/billCreditNotes?page=2&pageSize=2 + Xero: + value: + results: + - id: ee8bec08-2be8-40ba-acd0-d53d5df11235 + billCreditNoteNumber: RPT429-1 + supplierRef: + id: 3a0d40a2-2698-4cf5-b7b2-30133c632ab6 + supplierName: Swanston Security + withholdingTax: [] + totalAmount: 25.44 + totalDiscount: 0 + subTotal: 25.44 + totalTaxAmount: 4.24 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-12-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refund as agreed due to window break when guard absent + unitAmount: 21.2 + quantity: 1 + discountAmount: 0 + subTotal: 21.2 + taxAmount: 4.24 + totalAmount: 25.44 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + discountPercentage: 0 + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: ee8bec08-2be8-40ba-acd0-d53d5df11235 + reference: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-12T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-12T00:00:00' + totalAmount: 25.44 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2011-04-07T07:26:30' + metadata: + isDeleted: false + - id: 7d1f4e11-e909-43b0-901c-2c824dff1e82 + billCreditNoteNumber: 720-2 + supplierRef: + id: cf8fa320-a527-496c-823e-22dd069d29e6 + supplierName: PC Complete + withholdingTax: [] + totalAmount: 270.36 + totalDiscount: 0 + subTotal: 270.36 + totalTaxAmount: 45.06 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-12-16T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Unable to supply DVD writer for laptop + unitAmount: 225.3 + quantity: 1 + discountAmount: 0 + subTotal: 225.3 + taxAmount: 45.06 + totalAmount: 270.36 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + discountPercentage: 0 + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 7d1f4e11-e909-43b0-901c-2c824dff1e82 + reference: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-16T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-16T00:00:00' + totalAmount: 270.36 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2011-04-06T21:00:33' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/billCreditNotes + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List bill credit notes* endpoint returns a list of [bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote) for a given company's connection. + + [Bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-bill-credit-notes + x-speakeasy-group: accounts-payable.bill-credit-notes + '/companies/{companyId}/data/billCreditNotes/{billCreditNoteId}': + parameters: + - $ref: '#/components/parameters/companyId' + - name: billCreditNoteId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a bill credit note. + get: + tags: + - Accounts payable + summary: Get bill credit note + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBillCreditNote' + examples: + Dynamics 365 Business Central: + value: + id: 0deaed0a-9f51-eb11-89f9-00224800af18 + billCreditNoteNumber: '109001' + supplierRef: + id: be1217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: 'Fabrikam, Inc.' + withholdingTax: [] + totalAmount: 8 + totalDiscount: 0 + subTotal: 8 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 8 + status: Submitted + issueDate: '2020-12-21T00:00:00' + currency: GBP + lineItems: + - description: Abdi Item No VAT + unitAmount: 8 + quantity: 1 + discountAmount: 0 + subTotal: 8 + taxAmount: 0 + totalAmount: 8 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + discountPercentage: 0 + taxRateRef: + id: 6bbc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for EXPORT / ZERO + effectiveTaxRate: 0 + itemRef: + id: ITEM-dbc37b18-4209-eb11-bbf6-0022481ad2e8-EXPORT-EXPORT + name: 'Abdi Item No VAT / General Business Posting Group: ''EXPORT'' / VAT Business Posting Group: ''EXPORT''' + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2023-03-27T14:21:26Z' + metadata: + isDeleted: false + note: BCN001 + Exact (Netherlands): + value: + id: 443bd109-e1ed-4de2-b1ab-3b13e980d288 + billCreditNoteNumber: '19600007' + supplierRef: + id: 5e6f49b9-6489-4b82-83e7-291d308919bb + supplierName: Mickey Mouse + withholdingTax: [] + totalAmount: 12.1 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 2.1 + discountPercentage: 0 + remainingCredit: 12.1 + status: Submitted + issueDate: '2019-12-16T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Cheesecake + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + accountRef: + id: 5f139759-b554-4314-862e-b9d88e5b2e1b + name: Af te dragen loonheffing + taxRateRef: + id: 84277189-ad16-456c-b501-ca31f0a483cc + name: BTW prive gebruik + effectiveTaxRate: 21 + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-03T15:06:19Z' + Exact (UK): + value: + id: f9083d38-40c7-4b5f-a693-f4670e3d85bc + billCreditNoteNumber: '19600008' + supplierRef: + id: 1c703cce-967c-4476-a86a-32e35341a8f5 + supplierName: Customer Bill Supplier + withholdingTax: [] + totalAmount: 99999 + totalDiscount: 0 + subTotal: 99999 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 99999 + status: Submitted + issueDate: '2019-10-30T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Oil Change + unitAmount: -150 + quantity: 1000.5 + discountAmount: 0 + subTotal: -150075 + totalAmount: -150075 + accountRef: + id: 885ff551-664d-451b-995b-cb114c9877d0 + name: Unallocated Cash + itemRef: + id: '3001' + trackingCategoryRefs: [] + - description: description + unitAmount: 250074 + quantity: 1 + discountAmount: 0 + subTotal: 250074 + totalAmount: 250074 + accountRef: + id: 885ff551-664d-451b-995b-cb114c9877d0 + name: Unallocated Cash + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:33:23Z' + sourceModifiedDate: '2019-10-30T13:12:56Z' + FreeAgent: + value: + id: '10665024' + billCreditNoteNumber: Bill Credit + supplierRef: + id: '6161941' + supplierName: A & J Fabtech Ltd + withholdingTax: [] + totalAmount: 1500 + totalDiscount: 0 + subTotal: 1250 + totalTaxAmount: 250 + discountPercentage: 0 + remainingCredit: 1500 + status: Submitted + issueDate: '2018-08-22T00:00:00' + currency: GBP + lineItems: + - description: A & J Fabtech Ltd - Bill Credit Note Bill Credit + unitAmount: 1250 + quantity: 1 + taxAmount: 250 + totalAmount: 1500 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2018-08-22T13:22:08Z' + metadata: + isDeleted: false + KashFlow: + value: + id: '91339087' + billCreditNoteNumber: '5' + supplierRef: + id: '6202387' + supplierName: Dell + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2020-02-25T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Oil refund + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: '21481832' + name: Oil + itemRef: + id: '114817740' + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-09-30T10:29:16Z' + Oracle NetSuite: + value: + id: '1781' + billCreditNoteNumber: VENDCRED1 + supplierRef: + id: '749' + supplierName: Jo's Cheese + withholdingTax: [] + totalAmount: 174.6 + totalDiscount: 0 + subTotal: 145.5 + totalTaxAmount: 29.1 + discountPercentage: 0 + remainingCredit: 174.6 + status: Submitted + issueDate: '2021-11-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: billcredit_test + unitAmount: 145.5 + quantity: 1 + unitOfMeasurement: pack + subTotal: 145.5 + totalAmount: 145.5 + accountRef: + id: '713' + name: Inventory Asset + createdFromLineRef: + id: '1432' + dataType: bills + lineNumber: '1' + trackingCategoryRefs: + - id: department-1 + - id: location-1 + tracking: + categoryRefs: + - id: department-1 + - id: location-1 + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + createdFromRefs: + - id: '1432' + dataType: bills + modifiedDate: '2022-09-20T08:16:22Z' + sourceModifiedDate: '2021-11-02T19:58:58' + note: Codat1 + QuickBooks Desktop: + value: + id: 6D2C-1197698059 + billCreditNoteNumber: Return + supplierRef: + id: E0000-933272656 + supplierName: Timberloft Lumber + withholdingTax: [] + totalAmount: 475 + totalDiscount: 0 + subTotal: 475 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 475 + status: Submitted + issueDate: '2024-10-30T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Lumber:Rough - Rough lumber' + unitAmount: 475 + quantity: 0 + discountAmount: 0 + subTotal: 475 + taxAmount: 0 + totalAmount: 475 + discountPercentage: 0 + itemRef: + id: 1C0000-933272656 + name: 'Lumber:Rough' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: + - payment: + id: 6D2C-1197698059 + reference: Return + currency: GBP + currencyRate: 1 + paidOnDate: '2024-10-30T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 475 + modifiedDate: '2023-04-26T09:12:30Z' + sourceModifiedDate: '2023-12-16T05:06:19' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '19' + billCreditNoteNumber: '19' + supplierRef: + id: '4' + supplierName: BILLy elliot + withholdingTax: [] + totalAmount: 5 + totalDiscount: 0 + subTotal: 5 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: + - payment: + id: '20' + currency: GBP + currencyRate: 1 + paidOnDate: '2019-05-13T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 5 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2019-05-13T13:14:06Z' + QuickBooks Online Sandbox: + value: + id: '424' + billCreditNoteNumber: '424' + supplierRef: + id: '24' + supplierName: Brijesh Jain + withholdingTax: [] + totalAmount: 69 + totalDiscount: 0 + subTotal: 69 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 69 + status: Submitted + issueDate: '2019-06-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refund of iZettle Fees + unitAmount: 69 + quantity: 1 + subTotal: 69 + taxAmount: 0 + totalAmount: 69 + accountRef: + id: '30' + name: Janitorial Expense + taxRateRef: + id: 20_Bills + name: 5.0% RC CIS Bills + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: [] + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2019-06-20T15:48:50Z' + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '45391' + billCreditNoteNumber: Return 1 + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + withholdingTax: [] + totalAmount: 120 + totalDiscount: 2.5 + subTotal: 100 + totalTaxAmount: 20 + discountPercentage: 2.5 + remainingCredit: 109.5 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + allocatedOnDate: '2020-01-20T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0.5 + subTotal: 0 + taxAmount: 20 + totalAmount: 20 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 2.5 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '45391' + note: ret1 + reference: Return 1 + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.5 + modifiedDate: '2022-10-14T09:35:52Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: ret1 + Sage 50 (UK): + value: + id: '20' + billCreditNoteNumber: O/BAL + supplierRef: + id: NEW001 + supplierName: Newtown Builders Ltd + withholdingTax: [] + totalAmount: 0.01 + totalDiscount: 0 + subTotal: 0.01 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0.01 + status: Submitted + issueDate: '2021-12-31T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Opening Balance + unitAmount: 0.01 + quantity: 1 + subTotal: 0.01 + taxAmount: 0 + totalAmount: 0.01 + accountRef: + id: '9998' + name: Suspense Account + taxRateRef: + id: '9' + name: Non-Vatable Tax Code + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: department_0 + name: Default + tracking: + categoryRefs: + - id: department_0 + name: Default + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + note: Opening Balance + Sage Business Cloud Accounting: + value: + id: b6c6fce9866849b0b44cac99ab7dc579 + billCreditNoteNumber: Supplier credit note + supplierRef: + id: ec716559789111e8aaa5027d54329956 + supplierName: Bagels Limited + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2018-11-23T00:00:00' + currency: USD + currencyRate: 0.776970973 + lineItems: + - description: Consulting services + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + discountPercentage: 0 + taxRateRef: + id: GB_ZERO + name: Zero Rated 0.00% + effectiveTaxRate: 0 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: bf6496aaf0294883b27c423ce8266113 + note: Supplier refund using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: USD + currencyRate: 0.771449236 + paidOnDate: '2019-11-19T00:00:00' + totalAmount: -10 + allocation: + currency: USD + currencyRate: 1 + totalAmount: 10 + modifiedDate: '2022-10-24T14:53:32Z' + sourceModifiedDate: '2019-11-19T14:17:32Z' + Sage Intacct: + value: + id: '3359' + billCreditNoteNumber: APADJ0001 + supplierRef: + id: '3' + supplierName: ADP + withholdingTax: [] + totalAmount: 12 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 2 + discountPercentage: 0 + remainingCredit: 12 + status: Submitted + issueDate: '2021-09-20T00:00:00' + currency: USD + currencyRate: 0.7283 + lineItems: + - description: No Description Provided + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 1 + totalAmount: 6 + accountRef: + id: '197' + name: Software and Licenses + taxRateRef: + id: '47' + name: EC Purchase Goods Standard Rate Input + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + tracking: + categoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + isBilledTo: Unknown + isRebilledTo: Unknown + - description: No Description Provided + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 1 + totalAmount: 6 + accountRef: + id: '197' + name: Software and Licenses + taxRateRef: + id: '47' + name: EC Purchase Goods Standard Rate Input + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + tracking: + categoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2022-10-28T11:10:22Z' + sourceModifiedDate: '2021-09-20T13:50:16' + note: '' + Xero: + value: + id: ee8bec08-2be8-40ba-acd0-d53d5df11235 + billCreditNoteNumber: RPT429-1 + supplierRef: + id: 3a0d40a2-2698-4cf5-b7b2-30133c632ab6 + supplierName: Swanston Security + withholdingTax: [] + totalAmount: 25.44 + totalDiscount: 0 + subTotal: 25.44 + totalTaxAmount: 4.24 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-12-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refund as agreed due to window break when guard absent + unitAmount: 21.2 + quantity: 1 + discountAmount: 0 + subTotal: 21.2 + taxAmount: 4.24 + totalAmount: 25.44 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + discountPercentage: 0 + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: ee8bec08-2be8-40ba-acd0-d53d5df11235 + reference: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-12T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-12T00:00:00' + totalAmount: 25.44 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2011-04-07T07:26:30' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get bill credit note* endpoint returns a single bill credit note for a given billCreditNoteId. + + [Bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-bill-credit-note + x-speakeasy-group: accounts-payable.bill-credit-notes + '/companies/{companyId}/data/billPayments': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + summary: List bill payments + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBillPayments' + examples: + Clear Books: + value: + results: + - id: dcb18480-8b69-44d8-aa26-268b6a80d170 + supplierRef: + id: 8GeHBdBZiZ + supplierName: 'DuBuque, Goyette and Franecki' + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + totalAmount: 71351.42 + currency: GBP + currencyRate: 1 + date: '2022-05-06T00:00:00' + note: Bill Payment against bill 81539597-e681-40c9-a4dd-ec2fffcde572 + paymentMethodRef: + id: cb4a5647-aa86-40ab-bb4f-158acaa99c12 + name: Check payments-u4p + lines: + - amount: 71351.42 + links: + - type: Bill + id: 81539597-e681-40c9-a4dd-ec2fffcde572 + amount: -71351.42 + currencyRate: 1 + allocatedOnDate: '2022-05-06T00:00:00' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-05-06T00:00:00' + metadata: + isDeleted: false + - id: ca0976d0-036d-4187-ab66-7169286b007d + supplierRef: + id: 9efd64dc-4b31-425d-9eb2-7c7773593713 + supplierName: 'Jacobson, Konopelski and Heidenreich' + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + totalAmount: 16221.64 + currency: GBP + currencyRate: 1 + date: '2022-05-14T13:12:00' + note: Bill Payment against bill 3f44d2be-d4c2-4cc3-8216-8add5265eb13 + paymentMethodRef: + id: fc87fba8-812e-4a54-b633-29ef2abf4c12 + name: CreditCard payments-u4p + lines: + - amount: 16221.64 + links: + - type: Bill + id: 3f44d2be-d4c2-4cc3-8216-8add5265eb13 + amount: -16221.64 + currencyRate: 1 + allocatedOnDate: '2022-05-14T13:12:00' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-05-14T13:12:00' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 232 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/billPayments?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/billPayments + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/billPayments?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 19387f05-8ad1-ea11-bbaa-000d3a2b9185 + supplierRef: + id: c41217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: Wide World Importers + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 234 + currency: GBP + currencyRate: 1 + date: '2019-01-01T00:00:00' + note: Invoice 107006 + lines: + - amount: 234 + links: + - type: Bill + id: c8cb06bf-89d1-ea11-bbaa-000d3a2b9185-108006 + amount: -234 + currencyRate: 1 + allocatedOnDate: '2019-01-01T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + reference: '108006' + metadata: + isDeleted: false + - id: 3d387f05-8ad1-ea11-bbaa-000d3a2b9185 + supplierRef: + id: be1217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: 'Fabrikam, Inc.' + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 390 + currency: GBP + currencyRate: 1 + date: '2019-01-01T00:00:00' + note: Invoice 107007 + lines: + - amount: 390 + links: + - type: Bill + id: cbcb06bf-89d1-ea11-bbaa-000d3a2b9185-108007 + amount: -390 + currencyRate: 1 + allocatedOnDate: '2019-01-01T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + reference: '108007' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 236 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billPayments?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billPayments + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billPayments?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: da7e456f-76f7-42ac-8dad-d90a040f3afb + supplierRef: + id: 63fadca8-4905-475a-b32a-b4341293bcf4 + supplierName: Kelly's Industrial Supplies + accountRef: + id: d79d65bd-1d7d-4f55-95d3-76b3a7b7b823 + name: Bank 1 + totalAmount: -5 + currency: EUR + currencyRate: 1 + date: '2019-11-05T00:00:00Z' + lines: + - amount: -5 + links: + - type: PaymentOnAccount + id: 63fadca8-4905-475a-b32a-b4341293bcf4 + amount: 5 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:13Z' + sourceModifiedDate: '2019-11-05T14:26:22Z' + reference: '19200008' + - id: 002b8462-f3a3-4019-84fe-6a2af1f30c5a + supplierRef: + id: 5811b467-53eb-4491-8ca1-bc9b7889811b + supplierName: Ann's test supplier 2 + accountRef: + id: 1879b322-7758-4e20-8f3f-701df27f2340 + name: Kas + totalAmount: 0.13 + currency: EUR + currencyRate: 1 + date: '2019-11-07T00:00:00Z' + lines: + - amount: -0.12 + links: + - type: CreditNote + id: 33f3016c-2ecf-4d17-911e-b385537e7341 + amount: 0.12 + currencyRate: 1 + - amount: 0.12 + links: + - type: Bill + id: de6b3634-faf2-4688-b06b-72ed3ca6cf4e + amount: -0.12 + currencyRate: 1 + - amount: 0.13 + links: + - type: Bill + id: de6b3634-faf2-4688-b06b-72ed3ca6cf4e + amount: -0.13 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:14Z' + sourceModifiedDate: '2021-11-17T12:08:10Z' + reference: '19100002' + pageNumber: 1 + pageSize: 2 + totalResults: 1173 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billPayments?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billPayments + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billPayments?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 7a5f621b-739f-4ed8-b738-2aae3ef886ac + supplierRef: + id: a7cad20d-44db-442b-ac1f-90475802d6fb + supplierName: Pencils Pencils Pencils + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 123 + currency: GBP + currencyRate: 1 + date: '2017-10-11T00:00:00Z' + lines: + - amount: 123 + links: + - type: Bill + id: e7a45898-2db3-424c-acb9-a51647740f26 + amount: -123 + currencyRate: 1 + modifiedDate: '2022-10-26T13:33:17Z' + sourceModifiedDate: '2017-10-11T10:12:29Z' + reference: '17200006' + - id: b358df76-3930-42ad-8f38-78edcc60172d + supplierRef: + id: 41302634-76b5-4442-b800-0bb63780e77c + supplierName: Some Supplier + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 55000 + currency: GBP + currencyRate: 1 + date: '2017-10-31T00:00:00Z' + lines: + - amount: 55000 + links: + - type: PaymentOnAccount + id: 41302634-76b5-4442-b800-0bb63780e77c + amount: -55000 + currencyRate: 1 + modifiedDate: '2022-10-26T13:33:17Z' + sourceModifiedDate: '2019-02-14T17:56:54Z' + reference: '17200001' + pageNumber: 1 + pageSize: 2 + totalResults: 39 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billPayments?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billPayments + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billPayments?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '135234103' + supplierRef: + id: '7169654' + supplierName: The Eagle + totalAmount: 14.3 + currency: GBP + date: '2017-11-23T00:00:00' + note: 'ATOMIC SOFTWARE LIMITE WELLINGTON,NZL OTHER �14.30 - Bill payment against Pints1 (The Eagle)' + lines: + - amount: 14.3 + links: + - type: Bill + id: '10659723' + amount: -14.3 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:36Z' + metadata: + isDeleted: false + - id: '168350314' + supplierRef: + id: '6161941' + supplierName: A & J Fabtech Ltd + totalAmount: 30 + currency: GBP + date: '2019-01-03T00:00:00' + note: �30.00 - Bill payment against Test123 (A & J Fabtech Ltd) + lines: + - amount: 30 + links: + - type: Bill + id: '11224800' + amount: -30 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:36Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 89 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billPayments?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billPayments + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billPayments?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '16' + supplierRef: + id: '29' + accountRef: + id: '167679' + name: Cash + totalAmount: 10 + currency: GBP + date: '2021-08-18T00:00:00' + note: Bill payment + lines: + - amount: 10 + links: + - type: Bill + id: '16' + amount: -10 + currencyRate: 1 + allocatedOnDate: '2021-08-18T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + metadata: + isDeleted: false + - id: '18' + supplierRef: + id: '39' + accountRef: + id: '167679' + name: Cash + totalAmount: 15 + currency: USD + date: '2021-08-18T00:00:00' + note: Bill payment Ikea + lines: + - amount: 15 + links: + - type: Bill + id: '18' + amount: -15 + currencyRate: 1 + allocatedOnDate: '2021-08-18T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 26 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/billPayments?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/billPayments + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/billPayments?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '112' + supplierRef: + id: '724' + supplierName: Vendor A.A.A + accountRef: + id: '825' + name: Codat Europe Bank + totalAmount: 120 + currency: GBP + currencyRate: 1 + date: '2021-03-26T00:00:00' + lines: + - amount: 120 + links: + - type: Bill + id: '7' + amount: -120 + currencyRate: 1 + modifiedDate: '2023-01-30T14:48:40Z' + sourceModifiedDate: '2021-03-26T10:31:06' + reference: 'Bill Payment #1' + - id: 159623-724 + supplierRef: + id: '724' + supplierName: Vendor A.A.A + accountRef: + id: '825' + name: Codat Europe Bank + totalAmount: -555.55 + currency: GBP + currencyRate: 1 + date: '2022-07-11T00:00:00' + lines: + - amount: -555.55 + links: + - type: PaymentOnAccount + id: '724' + amount: 555.55 + currencyRate: 1 + modifiedDate: '2023-01-30T14:48:40Z' + sourceModifiedDate: '2022-07-11T09:41:02' + reference: 'Deposit #DEP25' + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/billPayments?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/billPayments + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/billPayments?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 3A09-1071529982 + supplierRef: + id: 720000-1071512482 + supplierName: Bayshore Auto Mall + accountRef: + id: 20000-933270541 + name: Checking + totalAmount: 532.97 + currency: GBP + currencyRate: 1 + date: '2023-01-11T00:00:00' + note: Monthly Truck Payment + lines: + - amount: 532.97 + links: + - type: Bill + id: 38AA-1071513625 + amount: -532.97 + currencyRate: 1 + modifiedDate: '2023-04-26T09:09:20Z' + sourceModifiedDate: '2023-12-16T05:04:58' + reference: '101' + metadata: + isDeleted: false + - id: 84C2-1197705262 + supplierRef: + id: B0000-933272656 + supplierName: Patton Hardware Supplies + accountRef: + id: '8000007E-1197732180' + name: CalOil Credit Card + totalAmount: 4050.98 + currency: GBP + currencyRate: 1 + date: '2023-01-15T00:00:00' + lines: + - amount: 4050.98 + links: + - type: Bill + id: 84C2-1197705262 + amount: -4050.98 + currencyRate: 1 + allocatedOnDate: '2023-01-15T00:00:00' + modifiedDate: '2023-04-26T09:09:20Z' + sourceModifiedDate: '2023-12-16T05:06:15' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 214 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billPayments?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billPayments + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billPayments?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '20' + supplierRef: + id: '4' + supplierName: BILLy elliot + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2019-05-13T00:00:00' + lines: + - amount: 0 + links: + - type: Bill + id: '18' + amount: -5 + currencyRate: 1 + - type: CreditNote + id: '19' + amount: 5 + currencyRate: 1 + modifiedDate: '2023-01-18T11:02:47Z' + sourceModifiedDate: '2019-05-13T13:14:26Z' + - id: '25' + supplierRef: + id: '5' + supplierName: Callum McGinley + accountRef: + id: '63' + name: Business Bank Account + totalAmount: 5999.99 + currency: GBP + currencyRate: 1 + date: '2019-05-31T00:00:00' + lines: + - amount: 5999.99 + links: + - type: Bill + id: '24' + amount: -5999.99 + currencyRate: 1 + modifiedDate: '2023-01-18T11:02:47Z' + sourceModifiedDate: '2019-05-31T12:55:10Z' + pageNumber: 1 + pageSize: 2 + totalResults: 126 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billPayments?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billPayments + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billPayments?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '158' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + accountRef: + id: '81' + name: Current + totalAmount: 7940.6 + currency: HKD + currencyRate: 0.078807 + date: '2016-01-23T00:00:00' + lines: + - amount: 7940.6 + links: + - type: Bill + id: '157' + amount: -7940.6 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-13T21:19:36Z' + reference: '1067' + metadata: + isDeleted: false + - id: '159' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + accountRef: + id: '81' + name: Current + totalAmount: 742.5 + currency: HKD + currencyRate: 0.078807 + date: '2016-01-23T00:00:00' + lines: + - amount: 742.5 + links: + - type: Bill + id: '28' + amount: -742.5 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-13T21:19:49Z' + reference: '1068' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 191 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billPayments?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billPayments + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billPayments?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '45462' + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + totalAmount: 27 + currency: GBP + currencyRate: 1 + date: '2020-01-05T00:00:00Z' + note: '' + lines: + - amount: 27 + links: + - type: PaymentOnAccount + id: CON001 + amount: -27 + currencyRate: 1 + modifiedDate: '2022-10-14T09:35:54Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: Payment invoice 1 + - id: '45502' + supplierRef: + id: SDE001 + supplierName: S D Enterprises + totalAmount: 59 + currency: GBP + currencyRate: 1 + date: '2020-01-17T00:00:00Z' + note: pay3 + lines: + - amount: 59 + links: + - type: PaymentOnAccount + id: SDE001 + amount: -59 + currencyRate: 1 + modifiedDate: '2022-10-14T09:35:54Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: payment inv3 + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billPayments?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billPayments + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billPayments?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '255' + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + totalAmount: 370.71 + currency: GBP + currencyRate: 1 + date: '2022-01-29T00:00:00' + note: 'Purchase payment 255 linked to, purchase invoice 86, purchase invoice 87, purchase invoice 250, purchase invoice 251, purchase invoice 252.' + lines: + - amount: 117.5 + links: + - type: Bill + id: '86' + amount: -117.5 + currencyRate: 1 + - amount: 64.63 + links: + - type: Bill + id: '87' + amount: -64.63 + currencyRate: 1 + - amount: 50.57 + links: + - type: Bill + id: '250' + amount: -50.57 + currencyRate: 1 + - amount: 36.87 + links: + - type: Bill + id: '251' + amount: -36.87 + currencyRate: 1 + - amount: 101.14 + links: + - type: Bill + id: '252' + amount: -101.14 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + - id: '256' + supplierRef: + id: QUA001 + supplierName: Quality Motors + totalAmount: 256.36 + currency: GBP + currencyRate: 1 + date: '2022-01-29T00:00:00' + note: 'Purchase payment 256 linked to, purchase invoice 17.' + lines: + - amount: 256.36 + links: + - type: Bill + id: '17' + amount: -256.36 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 27 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billPayments?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billPayments + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billPayments?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: d953b45e156011e8b45c025132dab352 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + totalAmount: 52.02 + currency: GBP + currencyRate: 1 + date: '2018-02-15T00:00:00' + note: Supplier payment using credit/debit card - Cool stuff + lines: + - amount: 52.02 + links: + - type: PaymentOnAccount + id: ca430e0d156011e8b45c025132dab352 + amount: -52.02 + currencyRate: 1 + modifiedDate: '2022-10-24T14:54:04Z' + sourceModifiedDate: '2019-11-20T09:30:03Z' + - id: a99b9aae216111e8b45c025132dab352 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + accountRef: + id: 9a3e4bc6267a11e797950a57719b2edb + name: Cash + totalAmount: 52.02 + currency: GBP + currencyRate: 1 + date: '2018-03-06T00:00:00' + note: Supplier payment using cash + lines: + - amount: 52.02 + links: + - type: PaymentOnAccount + id: ca430e0d156011e8b45c025132dab352 + amount: -52.02 + currencyRate: 1 + modifiedDate: '2022-10-24T14:54:04Z' + sourceModifiedDate: '2018-03-06T17:13:17Z' + pageNumber: 1 + pageSize: 2 + totalResults: 2225 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billPayments?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billPayments + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billPayments?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '4471' + supplierRef: + id: '3' + supplierName: ADP + accountRef: + id: '353' + name: Current Account + totalAmount: 20 + currency: GBP + date: '2022-01-06T00:00:00' + note: '' + paymentMethodRef: + id: '6' + name: Cash + lines: + - amount: 20 + links: + - type: Bill + id: '4470' + amount: -20 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:13Z' + sourceModifiedDate: '2022-02-23T12:03:30' + metadata: + isDeleted: false + - id: '4472' + supplierRef: + id: '3' + supplierName: ADP + accountRef: + id: '353' + name: Current Account + totalAmount: 5 + currency: GBP + date: '2022-01-06T00:00:00' + note: '' + paymentMethodRef: + id: '6' + name: Cash + lines: + - amount: 5 + links: + - type: Bill + id: '4470' + amount: -5 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:13Z' + sourceModifiedDate: '2022-02-23T12:06:58' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/billPayments?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/billPayments + Xero: + value: + results: + - id: 74004690-82a1-4810-aaca-6ce575af94b4 + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 7267.2 + currency: GBP + currencyRate: 1 + date: '2021-12-20T00:00:00' + lines: + - amount: 7267.2 + links: + - type: Bill + id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + amount: -7267.2 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:10Z' + sourceModifiedDate: '2021-01-02T22:51:40' + metadata: + isDeleted: false + - id: f2062172-b444-4c8b-b797-9f4c7a4244c7 + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 7267.2 + currency: GBP + currencyRate: 1 + date: '2022-02-17T00:00:00' + lines: + - amount: 7267.2 + links: + - type: Bill + id: 09aa506f-cb81-4cd3-a1ea-6a0b91804d5a + amount: -7267.2 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:10Z' + sourceModifiedDate: '2021-01-02T22:51:38' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 30 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/billPayments?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/billPayments + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/billPayments?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List bill payments* endpoint returns a list of [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment) for a given company's connection. + + [Bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-bill-payments + x-speakeasy-group: accounts-payable.bill-payments + '/companies/{companyId}/data/billPayments/{billPaymentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/accountingBillPaymentId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBillPayment' + examples: + Clear Books: + value: + id: dcb18480-8b69-44d8-aa26-268b6a80d170 + supplierRef: + id: 8GeHBdBZiZ + supplierName: 'DuBuque, Goyette and Franecki' + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + totalAmount: 71351.42 + currency: GBP + currencyRate: 1 + date: '2022-05-06T00:00:00' + note: Bill Payment against bill 81539597-e681-40c9-a4dd-ec2fffcde572 + paymentMethodRef: + id: cb4a5647-aa86-40ab-bb4f-158acaa99c12 + name: Check payments-u4p + lines: + - amount: 71351.42 + links: + - type: Bill + id: 81539597-e681-40c9-a4dd-ec2fffcde572 + amount: -71351.42 + currencyRate: 1 + allocatedOnDate: '2022-05-06T00:00:00' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-05-06T00:00:00' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 19387f05-8ad1-ea11-bbaa-000d3a2b9185 + supplierRef: + id: c41217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: Wide World Importers + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 234 + currency: GBP + currencyRate: 1 + date: '2019-01-01T00:00:00' + note: Invoice 107006 + lines: + - amount: 234 + links: + - type: Bill + id: c8cb06bf-89d1-ea11-bbaa-000d3a2b9185-108006 + amount: -234 + currencyRate: 1 + allocatedOnDate: '2019-01-01T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + reference: '108006' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: da7e456f-76f7-42ac-8dad-d90a040f3afb + supplierRef: + id: 63fadca8-4905-475a-b32a-b4341293bcf4 + supplierName: Kelly's Industrial Supplies + accountRef: + id: d79d65bd-1d7d-4f55-95d3-76b3a7b7b823 + name: Bank 1 + totalAmount: -5 + currency: EUR + currencyRate: 1 + date: '2019-11-05T00:00:00Z' + lines: + - amount: -5 + links: + - type: PaymentOnAccount + id: 63fadca8-4905-475a-b32a-b4341293bcf4 + amount: 5 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:13Z' + sourceModifiedDate: '2019-11-05T14:26:22Z' + reference: '19200008' + Exact (UK): + value: + id: 7a5f621b-739f-4ed8-b738-2aae3ef886ac + supplierRef: + id: a7cad20d-44db-442b-ac1f-90475802d6fb + supplierName: Pencils Pencils Pencils + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 123 + currency: GBP + currencyRate: 1 + date: '2017-10-11T00:00:00Z' + lines: + - amount: 123 + links: + - type: Bill + id: e7a45898-2db3-424c-acb9-a51647740f26 + amount: -123 + currencyRate: 1 + modifiedDate: '2022-10-26T13:33:17Z' + sourceModifiedDate: '2017-10-11T10:12:29Z' + reference: '17200006' + FreeAgent: + value: + id: '135234103' + supplierRef: + id: '7169654' + supplierName: The Eagle + totalAmount: 14.3 + currency: GBP + date: '2017-11-23T00:00:00' + note: 'ATOMIC SOFTWARE LIMITE WELLINGTON,NZL OTHER �14.30 - Bill payment against Pints1 (The Eagle)' + lines: + - amount: 14.3 + links: + - type: Bill + id: '10659723' + amount: -14.3 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:36Z' + metadata: + isDeleted: false + FreshBooks: + value: + id: '16' + supplierRef: + id: '29' + accountRef: + id: '167679' + name: Cash + totalAmount: 10 + currency: GBP + date: '2021-08-18T00:00:00' + note: Bill payment + lines: + - amount: 10 + links: + - type: Bill + id: '16' + amount: -10 + currencyRate: 1 + allocatedOnDate: '2021-08-18T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + metadata: + isDeleted: false + Oracle NetSuite: + value: + id: '112' + supplierRef: + id: '724' + supplierName: Vendor A.A.A + accountRef: + id: '825' + name: Codat Europe Bank + totalAmount: 120 + currency: GBP + currencyRate: 1 + date: '2021-03-26T00:00:00' + lines: + - amount: 120 + links: + - type: Bill + id: '7' + amount: -120 + currencyRate: 1 + modifiedDate: '2023-01-30T14:48:40Z' + sourceModifiedDate: '2021-03-26T10:31:06' + reference: 'Bill Payment #1' + QuickBooks Desktop: + value: + id: 3A09-1071529982 + supplierRef: + id: 720000-1071512482 + supplierName: Bayshore Auto Mall + accountRef: + id: 20000-933270541 + name: Checking + totalAmount: 532.97 + currency: GBP + currencyRate: 1 + date: '2023-01-11T00:00:00' + note: Monthly Truck Payment + lines: + - amount: 532.97 + links: + - type: Bill + id: 38AA-1071513625 + amount: -532.97 + currencyRate: 1 + modifiedDate: '2023-04-26T09:09:20Z' + sourceModifiedDate: '2023-12-16T05:04:58' + reference: '101' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '20' + supplierRef: + id: '4' + supplierName: BILLy elliot + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2019-05-13T00:00:00' + lines: + - amount: 0 + links: + - type: Bill + id: '18' + amount: -5 + currencyRate: 1 + - type: CreditNote + id: '19' + amount: 5 + currencyRate: 1 + modifiedDate: '2023-01-18T11:02:47Z' + sourceModifiedDate: '2019-05-13T13:14:26Z' + QuickBooks Online Sandbox: + value: + id: '158' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + accountRef: + id: '81' + name: Current + totalAmount: 7940.6 + currency: HKD + currencyRate: 0.078807 + date: '2016-01-23T00:00:00' + lines: + - amount: 7940.6 + links: + - type: Bill + id: '157' + amount: -7940.6 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-13T21:19:36Z' + reference: '1067' + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '45462' + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + totalAmount: 27 + currency: GBP + currencyRate: 1 + date: '2020-01-05T00:00:00Z' + note: '' + lines: + - amount: 27 + links: + - type: PaymentOnAccount + id: CON001 + amount: -27 + currencyRate: 1 + modifiedDate: '2022-10-14T09:35:54Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: Payment invoice 1 + Sage 50 (UK): + value: + id: '255' + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + totalAmount: 370.71 + currency: GBP + currencyRate: 1 + date: '2022-01-29T00:00:00' + note: 'Purchase payment 255 linked to, purchase invoice 86, purchase invoice 87, purchase invoice 250, purchase invoice 251, purchase invoice 252.' + lines: + - amount: 117.5 + links: + - type: Bill + id: '86' + amount: -117.5 + currencyRate: 1 + - amount: 64.63 + links: + - type: Bill + id: '87' + amount: -64.63 + currencyRate: 1 + - amount: 50.57 + links: + - type: Bill + id: '250' + amount: -50.57 + currencyRate: 1 + - amount: 36.87 + links: + - type: Bill + id: '251' + amount: -36.87 + currencyRate: 1 + - amount: 101.14 + links: + - type: Bill + id: '252' + amount: -101.14 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: d953b45e156011e8b45c025132dab352 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + totalAmount: 52.02 + currency: GBP + currencyRate: 1 + date: '2018-02-15T00:00:00' + note: Supplier payment using credit/debit card - Cool stuff + lines: + - amount: 52.02 + links: + - type: PaymentOnAccount + id: ca430e0d156011e8b45c025132dab352 + amount: -52.02 + currencyRate: 1 + modifiedDate: '2022-10-24T14:54:04Z' + sourceModifiedDate: '2019-11-20T09:30:03Z' + Sage Intacct: + value: + id: '4471' + supplierRef: + id: '3' + supplierName: ADP + accountRef: + id: '353' + name: Current Account + totalAmount: 20 + currency: GBP + date: '2022-01-06T00:00:00' + note: '' + paymentMethodRef: + id: '6' + name: Cash + lines: + - amount: 20 + links: + - type: Bill + id: '4470' + amount: -20 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:13Z' + sourceModifiedDate: '2022-02-23T12:03:30' + metadata: + isDeleted: false + Xero: + value: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 7267.2 + currency: GBP + currencyRate: 1 + date: '2021-12-20T00:00:00' + lines: + - amount: 7267.2 + links: + - type: Bill + id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + amount: -7267.2 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:10Z' + sourceModifiedDate: '2021-01-02T22:51:40' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get bill payment + description: | + The *Get bill payment* endpoint returns a single bill payment for a given billPaymentId. + + [Bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-bill-payment + x-speakeasy-group: accounts-payable.bill-payments + '/companies/{companyId}/data/bills': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + summary: List bills + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBills' + examples: + Clear Books: + value: + results: + - id: 81539597-e681-40c9-a4dd-ec2fffcde572 + reference: b465a2c9-3212-4620-889b-6328ba148215 + supplierRef: + id: 8GeHBdBZiZ + supplierName: 'DuBuque, Goyette and Franecki' + purchaseOrderRefs: [] + issueDate: '2022-04-29T00:00:00' + dueDate: '2022-05-06T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Grease Trap + unitAmount: 2781.94 + quantity: 5 + discountAmount: 0 + subTotal: 13909.7 + taxAmount: 1390.97 + totalAmount: 15300.67 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 5 + discountAmount: 0 + subTotal: 6856.95 + taxAmount: 685.7 + totalAmount: 7542.65 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 6 + discountAmount: 0 + subTotal: 8228.34 + taxAmount: 822.83 + totalAmount: 9051.17 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 2781.94 + quantity: 3 + discountAmount: 0 + subTotal: 8345.82 + taxAmount: 834.58 + totalAmount: 9180.4 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Trapped Road Gully 450mm x 450mm + unitAmount: 402.89 + quantity: 8 + discountAmount: 0 + subTotal: 3223.12 + taxAmount: 322.31 + totalAmount: 3545.43 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + name: Heavy Duty Hinged Gully Grating + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 7 + discountAmount: 0 + subTotal: 665.56 + taxAmount: 66.56 + totalAmount: 732.12 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 1 + discountAmount: 0 + subTotal: 95.08 + taxAmount: 9.51 + totalAmount: 104.59 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 2 + discountAmount: 0 + subTotal: 2742.78 + taxAmount: 274.28 + totalAmount: 3017.06 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 2781.94 + quantity: 1 + discountAmount: 0 + subTotal: 2781.94 + taxAmount: 278.19 + totalAmount: 3060.13 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 7 + discountAmount: 0 + subTotal: 665.56 + taxAmount: 66.56 + totalAmount: 732.12 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1251.89 + quantity: 4 + discountAmount: 0 + subTotal: 5007.56 + taxAmount: 500.76 + totalAmount: 5508.32 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 51077072-d5c3-463b-9cb4-7da2e11886f9 + name: 150 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 9 + discountAmount: 0 + subTotal: 12342.51 + taxAmount: 1234.25 + totalAmount: 13576.76 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 64864.92 + taxAmount: 6486.5 + totalAmount: 71351.42 + amountDue: 0 + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2023-02-14T17:09:02' + note: 'Bill with 12 line items, totaling 71351.42' + paymentAllocations: + - payment: + id: dcb18480-8b69-44d8-aa26-268b6a80d170 + note: Bill Payment against bill 81539597-e681-40c9-a4dd-ec2fffcde572 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-06T00:00:00' + totalAmount: 71351.42 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-06T00:00:00' + totalAmount: -71351.42 + metadata: + isDeleted: false + - id: acc1dc9d-a21a-41b8-953e-73da4afab6e6 + reference: d88e83b8-a5cc-4578-815d-afa263df4beb + supplierRef: + id: 7GObELDcsE + supplierName: 'Lakin, Schmeler and Kihn' + purchaseOrderRefs: + - id: 7f07b584-bebe-450f-aa9e-1d7aed630b66 + purchaseOrderNumber: ee9b8e00-49a2-4d83-bc33-e2eee59a1c36 + issueDate: '2022-04-30T00:00:00' + dueDate: '2022-05-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 4 + discountAmount: 0 + subTotal: 380.32 + taxAmount: 38.03 + totalAmount: 418.35 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 380.32 + taxAmount: 38.03 + totalAmount: 418.35 + amountDue: 0 + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2023-04-14T01:56:02' + note: Bill for purchase order ee9b8e00-49a2-4d83-bc33-e2eee59a1c36 + paymentAllocations: + - payment: + id: a4fa017a-3911-4eb0-aaf9-b002c446c8c3 + note: Bill Payment against bill acc1dc9d-a21a-41b8-953e-73da4afab6e6 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-15T00:00:00' + totalAmount: 418.35 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-15T00:00:00' + totalAmount: -418.35 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 183 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/bills?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/bills + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/bills?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 4019ee2b-d05a-ed11-8c34-000d3a0d28a2-108276 + reference: '108276' + supplierRef: + id: c01217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: First Up Consultants + purchaseOrderRefs: [] + issueDate: '2019-01-01T00:00:00' + dueDate: '2019-01-01T00:00:00' + currency: GBP + lineItems: + - description: ATHENS Desk + unitAmount: 506.6 + quantity: 4 + discountAmount: 202.64 + subTotal: 1823.76 + taxAmount: 364.75 + totalAmount: 2188.51 + discountPercentage: 10 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-c81217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'ATHENS Desk / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 1823.76 + taxAmount: 364.75 + totalAmount: 2188.51 + amountDue: 2188.51 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-11-02T17:02:48Z' + note: '129148' + paymentAllocations: [] + metadata: + isDeleted: false + - id: b9cb06bf-89d1-ea11-bbaa-000d3a2b9185-108001 + reference: '108001' + supplierRef: + id: c01217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: First Up Consultants + purchaseOrderRefs: [] + issueDate: '2019-01-01T00:00:00' + dueDate: '2019-01-01T00:00:00' + currency: GBP + lineItems: + - description: ATHENS Desk + unitAmount: 506.6 + quantity: 4 + discountAmount: 0 + subTotal: 2026.4 + taxAmount: 405.28 + totalAmount: 2431.68 + discountPercentage: 0 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-c81217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'ATHENS Desk / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 2026.4 + taxAmount: 405.28 + totalAmount: 2431.68 + amountDue: 0 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-17T16:29:02Z' + note: '107001' + paymentAllocations: + - payment: + id: 57377f05-8ad1-ea11-bbaa-000d3a2b9185 + note: Invoice 107001 + reference: '108001' + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + currency: GBP + currencyRate: 1 + paidOnDate: '2019-01-01T00:00:00' + totalAmount: 2431.68 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-01-01T00:00:00' + totalAmount: -2431.68 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 294 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/bills?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/bills + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/bills?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 1c55118b-793e-4437-9c13-4f554b9ca989 + reference: '19600006' + supplierRef: + id: 5e6f49b9-6489-4b82-83e7-291d308919bb + supplierName: Mickey Mouse + purchaseOrderRefs: [] + issueDate: '2019-12-16T00:00:00Z' + dueDate: '2019-11-09T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Cheesecake + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + accountRef: + id: 5f139759-b554-4314-862e-b9d88e5b2e1b + name: Af te dragen loonheffing + taxRateRef: + id: 84277189-ad16-456c-b501-ca31f0a483cc + name: BTW prive gebruik + effectiveTaxRate: 21 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + amountDue: 0 + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-03T15:06:02Z' + paymentAllocations: + - payment: + id: d9a2980b-2a43-46f2-9c7f-413d925b3cdd + reference: '20200032' + accountRef: + id: d79d65bd-1d7d-4f55-95d3-76b3a7b7b823 + name: Bank 1 + currency: EUR + currencyRate: 1 + paidOnDate: '2021-03-22T00:00:00' + totalAmount: 12.1 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -12.1 + - id: ec0c61a1-deb6-4496-b9ee-feb29b16019c + reference: '19600008' + supplierRef: + id: fc189bfa-f083-438c-bf09-379a0631d4a1 + supplierName: Mickey Mouse + purchaseOrderRefs: [] + issueDate: '2019-12-16T00:00:00Z' + dueDate: '2019-11-09T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Cheesecake + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + accountRef: + id: 5f139759-b554-4314-862e-b9d88e5b2e1b + name: Af te dragen loonheffing + taxRateRef: + id: 84277189-ad16-456c-b501-ca31f0a483cc + name: BTW prive gebruik + effectiveTaxRate: 21 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + amountDue: 12.1 + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-03T15:06:39Z' + paymentAllocations: + - payment: + id: ef5d140b-16da-4fd2-a0c8-d5bfb89a13ee + reference: '19900056' + accountRef: + id: a2d51b6f-677d-4bbf-ad0c-b45fd6231546 + name: Activa herwaarderingen + currency: EUR + currencyRate: 1 + paidOnDate: '2019-11-07T00:00:00' + totalAmount: 0.21 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -0.21 + - payment: + id: b69e7ad4-2b90-4a5f-a8a0-67418ac95531 + reference: '19900053' + accountRef: + id: a2d51b6f-677d-4bbf-ad0c-b45fd6231546 + name: Activa herwaarderingen + currency: EUR + currencyRate: 1 + paidOnDate: '2019-11-07T00:00:00' + totalAmount: 0.2 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -0.2 + - payment: + id: 6ccd1256-6073-4bfc-8d88-700417685e72 + reference: '21200028' + accountRef: + id: d79d65bd-1d7d-4f55-95d3-76b3a7b7b823 + name: Bank 1 + currency: EUR + currencyRate: 1 + paidOnDate: '2021-10-05T00:00:00' + totalAmount: 12.1 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -12.1 + - payment: + id: 69a8533b-3e59-4d2d-9bca-bc37bc0f7984 + reference: '19900055' + accountRef: + id: a2d51b6f-677d-4bbf-ad0c-b45fd6231546 + name: Activa herwaarderingen + currency: EUR + currencyRate: 1 + paidOnDate: '2019-11-07T00:00:00' + totalAmount: 0.21 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -0.21 + - payment: + id: 2dae3548-ff11-4ad8-886c-eb5cb7965024 + reference: '19900054' + accountRef: + id: a2d51b6f-677d-4bbf-ad0c-b45fd6231546 + name: Activa herwaarderingen + currency: EUR + currencyRate: 1 + paidOnDate: '2019-11-07T00:00:00' + totalAmount: 0.21 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -0.21 + pageNumber: 1 + pageSize: 2 + totalResults: 80 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/bills?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/bills + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/bills?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: e7a45898-2db3-424c-acb9-a51647740f26 + reference: '17600002' + supplierRef: + id: a7cad20d-44db-442b-ac1f-90475802d6fb + supplierName: Pencils Pencils Pencils + purchaseOrderRefs: [] + issueDate: '2017-09-26T00:00:00Z' + dueDate: '2017-10-26T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Stationery + unitAmount: 400 + quantity: 2 + discountAmount: 0 + subTotal: 800 + taxAmount: 160 + totalAmount: 960 + accountRef: + id: e5e9e994-0f14-4614-b162-7b5593b21276 + name: Finished Goods Stock + taxRateRef: + id: 63cd143a-66ab-4320-8a6d-ab6be85ed048 + name: UK purchases standard rate � Excluding + effectiveTaxRate: 20 + itemRef: + id: '001' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 800 + taxAmount: 160 + totalAmount: 960 + amountDue: 0 + modifiedDate: '2022-10-26T13:33:20Z' + sourceModifiedDate: '2019-01-11T14:18:17Z' + paymentAllocations: + - payment: + id: 7a5f621b-739f-4ed8-b738-2aae3ef886ac + reference: '17200006' + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2017-10-11T00:00:00' + totalAmount: 123 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -123 + - id: 064fbab9-9b4d-4e83-b2df-0f4ce12bc2bf + reference: '19600001' + supplierRef: + id: a4d5d739-c979-4819-b0ce-666db1ec3a7d + supplierName: Exact Software (UK) Ltd � Exact Online + purchaseOrderRefs: [] + issueDate: '2019-01-11T00:00:00Z' + dueDate: '2019-02-10T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Basket balls + unitAmount: 20 + quantity: 1 + discountAmount: 0 + subTotal: 20 + taxAmount: 0 + totalAmount: 20 + accountRef: + id: 885ff551-664d-451b-995b-cb114c9877d0 + name: Unallocated Cash + itemRef: + id: '23' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 20 + taxAmount: 0 + totalAmount: 20 + amountDue: 0 + modifiedDate: '2022-10-26T13:33:20Z' + sourceModifiedDate: '2019-01-11T12:03:31Z' + paymentAllocations: + - payment: + id: d871f677-c2df-4069-bda0-c6804a46b71b + reference: '19200001' + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2019-02-10T00:00:00' + totalAmount: 20 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -20 + pageNumber: 1 + pageSize: 2 + totalResults: 83 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/bills?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/bills + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/bills?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '16609552' + reference: MATT - U + supplierRef: + id: '7169654' + supplierName: The Eagle + purchaseOrderRefs: [] + issueDate: '2014-08-21T00:00:00' + dueDate: '2018-09-20T00:00:00' + currency: GBP + lineItems: + - unitAmount: 125 + quantity: 1 + taxAmount: 25 + totalAmount: 150 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 125 + taxAmount: 25 + totalAmount: 150 + amountDue: 150 + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2020-11-11T12:48:55Z' + paymentAllocations: [] + metadata: + isDeleted: false + - id: '16609589' + reference: MATT - U + supplierRef: + id: '7169654' + supplierName: The Eagle + purchaseOrderRefs: [] + issueDate: '2014-08-21T00:00:00' + dueDate: '2018-09-20T00:00:00' + currency: GBP + lineItems: + - unitAmount: 125 + quantity: 1 + taxAmount: 25 + totalAmount: 150 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 125 + taxAmount: 25 + totalAmount: 150 + amountDue: 150 + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2020-11-11T12:50:41Z' + paymentAllocations: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 137 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/bills?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/bills + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/bills?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '27' + supplierRef: + id: '87' + purchaseOrderRefs: [] + issueDate: '2021-04-26T00:00:00' + dueDate: '2021-05-26T00:00:00' + currency: USD + lineItems: + - description: Grocery + unitAmount: 50 + quantity: 1 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + accountRef: + id: '3384197' + name: Advertising + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + amountDue: 50 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-04-26T19:34:22' + paymentAllocations: [] + metadata: + isDeleted: false + - id: '29' + supplierRef: + id: '89' + purchaseOrderRefs: [] + issueDate: '2021-04-28T00:00:00' + dueDate: '2021-05-28T00:00:00' + currency: GBP + lineItems: + - description: Advertising refund + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: '3384197' + name: Advertising + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + amountDue: 0 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-08-18T13:52:33' + paymentAllocations: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 16 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/bills?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/bills + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/bills?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '97615244' + reference: '25' + supplierRef: + id: '9272052' + supplierName: Supplier man + purchaseOrderRefs: [] + issueDate: '2000-01-01T00:00:00' + dueDate: '2000-01-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 8.33 + quantity: 1 + subTotal: 8.33 + taxAmount: 1.67 + totalAmount: 10 + accountRef: + id: '21481884' + name: Computer equipment cost + itemRef: + id: '122990246' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 8.33 + taxAmount: 1.67 + totalAmount: 10 + amountDue: 0 + modifiedDate: '2022-09-30T10:29:15Z' + paymentAllocations: [] + - id: '76144089' + reference: '1' + supplierRef: + id: '6202387' + supplierName: Dell + purchaseOrderRefs: [] + issueDate: '2019-01-28T00:00:00' + dueDate: '2019-02-27T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 120 + quantity: 5 + subTotal: 600 + taxAmount: 0 + totalAmount: 600 + accountRef: + id: '21481820' + name: Materials purchased + itemRef: + id: '95293985' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 600 + taxAmount: 0 + totalAmount: 600 + amountDue: 0 + modifiedDate: '2022-09-30T10:29:15Z' + paymentAllocations: [] + pageNumber: 1 + pageSize: 2 + totalResults: 19 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/bills?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/bills + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/bills?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '7' + supplierRef: + id: '724' + supplierName: Vendor A.A.A + purchaseOrderRefs: [] + issueDate: '2021-03-26T00:00:00' + dueDate: '2021-03-26T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 120 + quantity: 1 + unitOfMeasurement: litre + subTotal: 120 + totalAmount: 120 + accountRef: + id: '716' + name: Inventory In Transit + trackingCategoryRefs: + - id: location-4 + name: Europe + tracking: + categoryRefs: + - id: location-4 + name: Europe + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 120 + taxAmount: 24 + totalAmount: 144 + amountDue: 24 + modifiedDate: '2023-01-30T14:47:34Z' + sourceModifiedDate: '2022-07-05T13:38:10' + paymentAllocations: + - payment: + id: '112' + reference: 'Bill Payment #1' + accountRef: + id: '825' + name: Codat Europe Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2021-03-26T00:00:00' + totalAmount: 120 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -120 + - id: '165372' + supplierRef: + id: '724' + supplierName: Vendor A.A.A + purchaseOrderRefs: [] + issueDate: '2022-07-15T00:00:00' + dueDate: '2022-07-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 555.78 + quantity: 1 + subTotal: 555.78 + totalAmount: 555.78 + accountRef: + id: '844' + name: Asset account test 2 + trackingCategoryRefs: + - id: location-4 + name: Europe + tracking: + categoryRefs: + - id: location-4 + name: Europe + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 555.78 + taxAmount: 0 + totalAmount: 555.78 + amountDue: 500 + modifiedDate: '2023-01-30T14:47:34Z' + sourceModifiedDate: '2022-07-15T11:35:47' + paymentAllocations: + - payment: + id: '165373' + reference: 'Bill Payment #2' + accountRef: + id: '825' + name: Codat Europe Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2022-07-15T00:00:00' + totalAmount: 555.78 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -55.78 + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/bills?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/bills + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/bills?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 3691-1071520776 + reference: '3847498' + supplierRef: + id: B0000-933272656 + supplierName: Patton Hardware Supplies + purchaseOrderRefs: + - id: 3684-1071520443 + purchaseOrderNumber: '6225' + issueDate: '2022-12-02T00:00:00' + dueDate: '2024-01-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: |- + Cabinets:Light Pine - Light pine kitchen cabinet wall unit + #CLD- 1235-p + unitAmount: 1500 + quantity: 5 + discountAmount: 0 + subTotal: 7500 + taxAmount: 0 + totalAmount: 7500 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 110000-933272656 + name: 'Cabinets:Light Pine' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + - description: 'Hardware:Doorknobs Std - Doorknobs Part # DK 3704' + unitAmount: 27 + quantity: 100 + discountAmount: 0 + subTotal: 2700 + taxAmount: 0 + totalAmount: 2700 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 130000-933272656 + name: 'Hardware:Doorknobs Std' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + - description: 'Hardware:Lk Doorknobs - Locking interior doorknobs Part # DK415' + unitAmount: 34.95 + quantity: 100 + discountAmount: 0 + subTotal: 3495 + taxAmount: 0 + totalAmount: 3495 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 140000-933272656 + name: 'Hardware:Lk Doorknobs' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 13695 + taxAmount: 0 + totalAmount: 13695 + amountDue: 0 + modifiedDate: '2023-04-26T09:06:42Z' + sourceModifiedDate: '2023-12-16T05:06:30' + paymentAllocations: + - payment: + id: 9E4C-1182131999 + reference: '115' + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-31T00:00:00' + totalAmount: 13759 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8695 + - payment: + id: 36AD-1071520917 + note: RC 93 + reference: '484' + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2024-12-05T00:00:00' + totalAmount: 5325 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5000 + metadata: + isDeleted: false + - id: 5CAB-1197713763 + reference: '8374892' + supplierRef: + id: 30000-933272656 + supplierName: C. U. Electric + purchaseOrderRefs: [] + issueDate: '2022-12-15T00:00:00' + dueDate: '2024-01-14T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 532 + quantity: 1 + discountAmount: 0 + subTotal: 532 + taxAmount: 0 + totalAmount: 532 + discountPercentage: 0 + accountRef: + id: 490000-933270542 + name: Gas and Electric + trackingCategoryRefs: + - id: 80000007-1197713802 + name: Overhead + tracking: + categoryRefs: + - id: 80000007-1197713802 + name: Overhead + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 532 + taxAmount: 0 + totalAmount: 532 + amountDue: 0 + modifiedDate: '2023-04-26T09:06:42Z' + sourceModifiedDate: '2023-12-16T05:06:30' + paymentAllocations: + - payment: + id: 9E42-1182131999 + reference: '113' + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-31T00:00:00' + totalAmount: 532 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -532 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 239 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/bills?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/bills + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/bills?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '18' + reference: '12' + supplierRef: + id: '4' + supplierName: BILLy elliot + purchaseOrderRefs: [] + issueDate: '2019-05-13T00:00:00' + dueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 5 + quantity: 1 + discountAmount: 0 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + amountDue: 0 + modifiedDate: '2023-01-18T11:02:41Z' + sourceModifiedDate: '2022-05-26T10:34:10Z' + paymentAllocations: + - payment: + id: '20' + currency: GBP + currencyRate: 1 + paidOnDate: '2019-05-13T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - id: '22' + reference: '12' + supplierRef: + id: '4' + supplierName: BILLy elliot + purchaseOrderRefs: [] + issueDate: '2019-05-13T00:00:00' + dueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 5 + quantity: 1 + discountAmount: 0 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + amountDue: 0 + modifiedDate: '2023-01-18T11:02:41Z' + sourceModifiedDate: '2020-03-23T10:44:06Z' + paymentAllocations: + - payment: + id: '678' + note: payment note test + currency: GBP + currencyRate: 1 + paidOnDate: '2020-03-23T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + pageNumber: 1 + pageSize: 2 + totalResults: 147 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/bills?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/bills + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/bills?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '157' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + purchaseOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-01-16T00:00:00' + currency: HKD + currencyRate: 0.081142 + lineItems: + - description: Water bottles -- generic + unitAmount: 66.1717023 + quantity: 100 + discountAmount: 0 + subTotal: 6617.17 + taxAmount: 1323.43 + totalAmount: 7940.6 + taxRateRef: + id: 3_Bills + name: 20.0% S Bills + effectiveTaxRate: 20 + itemRef: + id: '19' + name: Water Bottles + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + customerRef: + id: '55' + companyName: Oxon Insurance - Holiday Party + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 6617.17 + taxAmount: 1323.43 + totalAmount: 7940.6 + amountDue: 0 + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2023-01-26T11:20:45Z' + paymentAllocations: + - payment: + id: '158' + reference: '1067' + accountRef: + id: '81' + name: Current + currency: HKD + currencyRate: 0.078807 + paidOnDate: '2016-01-23T00:00:00' + totalAmount: 7940.6 + allocation: + currency: HKD + currencyRate: 1 + totalAmount: -7940.6 + metadata: + isDeleted: false + - id: '28' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + purchaseOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-01-06T00:00:00' + currency: HKD + currencyRate: 0.081142 + lineItems: + - description: promotional items -- misc engraved items + unitAmount: 8.25 + quantity: 75 + discountAmount: 0 + subTotal: 618.75 + taxAmount: 123.75 + totalAmount: 742.5 + taxRateRef: + id: 3_Bills + name: 20.0% S Bills + effectiveTaxRate: 20 + itemRef: + id: '12' + name: Misc + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + customerRef: + id: '59' + companyName: Ecker Holiday event + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 618.75 + taxAmount: 123.75 + totalAmount: 742.5 + amountDue: 0 + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2016-09-13T21:19:49Z' + paymentAllocations: + - payment: + id: '159' + reference: '1068' + accountRef: + id: '81' + name: Current + currency: HKD + currencyRate: 0.078807 + paidOnDate: '2016-01-23T00:00:00' + totalAmount: 742.5 + allocation: + currency: HKD + currencyRate: 1 + totalAmount: -742.5 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 711 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/bills?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/bills + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/bills?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '45121' + reference: Order no 1 + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + purchaseOrderRefs: [] + issueDate: '2020-07-22T00:00:00Z' + dueDate: '2020-02-15T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0.5 + subTotal: 0 + taxAmount: 20 + totalAmount: 20 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 2.5 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 100 + taxAmount: 20 + totalAmount: 120 + amountDue: 120 + modifiedDate: '2022-10-14T09:36:01Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: No1 + paymentAllocations: [] + - id: '45131' + reference: Order 2 + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + purchaseOrderRefs: [] + issueDate: '2020-07-22T00:00:00Z' + dueDate: '2020-03-01T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0 + subTotal: 0 + taxAmount: 31.6 + totalAmount: 31.6 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 0 + subTotal: 158 + taxAmount: 0 + totalAmount: 158 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 158 + taxAmount: 31.6 + totalAmount: 189.6 + amountDue: 179.1 + modifiedDate: '2022-10-14T09:36:01Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: No2 + paymentAllocations: + - payment: + id: '45391' + note: ret1 + reference: Return 1 + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 10.5 + pageNumber: 1 + pageSize: 2 + totalResults: 162 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/bills?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/bills + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/bills?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '92' + reference: '2569' + supplierRef: + id: THO001 + supplierName: Thompsons Electricals + purchaseOrderRefs: [] + issueDate: '2021-01-01T00:00:00' + dueDate: '2022-01-31T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Goods + unitAmount: 5875 + quantity: 1 + subTotal: 5000 + taxAmount: 875 + totalAmount: 5875 + accountRef: + id: '5000' + name: Materials Purchased + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_7 + name: Workshop + tracking: + categoryRefs: + - id: department_7 + name: Workshop + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 5000 + taxAmount: 875 + totalAmount: 5875 + amountDue: 0 + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: Goods + paymentAllocations: + - payment: + id: '260' + note: 'Purchase payment 260 linked to, purchase invoice 11, purchase invoice 18, purchase invoice 92, purchase invoice 93.' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 7141.98 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5875 + metadata: + isDeleted: false + - id: '93' + reference: '2570' + supplierRef: + id: THO001 + supplierName: Thompsons Electricals + purchaseOrderRefs: [] + issueDate: '2021-01-15T00:00:00' + dueDate: '2022-02-14T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Goods + unitAmount: 1175 + quantity: 1 + subTotal: 1000 + taxAmount: 175 + totalAmount: 1175 + accountRef: + id: '5000' + name: Materials Purchased + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_7 + name: Workshop + tracking: + categoryRefs: + - id: department_7 + name: Workshop + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 1000 + taxAmount: 175 + totalAmount: 1175 + amountDue: 0 + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: Goods + paymentAllocations: + - payment: + id: '260' + note: 'Purchase payment 260 linked to, purchase invoice 11, purchase invoice 18, purchase invoice 92, purchase invoice 93.' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 7141.98 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1175 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 95 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/bills?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/bills + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/bills?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 15a7a15773b011e8aaa5027d54329956 + reference: 19/06/2018 - 435.60 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + purchaseOrderRefs: [] + issueDate: '2018-06-19T00:00:00' + dueDate: '2018-07-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 11 + quantity: 33 + subTotal: 363 + taxAmount: 72.6 + totalAmount: 435.6 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 363 + taxAmount: 72.6 + totalAmount: 435.6 + amountDue: 405.6 + modifiedDate: '2022-10-24T14:56:08Z' + sourceModifiedDate: '2020-02-05T15:19:28Z' + paymentAllocations: + - payment: + id: f11134e299cb4456be096265136a7770 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: e3e35dcda09642ca8880fc603b0a98e9 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: d9b643b9d6e149f4b443cbc6f22fe1dd + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: cbff2fed2f1641b7bee59f5dd68d29a1 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: 3c3ed62353cf4d148352a14027738dbe + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: 332e402b9d4b4614af82594d186f5f29 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - id: 09034445789211e8aaa5027d54329956 + reference: '25/06/2018 - 1,000.00' + supplierRef: + id: ec716559789111e8aaa5027d54329956 + supplierName: Bagels Limited + purchaseOrderRefs: [] + issueDate: '2018-06-25T00:00:00' + dueDate: '2018-07-25T00:00:00' + currency: USD + currencyRate: 0.752601305 + lineItems: + - description: Bagels + unitAmount: 1000 + quantity: 1 + subTotal: 1000 + taxAmount: 0 + totalAmount: 1000 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + taxRateRef: + id: GB_ZERO + name: Zero Rated 0.00% + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 1000 + taxAmount: 0 + totalAmount: 1000 + amountDue: 0 + modifiedDate: '2022-10-24T14:56:08Z' + sourceModifiedDate: '2022-02-22T13:48:56Z' + paymentAllocations: + - payment: + id: 66d010243e3441ba89a793446eb9c74b + note: Supplier payment using credit/debit card - Test note + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: USD + currencyRate: 0.734679838 + paidOnDate: '2022-02-16T00:00:00' + totalAmount: 1000 + allocation: + currency: USD + currencyRate: 1 + totalAmount: -1000 + pageNumber: 1 + pageSize: 2 + totalResults: 4658 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/bills?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/bills + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/bills?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '4470' + reference: test + supplierRef: + id: '3' + supplierName: ADP + purchaseOrderRefs: [] + issueDate: '2021-10-19T00:00:00' + dueDate: '2021-10-29T00:00:00' + currency: GBP + lineItems: + - unitAmount: 25 + quantity: 1 + subTotal: 25 + taxAmount: 0 + totalAmount: 25 + accountRef: + id: '3' + name: Accounts Payable + taxRateRef: + id: '82' + name: UK Purchase Goods Zero Rate + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + tracking: + categoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 25 + taxAmount: 0 + totalAmount: 25 + amountDue: 0 + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2022-02-23T12:06:58' + note: '' + paymentAllocations: + - payment: + id: '4471' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2022-01-06T00:00:00' + totalAmount: 20 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -20 + - payment: + id: '4472' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2022-01-06T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + metadata: + isDeleted: false + - id: '4705' + reference: JohnAndRob + supplierRef: + id: '8' + supplierName: Worldwide Commercial + purchaseOrderRefs: [] + issueDate: '2022-02-04T00:00:00' + dueDate: '2022-02-19T00:00:00' + currency: USD + currencyRate: 14 + lineItems: + - description: Some text for a description + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: '3' + name: Accounts Payable + taxRateRef: + id: '49' + name: EC Purchase Goods Zero Rate + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + tracking: + categoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + amountDue: 10 + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2022-04-22T12:24:59' + note: Some note on my bill + paymentAllocations: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 17 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/bills?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/bills + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/bills?page=2&pageSize=2 + Xero: + value: + results: + - id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + reference: '' + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + purchaseOrderRefs: [] + issueDate: '2021-11-19T00:00:00' + dueDate: '2021-12-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Half day training - Microsoft Office + unitAmount: 1800 + quantity: 1 + discountAmount: 0 + subTotal: 1800 + taxAmount: 360 + totalAmount: 2160 + discountPercentage: 0 + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + name: Consulting + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: 489558f5-27b7-4f37-ad9f-d84611c2e2ab + name: Half day training - Microsoft Office + trackingCategoryRefs: [] + isDirectCost: false + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 4000 + quantity: 1 + discountAmount: 0 + subTotal: 4000 + taxAmount: 800 + totalAmount: 4800 + discountPercentage: 0 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: f8fb7e00-5e5d-466c-aef0-15861f73d04f + name: Desktop/network support via email & phone + trackingCategoryRefs: [] + isDirectCost: false + - description: Stationery charges + unitAmount: 32 + quantity: 8 + discountAmount: 0 + subTotal: 256 + taxAmount: 51.2 + totalAmount: 307.2 + discountPercentage: 0 + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 6056 + taxAmount: 1211.2 + totalAmount: 7267.2 + amountDue: 0 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-02T21:07:23' + paymentAllocations: + - payment: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2021-12-20T00:00:00' + totalAmount: 7267.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7267.2 + metadata: + isDeleted: false + - id: 09aa506f-cb81-4cd3-a1ea-6a0b91804d5a + reference: '' + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + purchaseOrderRefs: [] + issueDate: '2022-01-17T00:00:00' + dueDate: '2022-02-17T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Half day training - Microsoft Office + unitAmount: 1800 + quantity: 1 + discountAmount: 0 + subTotal: 1800 + taxAmount: 360 + totalAmount: 2160 + discountPercentage: 0 + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + name: Consulting + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: 489558f5-27b7-4f37-ad9f-d84611c2e2ab + name: Half day training - Microsoft Office + trackingCategoryRefs: [] + isDirectCost: false + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 4000 + quantity: 1 + discountAmount: 0 + subTotal: 4000 + taxAmount: 800 + totalAmount: 4800 + discountPercentage: 0 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: f8fb7e00-5e5d-466c-aef0-15861f73d04f + name: Desktop/network support via email & phone + trackingCategoryRefs: [] + isDirectCost: false + - description: Stationery charges + unitAmount: 32 + quantity: 8 + discountAmount: 0 + subTotal: 256 + taxAmount: 51.2 + totalAmount: 307.2 + discountPercentage: 0 + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 6056 + taxAmount: 1211.2 + totalAmount: 7267.2 + amountDue: 0 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-02T21:06:22' + paymentAllocations: + - payment: + id: f2062172-b444-4c8b-b797-9f4c7a4244c7 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-17T00:00:00' + totalAmount: 7267.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7267.2 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 44 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/bills?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/bills + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/bills?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000152027' + reference: '1' + supplierRef: + id: '104957000000152001' + supplierName: Mr. P N + purchaseOrderRefs: [] + issueDate: '2020-06-23T00:00:00' + dueDate: '2020-06-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + withholdingTax: [] + status: Paid + subTotal: 0 + taxAmount: 0 + totalAmount: 10 + amountDue: 0 + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-06-23T13:47:17' + paymentAllocations: [] + - id: '104957000000152067' + reference: '2' + supplierRef: + id: '104957000000152001' + supplierName: Mr. P N + purchaseOrderRefs: [] + issueDate: '2020-06-23T00:00:00' + dueDate: '2020-06-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + withholdingTax: [] + status: Paid + subTotal: 0 + taxAmount: 0 + totalAmount: 12 + amountDue: 0 + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-11-04T13:07:23' + paymentAllocations: [] + pageNumber: 1 + pageSize: 2 + totalResults: 36 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/bills?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/bills + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/bills?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *List bills* endpoint returns a list of [bills](https://docs.codat.io/lending-api#/schemas/Bill) for a given company's connection. + + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + ### Tips and traps + + To access the `paymentAllocations` property, ensure that the `billPayments` data type is queued and cached in Codat before retrieving `bills` from Codat's cache. + operationId: list-accounting-bills + x-speakeasy-group: accounts-payable.bills + '/companies/{companyId}/data/bills/{billId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/accountingBillId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBill' + examples: + Clear Books: + value: + id: 81539597-e681-40c9-a4dd-ec2fffcde572 + reference: b465a2c9-3212-4620-889b-6328ba148215 + supplierRef: + id: 8GeHBdBZiZ + supplierName: 'DuBuque, Goyette and Franecki' + purchaseOrderRefs: [] + issueDate: '2022-04-29T00:00:00' + dueDate: '2022-05-06T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Grease Trap + unitAmount: 2781.94 + quantity: 5 + discountAmount: 0 + subTotal: 13909.7 + taxAmount: 1390.97 + totalAmount: 15300.67 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 5 + discountAmount: 0 + subTotal: 6856.95 + taxAmount: 685.7 + totalAmount: 7542.65 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 6 + discountAmount: 0 + subTotal: 8228.34 + taxAmount: 822.83 + totalAmount: 9051.17 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 2781.94 + quantity: 3 + discountAmount: 0 + subTotal: 8345.82 + taxAmount: 834.58 + totalAmount: 9180.4 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Trapped Road Gully 450mm x 450mm + unitAmount: 402.89 + quantity: 8 + discountAmount: 0 + subTotal: 3223.12 + taxAmount: 322.31 + totalAmount: 3545.43 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + name: Heavy Duty Hinged Gully Grating + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 7 + discountAmount: 0 + subTotal: 665.56 + taxAmount: 66.56 + totalAmount: 732.12 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 1 + discountAmount: 0 + subTotal: 95.08 + taxAmount: 9.51 + totalAmount: 104.59 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 2 + discountAmount: 0 + subTotal: 2742.78 + taxAmount: 274.28 + totalAmount: 3017.06 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 2781.94 + quantity: 1 + discountAmount: 0 + subTotal: 2781.94 + taxAmount: 278.19 + totalAmount: 3060.13 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 7 + discountAmount: 0 + subTotal: 665.56 + taxAmount: 66.56 + totalAmount: 732.12 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1251.89 + quantity: 4 + discountAmount: 0 + subTotal: 5007.56 + taxAmount: 500.76 + totalAmount: 5508.32 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 51077072-d5c3-463b-9cb4-7da2e11886f9 + name: 150 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 9 + discountAmount: 0 + subTotal: 12342.51 + taxAmount: 1234.25 + totalAmount: 13576.76 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 64864.92 + taxAmount: 6486.5 + totalAmount: 71351.42 + amountDue: 0 + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2023-02-14T17:09:02' + note: 'Bill with 12 line items, totaling 71351.42' + paymentAllocations: + - payment: + id: dcb18480-8b69-44d8-aa26-268b6a80d170 + note: Bill Payment against bill 81539597-e681-40c9-a4dd-ec2fffcde572 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-06T00:00:00' + totalAmount: 71351.42 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-06T00:00:00' + totalAmount: -71351.42 + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 4019ee2b-d05a-ed11-8c34-000d3a0d28a2-108276 + reference: '108276' + supplierRef: + id: c01217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: First Up Consultants + purchaseOrderRefs: [] + issueDate: '2019-01-01T00:00:00' + dueDate: '2019-01-01T00:00:00' + currency: GBP + lineItems: + - description: ATHENS Desk + unitAmount: 506.6 + quantity: 4 + discountAmount: 202.64 + subTotal: 1823.76 + taxAmount: 364.75 + totalAmount: 2188.51 + discountPercentage: 10 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-c81217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'ATHENS Desk / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 1823.76 + taxAmount: 364.75 + totalAmount: 2188.51 + amountDue: 2188.51 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-11-02T17:02:48Z' + note: '129148' + paymentAllocations: [] + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 1c55118b-793e-4437-9c13-4f554b9ca989 + reference: '19600006' + supplierRef: + id: 5e6f49b9-6489-4b82-83e7-291d308919bb + supplierName: Mickey Mouse + purchaseOrderRefs: [] + issueDate: '2019-12-16T00:00:00Z' + dueDate: '2019-11-09T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Cheesecake + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + accountRef: + id: 5f139759-b554-4314-862e-b9d88e5b2e1b + name: Af te dragen loonheffing + taxRateRef: + id: 84277189-ad16-456c-b501-ca31f0a483cc + name: BTW prive gebruik + effectiveTaxRate: 21 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + amountDue: 0 + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-03T15:06:02Z' + paymentAllocations: + - payment: + id: d9a2980b-2a43-46f2-9c7f-413d925b3cdd + reference: '20200032' + accountRef: + id: d79d65bd-1d7d-4f55-95d3-76b3a7b7b823 + name: Bank 1 + currency: EUR + currencyRate: 1 + paidOnDate: '2021-03-22T00:00:00' + totalAmount: 12.1 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -12.1 + Exact (UK): + value: + id: e7a45898-2db3-424c-acb9-a51647740f26 + reference: '17600002' + supplierRef: + id: a7cad20d-44db-442b-ac1f-90475802d6fb + supplierName: Pencils Pencils Pencils + purchaseOrderRefs: [] + issueDate: '2017-09-26T00:00:00Z' + dueDate: '2017-10-26T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Stationery + unitAmount: 400 + quantity: 2 + discountAmount: 0 + subTotal: 800 + taxAmount: 160 + totalAmount: 960 + accountRef: + id: e5e9e994-0f14-4614-b162-7b5593b21276 + name: Finished Goods Stock + taxRateRef: + id: 63cd143a-66ab-4320-8a6d-ab6be85ed048 + name: UK purchases standard rate � Excluding + effectiveTaxRate: 20 + itemRef: + id: '001' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 800 + taxAmount: 160 + totalAmount: 960 + amountDue: 0 + modifiedDate: '2022-10-26T13:33:20Z' + sourceModifiedDate: '2019-01-11T14:18:17Z' + paymentAllocations: + - payment: + id: 7a5f621b-739f-4ed8-b738-2aae3ef886ac + reference: '17200006' + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2017-10-11T00:00:00' + totalAmount: 123 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -123 + FreeAgent: + value: + id: '16609552' + reference: MATT - U + supplierRef: + id: '7169654' + supplierName: The Eagle + purchaseOrderRefs: [] + issueDate: '2014-08-21T00:00:00' + dueDate: '2018-09-20T00:00:00' + currency: GBP + lineItems: + - unitAmount: 125 + quantity: 1 + taxAmount: 25 + totalAmount: 150 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 125 + taxAmount: 25 + totalAmount: 150 + amountDue: 150 + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2020-11-11T12:48:55Z' + paymentAllocations: [] + metadata: + isDeleted: false + FreshBooks: + value: + id: '27' + supplierRef: + id: '87' + purchaseOrderRefs: [] + issueDate: '2021-04-26T00:00:00' + dueDate: '2021-05-26T00:00:00' + currency: USD + lineItems: + - description: Grocery + unitAmount: 50 + quantity: 1 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + accountRef: + id: '3384197' + name: Advertising + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + amountDue: 50 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-04-26T19:34:22' + paymentAllocations: [] + metadata: + isDeleted: false + KashFlow: + value: + id: '97615244' + reference: '25' + supplierRef: + id: '9272052' + supplierName: Supplier man + purchaseOrderRefs: [] + issueDate: '2000-01-01T00:00:00' + dueDate: '2000-01-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 8.33 + quantity: 1 + subTotal: 8.33 + taxAmount: 1.67 + totalAmount: 10 + accountRef: + id: '21481884' + name: Computer equipment cost + itemRef: + id: '122990246' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 8.33 + taxAmount: 1.67 + totalAmount: 10 + amountDue: 0 + modifiedDate: '2022-09-30T10:29:15Z' + paymentAllocations: [] + Oracle NetSuite: + value: + id: '7' + supplierRef: + id: '724' + supplierName: Vendor A.A.A + purchaseOrderRefs: [] + issueDate: '2021-03-26T00:00:00' + dueDate: '2021-03-26T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 120 + quantity: 1 + unitOfMeasurement: litre + subTotal: 120 + totalAmount: 120 + accountRef: + id: '716' + name: Inventory In Transit + trackingCategoryRefs: + - id: location-4 + name: Europe + tracking: + categoryRefs: + - id: location-4 + name: Europe + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 120 + taxAmount: 24 + totalAmount: 144 + amountDue: 24 + modifiedDate: '2023-01-30T14:47:34Z' + sourceModifiedDate: '2022-07-05T13:38:10' + paymentAllocations: + - payment: + id: '112' + reference: 'Bill Payment #1' + accountRef: + id: '825' + name: Codat Europe Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2021-03-26T00:00:00' + totalAmount: 120 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -120 + QuickBooks Desktop: + value: + id: 3691-1071520776 + reference: '3847498' + supplierRef: + id: B0000-933272656 + supplierName: Patton Hardware Supplies + purchaseOrderRefs: + - id: 3684-1071520443 + purchaseOrderNumber: '6225' + issueDate: '2022-12-02T00:00:00' + dueDate: '2024-01-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: |- + Cabinets:Light Pine - Light pine kitchen cabinet wall unit + #CLD- 1235-p + unitAmount: 1500 + quantity: 5 + discountAmount: 0 + subTotal: 7500 + taxAmount: 0 + totalAmount: 7500 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 110000-933272656 + name: 'Cabinets:Light Pine' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + - description: 'Hardware:Doorknobs Std - Doorknobs Part # DK 3704' + unitAmount: 27 + quantity: 100 + discountAmount: 0 + subTotal: 2700 + taxAmount: 0 + totalAmount: 2700 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 130000-933272656 + name: 'Hardware:Doorknobs Std' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + - description: 'Hardware:Lk Doorknobs - Locking interior doorknobs Part # DK415' + unitAmount: 34.95 + quantity: 100 + discountAmount: 0 + subTotal: 3495 + taxAmount: 0 + totalAmount: 3495 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 140000-933272656 + name: 'Hardware:Lk Doorknobs' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 13695 + taxAmount: 0 + totalAmount: 13695 + amountDue: 0 + modifiedDate: '2023-04-26T09:06:42Z' + sourceModifiedDate: '2023-12-16T05:06:30' + paymentAllocations: + - payment: + id: 36AD-1071520917 + note: RC 93 + reference: '484' + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2024-12-05T00:00:00' + totalAmount: 5325 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5000 + - payment: + id: 9E4C-1182131999 + reference: '115' + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-31T00:00:00' + totalAmount: 13759 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8695 + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '18' + reference: '12' + supplierRef: + id: '4' + supplierName: BILLy elliot + purchaseOrderRefs: [] + issueDate: '2019-05-13T00:00:00' + dueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 5 + quantity: 1 + discountAmount: 0 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + amountDue: 0 + modifiedDate: '2023-01-18T11:02:41Z' + sourceModifiedDate: '2022-05-26T10:34:10Z' + paymentAllocations: + - payment: + id: '20' + currency: GBP + currencyRate: 1 + paidOnDate: '2019-05-13T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + QuickBooks Online Sandbox: + value: + id: '157' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + purchaseOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-01-16T00:00:00' + currency: HKD + currencyRate: 0.081142 + lineItems: + - description: Water bottles -- generic + unitAmount: 66.1717023 + quantity: 100 + discountAmount: 0 + subTotal: 6617.17 + taxAmount: 1323.43 + totalAmount: 7940.6 + taxRateRef: + id: 3_Bills + name: 20.0% S Bills + effectiveTaxRate: 20 + itemRef: + id: '19' + name: Water Bottles + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + customerRef: + id: '55' + companyName: Oxon Insurance - Holiday Party + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 6617.17 + taxAmount: 1323.43 + totalAmount: 7940.6 + amountDue: 0 + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2023-01-26T11:20:45Z' + paymentAllocations: + - payment: + id: '158' + reference: '1067' + accountRef: + id: '81' + name: Current + currency: HKD + currencyRate: 0.078807 + paidOnDate: '2016-01-23T00:00:00' + totalAmount: 7940.6 + allocation: + currency: HKD + currencyRate: 1 + totalAmount: -7940.6 + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '45121' + reference: Order no 1 + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + purchaseOrderRefs: [] + issueDate: '2020-07-22T00:00:00Z' + dueDate: '2020-02-15T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0.5 + subTotal: 0 + taxAmount: 20 + totalAmount: 20 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 2.5 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 100 + taxAmount: 20 + totalAmount: 120 + amountDue: 120 + modifiedDate: '2022-10-14T09:36:01Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: No1 + paymentAllocations: [] + Sage 50 (UK): + value: + id: '92' + reference: '2569' + supplierRef: + id: THO001 + supplierName: Thompsons Electricals + purchaseOrderRefs: [] + issueDate: '2021-01-01T00:00:00' + dueDate: '2022-01-31T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Goods + unitAmount: 5875 + quantity: 1 + subTotal: 5000 + taxAmount: 875 + totalAmount: 5875 + accountRef: + id: '5000' + name: Materials Purchased + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_7 + name: Workshop + tracking: + categoryRefs: + - id: department_7 + name: Workshop + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 5000 + taxAmount: 875 + totalAmount: 5875 + amountDue: 0 + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: Goods + paymentAllocations: + - payment: + id: '260' + note: 'Purchase payment 260 linked to, purchase invoice 11, purchase invoice 18, purchase invoice 92, purchase invoice 93.' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 7141.98 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5875 + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: 15a7a15773b011e8aaa5027d54329956 + reference: 19/06/2018 - 435.60 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + purchaseOrderRefs: [] + issueDate: '2018-06-19T00:00:00' + dueDate: '2018-07-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 11 + quantity: 33 + subTotal: 363 + taxAmount: 72.6 + totalAmount: 435.6 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 363 + taxAmount: 72.6 + totalAmount: 435.6 + amountDue: 405.6 + modifiedDate: '2022-10-24T14:56:08Z' + sourceModifiedDate: '2020-02-05T15:19:28Z' + paymentAllocations: + - payment: + id: 332e402b9d4b4614af82594d186f5f29 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: 3c3ed62353cf4d148352a14027738dbe + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: cbff2fed2f1641b7bee59f5dd68d29a1 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: d9b643b9d6e149f4b443cbc6f22fe1dd + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: e3e35dcda09642ca8880fc603b0a98e9 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: f11134e299cb4456be096265136a7770 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + Sage Intacct: + value: + id: '4470' + reference: test + supplierRef: + id: '3' + supplierName: ADP + purchaseOrderRefs: [] + issueDate: '2021-10-19T00:00:00' + dueDate: '2021-10-29T00:00:00' + currency: GBP + lineItems: + - unitAmount: 25 + quantity: 1 + subTotal: 25 + taxAmount: 0 + totalAmount: 25 + accountRef: + id: '3' + name: Accounts Payable + taxRateRef: + id: '82' + name: UK Purchase Goods Zero Rate + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + tracking: + categoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 25 + taxAmount: 0 + totalAmount: 25 + amountDue: 0 + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2022-02-23T12:06:58' + note: '' + paymentAllocations: + - payment: + id: '4472' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2022-01-06T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: '4471' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2022-01-06T00:00:00' + totalAmount: 20 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -20 + metadata: + isDeleted: false + Xero: + value: + id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + reference: '' + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + purchaseOrderRefs: [] + issueDate: '2021-11-19T00:00:00' + dueDate: '2021-12-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Half day training - Microsoft Office + unitAmount: 1800 + quantity: 1 + discountAmount: 0 + subTotal: 1800 + taxAmount: 360 + totalAmount: 2160 + discountPercentage: 0 + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + name: Consulting + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: 489558f5-27b7-4f37-ad9f-d84611c2e2ab + name: Half day training - Microsoft Office + trackingCategoryRefs: [] + isDirectCost: false + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 4000 + quantity: 1 + discountAmount: 0 + subTotal: 4000 + taxAmount: 800 + totalAmount: 4800 + discountPercentage: 0 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: f8fb7e00-5e5d-466c-aef0-15861f73d04f + name: Desktop/network support via email & phone + trackingCategoryRefs: [] + isDirectCost: false + - description: Stationery charges + unitAmount: 32 + quantity: 8 + discountAmount: 0 + subTotal: 256 + taxAmount: 51.2 + totalAmount: 307.2 + discountPercentage: 0 + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 6056 + taxAmount: 1211.2 + totalAmount: 7267.2 + amountDue: 0 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-02T21:07:23' + paymentAllocations: + - payment: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2021-12-20T00:00:00' + totalAmount: 7267.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7267.2 + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000152027' + reference: '1' + supplierRef: + id: '104957000000152001' + supplierName: Mr. P N + purchaseOrderRefs: [] + issueDate: '2020-06-23T00:00:00' + dueDate: '2020-06-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + withholdingTax: [] + status: Paid + subTotal: 0 + taxAmount: 0 + totalAmount: 10 + amountDue: 0 + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-06-23T13:47:17' + paymentAllocations: [] + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get bill + description: | + The *Get bill* endpoint returns a single bill for a given billId. + + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + ### Tips and traps + + To access the `paymentAllocations` property, ensure that the `billPayments` data type is queued and cached in Codat before retrieving `bills` from Codat's cache. + operationId: get-accounting-bill + x-speakeasy-group: accounts-payable.bills + '/companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingBillId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: list-accounting-bill-attachments + x-speakeasy-group: accounts-payable.bills + summary: List bill attachments + description: | + The *List bill attachments* endpoint returns a list of attachments available to download for a given `billId`. + + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + '/companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingBillId' + get: + tags: + - Accounts payable + parameters: + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get bill attachment + description: |- + The *Get bill attachment* endpoint returns a specific attachment for a given `billId` and `attachmentId`. + + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + operationId: get-accounting-bill-attachment + x-speakeasy-group: accounts-payable.bills + '/companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingBillId' + get: + tags: + - Accounts payable + parameters: + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Download bill attachment + description: |- + The *Download bill attachment* endpoint downloads a specific attachment for a given `billId` and `attachmentId`. + + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + operationId: download-accounting-bill-attachment + x-speakeasy-group: accounts-payable.bills + '/companies/{companyId}/data/creditNotes': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + summary: List credit notes + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreditNotes' + examples: + Dynamics 365 Business Central: + value: + results: + - id: e6e5ec0f-1c60-eb11-89fa-00224800a9c7 + creditNoteNumber: '104001' + customerRef: + id: 8ddfa6bf-0c60-eb11-89fa-00224800af18 + companyName: Abdi Company + withholdingTax: [] + totalAmount: 105 + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 5 + discountPercentage: 0 + remainingCredit: 80 + status: PartiallyPaid + issueDate: '2021-01-25T00:00:00' + currency: GBP + lineItems: + - description: 'Invoice No. 103221:' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Linda Martin + unitAmount: 100 + quantity: 1 + discountAmount: 0 + subTotal: 100 + taxAmount: 5 + totalAmount: 105 + accountRef: + id: 161217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 'Income, Services' + discountPercentage: 0 + taxRateRef: + id: 61bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / REDUCED + effectiveTaxRate: 5 + itemRef: + id: RESC-331317b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'Linda Martin / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectIncome: false + - description: Credit memo for partially paid inv + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 62e5046d-1c60-eb11-89fa-00224800a9c7 + note: Credit Memo 1001 + reference: 'Document No: 104001' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-25T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-25T00:00:00' + totalAmount: 25 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2021-01-26T21:21:18Z' + metadata: + isDeleted: false + - id: d0d9b378-1d60-eb11-89fa-00224800a9c7 + creditNoteNumber: '104002' + customerRef: + id: 8ddfa6bf-0c60-eb11-89fa-00224800af18 + companyName: Abdi Company + withholdingTax: [] + totalAmount: 779.28 + totalDiscount: 0 + subTotal: 649.4 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 129.88 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2021-01-26T00:00:00' + currency: GBP + lineItems: + - description: 'Invoice No. 103222:' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: 'Inv. No. 103222 - Shpt. No. 102222:' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: ATHENS Desk -pay with CR + unitAmount: 649.4 + quantity: 1 + discountAmount: 0 + subTotal: 649.4 + taxAmount: 129.88 + totalAmount: 779.28 + accountRef: + id: 181217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 'Income, Product Sales' + discountPercentage: 0 + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-c81217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'ATHENS Desk / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectIncome: false + - description: '' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: c2942210-1e60-eb11-89fa-00224800a9c7 + note: Credit Memo 1002 + reference: 'Document No: 104002' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-26T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-26T00:00:00' + totalAmount: 779.28 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2021-01-26T21:33:01Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 13 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/creditNotes + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/creditNotes?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '21952211' + creditNoteNumber: '004' + customerRef: + id: '6162023' + companyName: Alderley plc + withholdingTax: [] + totalAmount: 165 + totalDiscount: 0 + subTotal: 165 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-10-18T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Reverse 6546 + unitAmount: 110 + quantity: 1.5 + subTotal: 165 + taxAmount: 0 + totalAmount: 165 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '270764400' + note: �165.00 - Credit Note refund against 004 + currency: GBP + paidOnDate: '2020-12-23T00:00:00' + totalAmount: -165 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 165 + modifiedDate: '2023-04-25T14:19:09Z' + sourceModifiedDate: '2020-12-23T16:39:23Z' + metadata: + isDeleted: false + - id: '53604300' + creditNoteNumber: '2367' + customerRef: + id: '6162023' + companyName: Alderley plc + withholdingTax: [] + totalAmount: 165 + totalDiscount: 0 + subTotal: 165 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 165 + status: Draft + issueDate: '2017-10-18T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Reverse 6546 + unitAmount: 110 + quantity: 1.5 + subTotal: 165 + taxAmount: 0 + totalAmount: 165 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2023-04-25T14:19:09Z' + sourceModifiedDate: '2022-09-29T13:00:09Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 281 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/creditNotes + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/creditNotes?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '33407' + creditNoteNumber: '0000065' + customerRef: + id: '511657' + companyName: Bob's Stationary + withholdingTax: [] + totalAmount: 150 + totalDiscount: 0 + subTotal: 150 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Submitted + issueDate: '2020-07-31T00:00:00' + currency: GBP + lineItems: + - description: Test Di + unitAmount: 150 + quantity: 1 + subTotal: 150 + taxAmount: 0 + totalAmount: 150 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '2054019' + note: Free $150 voucher + currency: GBP + paidOnDate: '2020-07-31T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 150 + modifiedDate: '2023-03-24T16:07:23Z' + note: Free $150 voucher + metadata: + isDeleted: false + - id: '33409' + creditNoteNumber: '0000066' + customerRef: + id: '511657' + companyName: Bob's Stationary + withholdingTax: [] + totalAmount: 300 + totalDiscount: 0 + subTotal: 300 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Draft + issueDate: '2020-07-31T00:00:00' + currency: GBP + lineItems: + - description: Test Di + unitAmount: 150 + quantity: 2 + subTotal: 300 + taxAmount: 0 + totalAmount: 300 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '2054021' + note: Free $150 voucher + currency: GBP + paidOnDate: '2020-07-31T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 300 + modifiedDate: '2023-03-24T16:07:23Z' + note: Free $150 voucher + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 53 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/creditNotes + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/creditNotes?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '85322315' + creditNoteNumber: '4' + customerRef: + id: '69946501' + companyName: Peter Lord + withholdingTax: [] + totalAmount: 100 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-05-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: youm + unitAmount: 100 + quantity: -1 + subTotal: -100 + taxAmount: 0 + totalAmount: 100 + accountRef: + id: '21481817' + name: Sale of goods + itemRef: + id: '158667064' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '86870120' + note: Applying Credit Note + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -100 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 100 + modifiedDate: '2022-09-30T10:29:16Z' + - id: '85326016' + creditNoteNumber: '5' + customerRef: + id: '69952389' + companyName: Things Limited + withholdingTax: [] + totalAmount: 1000 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-05-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '158675173' + unitAmount: 1 + quantity: -1000 + subTotal: -1000 + taxAmount: 0 + totalAmount: 1000 + accountRef: + id: '21481817' + name: Sale of goods + itemRef: + id: '158675173' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '86873915' + note: Applying Credit Note + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -400 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 400 + - payment: + id: '86874181' + note: '' + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -100 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 100 + - payment: + id: '86874199' + note: '' + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -50 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 50 + - payment: + id: '86875655' + note: Credit Note + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -750 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 750 + modifiedDate: '2022-09-30T10:29:16Z' + pageNumber: 1 + pageSize: 2 + totalResults: 17 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/creditNotes + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/creditNotes?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '8827' + creditNoteNumber: CM27 + customerRef: + id: '417' + companyName: 10 Breww Ltd + withholdingTax: [] + totalAmount: 26 + totalDiscount: 0 + subTotal: 26 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 26 + status: Submitted + issueDate: '2021-04-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Andy Test Item + unitAmount: 2 + quantity: 3 + subTotal: 6 + totalAmount: 6 + accountRef: + id: '54' + name: Sales + itemRef: + id: '143' + name: Andy Test Item + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + - description: Non-Recurring Services - EC + unitAmount: 4 + quantity: 5 + subTotal: 20 + totalAmount: 20 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2022-09-20T08:15:31Z' + sourceModifiedDate: '2022-02-25T10:58:10' + - id: '8828' + creditNoteNumber: CM28 + customerRef: + id: '417' + companyName: 10 Breww Ltd + withholdingTax: [] + totalAmount: 26 + totalDiscount: 0 + subTotal: 26 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 10 + status: PartiallyPaid + issueDate: '2021-04-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Andy Test Item + unitAmount: 2 + quantity: 3 + subTotal: 6 + totalAmount: 6 + accountRef: + id: '54' + name: Sales + itemRef: + id: '143' + name: Andy Test Item + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + - description: Non-Recurring Services - EC + unitAmount: 4 + quantity: 5 + subTotal: 20 + totalAmount: 20 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + paymentAllocations: + - payment: + id: '8828' + reference: 'Credit Memo #CM28' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-04-09T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 16 + modifiedDate: '2022-09-20T08:15:31Z' + sourceModifiedDate: '2022-02-25T10:58:37' + pageNumber: 1 + pageSize: 2 + totalResults: 36 + _links: + current: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/creditNotes + next: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/creditNotes?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 96C-933372931 + creditNoteNumber: '4002' + customerRef: + id: 150000-933272658 + companyName: 'Abercrombie, Kristy' + withholdingTax: [] + totalAmount: 711.15 + totalDiscount: 0 + subTotal: 660 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 51.15 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2024-12-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: |- + Whirlpool tub + Billed and paid for 2 tubs, should have been for only 1 tub + unitAmount: 660 + quantity: 1 + subTotal: 660 + taxAmount: 0 + totalAmount: 660 + accountRef: + id: 40000-933270541 + name: Accounts Receivable + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1E0000-933272656 + name: Plumb Fixtrs + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + paymentAllocations: + - payment: + id: 969-933372844 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2024-12-01T00:00:00' + totalAmount: -711.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 711.15 + modifiedDate: '2023-04-26T09:07:38Z' + sourceModifiedDate: '2023-12-16T05:04:05' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/creditNotes + QuickBooks Online: + value: + results: + - id: '85' + creditNoteNumber: '3122019_6' + customerRef: + id: '3' + companyName: Information Sharing Technology + withholdingTax: [] + totalAmount: 13.53 + totalDiscount: 0 + subTotal: 13.53 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-12-03T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refunds with payment type of Cash + unitAmount: 13.53 + quantity: 1 + subTotal: 13.53 + taxAmount: 0 + totalAmount: 13.53 + accountRef: + id: '1' + name: Sales + taxRateRef: + id: 8_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + itemRef: + id: '1' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: true + paymentAllocations: + - payment: + id: '85' + note: '' + accountRef: + id: '63' + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2019-12-03T00:00:00' + totalAmount: -13.53 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-12-03T00:00:00' + totalAmount: 13.53 + modifiedDate: '2023-01-18T11:02:55Z' + sourceModifiedDate: '2019-12-10T19:00:36Z' + - id: '86' + creditNoteNumber: '3122019_66' + customerRef: + id: '3' + companyName: Information Sharing Technology + withholdingTax: [] + totalAmount: 1 + totalDiscount: 0 + subTotal: 1 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-12-03T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refunds with payment type of Card + unitAmount: 1 + quantity: 1 + subTotal: 1 + taxAmount: 0 + totalAmount: 1 + accountRef: + id: '1' + name: Sales + taxRateRef: + id: 8_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + itemRef: + id: '1' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: true + paymentAllocations: + - payment: + id: '86' + note: '' + accountRef: + id: '63' + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2019-12-03T00:00:00' + totalAmount: -1 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-12-03T00:00:00' + totalAmount: 1 + modifiedDate: '2023-01-18T11:02:55Z' + sourceModifiedDate: '2019-12-10T19:00:37Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1253 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/creditNotes + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/creditNotes?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '185' + creditNoteNumber: '1015' + customerRef: + id: '16' + companyName: Jordan Burgess + withholdingTax: [] + totalAmount: 1800 + totalDiscount: 0 + subTotal: 1500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 300 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-02-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Employee training off site + unitAmount: 1500 + quantity: 1 + subTotal: 1500 + taxAmount: 300 + totalAmount: 1800 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '5' + name: Employee Training + trackingCategoryRefs: + - id: DEPARTMENT_1 + name: London + isDirectIncome: false + paymentAllocations: + - payment: + id: '192' + note: Created by QB Online to link credits to charges. + currency: GBP + currencyRate: 1 + paidOnDate: '2017-09-08T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 1800 + modifiedDate: '2023-04-26T09:36:03Z' + sourceModifiedDate: '2017-09-08T12:52:27Z' + metadata: + isDeleted: false + - id: '213' + creditNoteNumber: '1030' + customerRef: + id: '5' + companyName: Whitehead and Sons + withholdingTax: [] + totalAmount: 600 + totalDiscount: 0 + subTotal: 500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 100 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2018-12-18T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Employee celebration -- Anniversary / Retirement + unitAmount: 500 + quantity: 1 + subTotal: 500 + taxAmount: 100 + totalAmount: 600 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '4' + name: Employee Celebration + trackingCategoryRefs: + - id: DEPARTMENT_3 + name: Birmingham + isDirectIncome: false + paymentAllocations: + - payment: + id: '215' + note: Created by QB Online to link credits to charges. + currency: GBP + currencyRate: 1 + paidOnDate: '2018-12-18T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 600 + modifiedDate: '2023-04-26T09:36:03Z' + sourceModifiedDate: '2018-12-18T10:08:45Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 141 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/creditNotes + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/creditNotes?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '45891' + creditNoteNumber: return 1a + customerRef: + id: A1D001 + companyName: A1 Design Services + withholdingTax: [] + totalAmount: 378 + totalDiscount: 9.46 + subTotal: 315 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 63 + discountPercentage: 2.5 + remainingCredit: 378 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Standard rate + unitAmount: 0 + quantity: 0 + discountAmount: 1.58 + subTotal: 0 + taxAmount: 63 + totalAmount: 63 + taxRateRef: + id: '1' + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 9.46 + subTotal: 315 + taxAmount: 0 + totalAmount: 315 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2022-10-14T09:35:55Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: black + - id: '45901' + creditNoteNumber: return 003 + customerRef: + id: ABS001 + companyName: ABS Garages Ltd + withholdingTax: [] + totalAmount: 177.14 + totalDiscount: 4.42 + subTotal: 147.62 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 29.52 + discountPercentage: 2.5 + remainingCredit: 177.14 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Standard rate + unitAmount: 0 + quantity: 0 + discountAmount: 0.73 + subTotal: 0 + taxAmount: 29.52 + totalAmount: 29.52 + taxRateRef: + id: '1' + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 4.42 + subTotal: 147.62 + taxAmount: 0 + totalAmount: 147.62 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2022-10-14T09:35:55Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: cred 003 + pageNumber: 1 + pageSize: 2 + totalResults: 26 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/creditNotes + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/creditNotes?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: INV-17 + creditNoteNumber: '17' + customerRef: + id: KIN001 + companyName: Kinghorn & French + withholdingTax: [] + totalAmount: 832.84 + totalDiscount: 0 + subTotal: 711.45 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 121.39 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2021-02-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: PC Combo Pack 4 + unitAmount: 832.84 + quantity: 1 + subTotal: 711.45 + taxAmount: 121.39 + totalAmount: 832.84 + accountRef: + id: '4000' + name: Sales North + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 63.69 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 73.49 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 157.25 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 158.25 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 344.89 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 35.27 + modifiedDate: '2023-03-30T14:42:43Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: PC Combo Pack 4 + metadata: + isDeleted: false + - id: INV-34 + creditNoteNumber: '34' + customerRef: + id: MIL001 + companyName: Mile Road Health Centre + withholdingTax: [] + totalAmount: 1668.14 + totalDiscount: 0 + subTotal: 1425 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 243.14 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2021-02-28T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: PC Combo Pack 6 + unitAmount: 1668.14 + quantity: 1 + subTotal: 1425 + taxAmount: 243.14 + totalAmount: 1668.14 + accountRef: + id: '4000' + name: Sales North + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '530' + note: Sales credit inv-34 linked to sales invoice inv-26. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-28T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 1668.14 + modifiedDate: '2023-03-30T14:42:43Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: PC Combo Pack 6 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/creditNotes + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/creditNotes?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: c1a0176c33de11e797950a57719b2edb + creditNoteNumber: SCN-1 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + withholdingTax: [] + totalAmount: 1080 + totalDiscount: 0 + subTotal: 900 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 180 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-05-08T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 1 + discountAmount: 0 + subTotal: 900 + taxAmount: 180 + totalAmount: 1080 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: d39f7a5733de11e797950a57719b2edb + note: Customer refund using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2017-05-08T00:00:00' + totalAmount: -1080 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 1080 + modifiedDate: '2022-10-24T14:55:35Z' + sourceModifiedDate: '2017-05-08T11:09:38Z' + note: '' + - id: 28a459069a6211e8bad90617b3da4b8a + creditNoteNumber: SCN-3 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + withholdingTax: [] + totalAmount: 5400 + totalDiscount: 0 + subTotal: 4500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 900 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2018-08-07T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 5 + discountAmount: 0 + subTotal: 4500 + taxAmount: 900 + totalAmount: 5400 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 28a459069a6211e8bad90617b3da4b8a + note: Sales credit note + currency: GBP + currencyRate: 1 + paidOnDate: '2018-08-07T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 5400 + modifiedDate: '2022-10-24T14:55:35Z' + sourceModifiedDate: '2018-08-07T16:51:41Z' + note: '' + pageNumber: 1 + pageSize: 2 + totalResults: 2972 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/creditNotes + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/creditNotes?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '5018' + creditNoteNumber: IN0545 + customerRef: + id: '53' + companyName: Pacificorp + withholdingTax: [] + totalAmount: 575 + totalDiscount: 0 + subTotal: 500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 75 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-03-16T00:00:00' + allocatedOnDate: '2022-03-16T00:00:00' + currency: ZAR + lineItems: + - description: No Description Provided + unitAmount: 500 + quantity: 1 + subTotal: 500 + taxAmount: 75 + totalAmount: 575 + accountRef: + id: '2' + name: Accounts Receivable + taxRateRef: + id: '27' + name: Standard Rate Output + effectiveTaxRate: 15 + trackingCategoryRefs: + - id: LOCATION-10 + name: South Africa + - id: DEPARTMENT-2 + name: Services + - id: CUSTOMER-53 + name: Pacificorp + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2023-02-23T14:21:40Z' + sourceModifiedDate: '2022-03-16T12:27:43Z' + note: '' + metadata: + isDeleted: false + - id: '5020' + creditNoteNumber: ARADJ0034 + customerRef: + id: '53' + companyName: Pacificorp + withholdingTax: [] + totalAmount: 115 + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 15 + discountPercentage: 0 + remainingCredit: 115 + status: Submitted + issueDate: '2022-03-16T00:00:00' + currency: ZAR + currencyRate: 1 + lineItems: + - description: No Description Provided + unitAmount: 100 + quantity: 1 + subTotal: 100 + taxAmount: 15 + totalAmount: 115 + accountRef: + id: '2' + name: Accounts Receivable + taxRateRef: + id: '28' + name: Standard Rate (Capital Goods) Output + effectiveTaxRate: 15 + trackingCategoryRefs: + - id: LOCATION-10 + name: South Africa + - id: CUSTOMER-53 + name: Pacificorp + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2023-02-23T14:21:40Z' + sourceModifiedDate: '2022-03-16T12:30:19' + note: '' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/data/creditNotes + Xero: + value: + results: + - id: 47fb825b-3c43-4284-905f-c6d97acc6b37 + creditNoteNumber: CN-0025 + customerRef: + id: af0091a9-82ef-4cac-9fd6-22c095ac6a58 + companyName: Hamilton Smith Ltd + withholdingTax: [] + totalAmount: 541.25 + totalDiscount: 0 + subTotal: 451.04 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 90.21 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-11-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: FULL CREDIT of INV-0016 due to duplication of invoice INV-0012. Please accept our apologies. + unitAmount: 0 + quantity: 0 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + discountPercentage: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 451.04 + quantity: 1 + discountAmount: 0 + subTotal: 451.04 + taxAmount: 90.21 + totalAmount: 541.25 + accountRef: + id: c563b607-fb0e-4d06-9ddb-76fdeef20ae3 + name: Sales + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + itemRef: + id: f8fb7e00-5e5d-466c-aef0-15861f73d04f + name: Desktop/network support via email & phone + trackingCategoryRefs: + - id: 34b9b859-07a9-451a-b4d3-effc9946634a + name: North + isDirectIncome: false + paymentAllocations: + - payment: + id: 47fb825b-3c43-4284-905f-c6d97acc6b37 + reference: Monthly Support + currency: GBP + currencyRate: 1 + paidOnDate: '2022-11-20T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-11-20T00:00:00' + totalAmount: 541.25 + modifiedDate: '2023-03-15T20:35:09Z' + sourceModifiedDate: '2011-04-07T00:34:38' + metadata: + isDeleted: false + - id: caba470e-962f-4168-9c57-35caa289204d + creditNoteNumber: CN-0026 + customerRef: + id: 9ce626d2-14ea-463c-9fff-6785ab5f9bfb + companyName: Boom FM + withholdingTax: [] + totalAmount: 500 + totalDiscount: 0 + subTotal: 416.67 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 83.33 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2023-01-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: "CREDIT Half day training - Microsoft Office and include in suite of training\r\nINV-0024" + unitAmount: 416.67 + quantity: 1 + discountAmount: 0 + subTotal: 416.67 + taxAmount: 83.33 + totalAmount: 500 + accountRef: + id: c563b607-fb0e-4d06-9ddb-76fdeef20ae3 + name: Sales + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + itemRef: + id: 489558f5-27b7-4f37-ad9f-d84611c2e2ab + name: Half day training - Microsoft Office + trackingCategoryRefs: + - id: b3900cc6-3745-40ea-955f-9ef7b1c8cf7e + name: South + isDirectIncome: false + paymentAllocations: + - payment: + id: caba470e-962f-4168-9c57-35caa289204d + reference: Training + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-13T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-01-13T00:00:00' + totalAmount: 500 + modifiedDate: '2023-03-15T20:35:09Z' + sourceModifiedDate: '2011-04-07T02:47:04' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/creditNotes + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/creditNotes?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000129002' + creditNoteNumber: CN-00001 + customerRef: + id: '104957000000037097' + companyName: Test Company + withholdingTax: [] + totalAmount: 9001 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 9001 + status: Draft + issueDate: '2020-04-28T18:16:22' + currency: GBP + lineItems: [] + paymentAllocations: [] + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-04-28T18:16:22' + - id: '104957000000134023' + creditNoteNumber: CN-00002 + customerRef: + id: '104957000000054050' + companyName: 'Doe, John' + withholdingTax: [] + totalAmount: 125 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2020-05-06T13:04:20' + currency: GBP + lineItems: [] + paymentAllocations: + - payment: + id: '104957000000134039' + currency: GBP + paidOnDate: '2020-05-06T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 125 + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-05-06T13:05:27' + pageNumber: 1 + pageSize: 2 + totalResults: 12 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/creditNotes + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/creditNotes?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List credit notes* endpoint returns a list of [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote) for a given company's connection. + + [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-credit-notes + x-speakeasy-group: accounts-receivable.credit-notes + '/companies/{companyId}/data/creditNotes/{creditNoteId}': + parameters: + - $ref: '#/components/parameters/companyId' + - name: creditNoteId + in: path + required: true + schema: + type: string + description: Unique identifier for a credit note. + get: + tags: + - Accounts receivable + summary: Get credit note + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreditNote' + examples: + Dynamics 365 Business Central: + value: + id: e6e5ec0f-1c60-eb11-89fa-00224800a9c7 + creditNoteNumber: '104001' + customerRef: + id: 8ddfa6bf-0c60-eb11-89fa-00224800af18 + companyName: Abdi Company + withholdingTax: [] + totalAmount: 105 + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 5 + discountPercentage: 0 + remainingCredit: 80 + status: PartiallyPaid + issueDate: '2021-01-25T00:00:00' + currency: GBP + lineItems: + - description: 'Invoice No. 103221:' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Linda Martin + unitAmount: 100 + quantity: 1 + discountAmount: 0 + subTotal: 100 + taxAmount: 5 + totalAmount: 105 + accountRef: + id: 161217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 'Income, Services' + discountPercentage: 0 + taxRateRef: + id: 61bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / REDUCED + effectiveTaxRate: 5 + itemRef: + id: RESC-331317b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'Linda Martin / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectIncome: false + - description: Credit memo for partially paid inv + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 62e5046d-1c60-eb11-89fa-00224800a9c7 + note: Credit Memo 1001 + reference: 'Document No: 104001' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-25T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-25T00:00:00' + totalAmount: 25 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2021-01-26T21:21:18Z' + metadata: + isDeleted: false + FreeAgent: + value: + id: '21952211' + creditNoteNumber: '004' + customerRef: + id: '6162023' + companyName: Alderley plc + withholdingTax: [] + totalAmount: 165 + totalDiscount: 0 + subTotal: 165 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-10-18T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Reverse 6546 + unitAmount: 110 + quantity: 1.5 + subTotal: 165 + taxAmount: 0 + totalAmount: 165 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '270764400' + note: �165.00 - Credit Note refund against 004 + currency: GBP + paidOnDate: '2020-12-23T00:00:00' + totalAmount: -165 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 165 + modifiedDate: '2023-04-25T14:19:09Z' + sourceModifiedDate: '2020-12-23T16:39:23Z' + metadata: + isDeleted: false + FreshBooks: + value: + id: '33407' + creditNoteNumber: '0000065' + customerRef: + id: '511657' + companyName: Bob's Stationary + withholdingTax: [] + totalAmount: 150 + totalDiscount: 0 + subTotal: 150 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Submitted + issueDate: '2020-07-31T00:00:00' + currency: GBP + lineItems: + - description: Test Di + unitAmount: 150 + quantity: 1 + subTotal: 150 + taxAmount: 0 + totalAmount: 150 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '2054019' + note: Free $150 voucher + currency: GBP + paidOnDate: '2020-07-31T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 150 + modifiedDate: '2023-03-24T16:07:23Z' + note: Free $150 voucher + metadata: + isDeleted: false + KashFlow: + value: + id: '85322315' + creditNoteNumber: '4' + customerRef: + id: '69946501' + companyName: Peter Lord + withholdingTax: [] + totalAmount: 100 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-05-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: youm + unitAmount: 100 + quantity: -1 + subTotal: -100 + taxAmount: 0 + totalAmount: 100 + accountRef: + id: '21481817' + name: Sale of goods + itemRef: + id: '158667064' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '86870120' + note: Applying Credit Note + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -100 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 100 + modifiedDate: '2022-09-30T10:29:16Z' + Oracle NetSuite: + value: + id: '8827' + creditNoteNumber: CM27 + customerRef: + id: '417' + companyName: 10 Breww Ltd + withholdingTax: [] + totalAmount: 26 + totalDiscount: 0 + subTotal: 26 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 26 + status: Submitted + issueDate: '2021-04-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Andy Test Item + unitAmount: 2 + quantity: 3 + subTotal: 6 + totalAmount: 6 + accountRef: + id: '54' + name: Sales + itemRef: + id: '143' + name: Andy Test Item + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + - description: Non-Recurring Services - EC + unitAmount: 4 + quantity: 5 + subTotal: 20 + totalAmount: 20 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2022-09-20T08:15:31Z' + sourceModifiedDate: '2022-02-25T10:58:10' + QuickBooks Desktop: + value: + id: 96C-933372931 + creditNoteNumber: '4002' + customerRef: + id: 150000-933272658 + companyName: 'Abercrombie, Kristy' + withholdingTax: [] + totalAmount: 711.15 + totalDiscount: 0 + subTotal: 660 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 51.15 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2024-12-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: |- + Whirlpool tub + Billed and paid for 2 tubs, should have been for only 1 tub + unitAmount: 660 + quantity: 1 + subTotal: 660 + taxAmount: 0 + totalAmount: 660 + accountRef: + id: 40000-933270541 + name: Accounts Receivable + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1E0000-933272656 + name: Plumb Fixtrs + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + paymentAllocations: + - payment: + id: 969-933372844 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2024-12-01T00:00:00' + totalAmount: -711.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 711.15 + modifiedDate: '2023-04-26T09:07:38Z' + sourceModifiedDate: '2023-12-16T05:04:05' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '85' + creditNoteNumber: '3122019_6' + customerRef: + id: '3' + companyName: Information Sharing Technology + withholdingTax: [] + totalAmount: 13.53 + totalDiscount: 0 + subTotal: 13.53 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-12-03T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refunds with payment type of Cash + unitAmount: 13.53 + quantity: 1 + subTotal: 13.53 + taxAmount: 0 + totalAmount: 13.53 + accountRef: + id: '1' + name: Sales + taxRateRef: + id: 8_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + itemRef: + id: '1' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: true + paymentAllocations: + - payment: + id: '85' + note: '' + accountRef: + id: '63' + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2019-12-03T00:00:00' + totalAmount: -13.53 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-12-03T00:00:00' + totalAmount: 13.53 + modifiedDate: '2023-01-18T11:02:55Z' + sourceModifiedDate: '2019-12-10T19:00:36Z' + QuickBooks Online Sandbox: + value: + id: '185' + creditNoteNumber: '1015' + customerRef: + id: '16' + companyName: Jordan Burgess + withholdingTax: [] + totalAmount: 1800 + totalDiscount: 0 + subTotal: 1500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 300 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-02-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Employee training off site + unitAmount: 1500 + quantity: 1 + subTotal: 1500 + taxAmount: 300 + totalAmount: 1800 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '5' + name: Employee Training + trackingCategoryRefs: + - id: DEPARTMENT_1 + name: London + isDirectIncome: false + paymentAllocations: + - payment: + id: '192' + note: Created by QB Online to link credits to charges. + currency: GBP + currencyRate: 1 + paidOnDate: '2017-09-08T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 1800 + modifiedDate: '2023-04-26T09:36:03Z' + sourceModifiedDate: '2017-09-08T12:52:27Z' + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '45891' + creditNoteNumber: return 1a + customerRef: + id: A1D001 + companyName: A1 Design Services + withholdingTax: [] + totalAmount: 378 + totalDiscount: 9.46 + subTotal: 315 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 63 + discountPercentage: 2.5 + remainingCredit: 378 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Standard rate + unitAmount: 0 + quantity: 0 + discountAmount: 1.58 + subTotal: 0 + taxAmount: 63 + totalAmount: 63 + taxRateRef: + id: '1' + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 9.46 + subTotal: 315 + taxAmount: 0 + totalAmount: 315 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2022-10-14T09:35:55Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: black + Sage 50 (UK): + value: + id: INV-17 + creditNoteNumber: '17' + customerRef: + id: KIN001 + companyName: Kinghorn & French + withholdingTax: [] + totalAmount: 832.84 + totalDiscount: 0 + subTotal: 711.45 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 121.39 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2021-02-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: PC Combo Pack 4 + unitAmount: 832.84 + quantity: 1 + subTotal: 711.45 + taxAmount: 121.39 + totalAmount: 832.84 + accountRef: + id: '4000' + name: Sales North + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 35.27 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 344.89 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 158.25 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 157.25 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 73.49 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 63.69 + modifiedDate: '2023-03-30T14:42:43Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: PC Combo Pack 4 + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: c1a0176c33de11e797950a57719b2edb + creditNoteNumber: SCN-1 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + withholdingTax: [] + totalAmount: 1080 + totalDiscount: 0 + subTotal: 900 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 180 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-05-08T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 1 + discountAmount: 0 + subTotal: 900 + taxAmount: 180 + totalAmount: 1080 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: d39f7a5733de11e797950a57719b2edb + note: Customer refund using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2017-05-08T00:00:00' + totalAmount: -1080 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 1080 + modifiedDate: '2022-10-24T14:55:35Z' + sourceModifiedDate: '2017-05-08T11:09:38Z' + note: '' + Sage Intacct: + value: + id: '5018' + creditNoteNumber: IN0545 + customerRef: + id: '53' + companyName: Pacificorp + withholdingTax: [] + totalAmount: 575 + totalDiscount: 0 + subTotal: 500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 75 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-03-16T00:00:00' + allocatedOnDate: '2022-03-16T00:00:00' + currency: ZAR + lineItems: + - description: No Description Provided + unitAmount: 500 + quantity: 1 + subTotal: 500 + taxAmount: 75 + totalAmount: 575 + accountRef: + id: '2' + name: Accounts Receivable + taxRateRef: + id: '27' + name: Standard Rate Output + effectiveTaxRate: 15 + trackingCategoryRefs: + - id: DEPARTMENT-2 + name: Services + - id: CUSTOMER-53 + name: Pacificorp + - id: LOCATION-10 + name: South Africa + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2023-02-23T14:21:40Z' + sourceModifiedDate: '2022-03-16T12:27:43Z' + note: '' + metadata: + isDeleted: false + Xero: + value: + id: 47fb825b-3c43-4284-905f-c6d97acc6b37 + creditNoteNumber: CN-0025 + customerRef: + id: af0091a9-82ef-4cac-9fd6-22c095ac6a58 + companyName: Hamilton Smith Ltd + withholdingTax: [] + totalAmount: 541.25 + totalDiscount: 0 + subTotal: 451.04 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 90.21 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-11-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: FULL CREDIT of INV-0016 due to duplication of invoice INV-0012. Please accept our apologies. + unitAmount: 0 + quantity: 0 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + discountPercentage: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 451.04 + quantity: 1 + discountAmount: 0 + subTotal: 451.04 + taxAmount: 90.21 + totalAmount: 541.25 + accountRef: + id: c563b607-fb0e-4d06-9ddb-76fdeef20ae3 + name: Sales + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + itemRef: + id: f8fb7e00-5e5d-466c-aef0-15861f73d04f + name: Desktop/network support via email & phone + trackingCategoryRefs: + - id: 34b9b859-07a9-451a-b4d3-effc9946634a + name: North + isDirectIncome: false + paymentAllocations: + - payment: + id: 47fb825b-3c43-4284-905f-c6d97acc6b37 + reference: Monthly Support + currency: GBP + currencyRate: 1 + paidOnDate: '2022-11-20T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-11-20T00:00:00' + totalAmount: 541.25 + modifiedDate: '2023-03-15T20:35:09Z' + sourceModifiedDate: '2011-04-07T00:34:38' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000129002' + creditNoteNumber: CN-00001 + customerRef: + id: '104957000000037097' + companyName: Test Company + withholdingTax: [] + totalAmount: 9001 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 9001 + status: Draft + issueDate: '2020-04-28T18:16:22' + currency: GBP + lineItems: [] + paymentAllocations: [] + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-04-28T18:16:22' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get credit note* endpoint returns a single credit note for a given creditNoteId. + + [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-credit-note + x-speakeasy-group: accounts-receivable.credit-notes + '/companies/{companyId}/data/customers': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + summary: List customers + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCustomers' + examples: + Clear Books: + value: + results: + - id: c8180244-74ac-40cf-a5df-6d83661c44d7 + customerName: Arjun Kuvalis + contactName: Werner Langworth + emailAddress: Arjun34@hotmail.com + defaultCurrency: GBP + phone: 014605 64820 + addresses: + - type: Delivery + line1: Suite 214 + line2: 8439 Lueilwitz Passage + city: Fernandohaven + region: Northern Ireland + country: United Kingdom + postalCode: JG04 7PV + - type: Delivery + line1: Suite 096 + line2: 864 Halie Course + city: Juliochester + region: England + country: United Kingdom + postalCode: DZ8 4BF + - type: Delivery + line1: Suite 001 + line2: 416 Stokes Fords + city: Naderborough + region: Wales + country: United Kingdom + postalCode: XG25 0XX + contacts: + - name: Werner Langworth + email: Werner_Langworth@hotmail.com + phone: [] + address: + type: Delivery + line1: Apt. 145 + line2: 317 Williamson Freeway + city: Hortenseville + region: Scotland + country: United Kingdom + postalCode: CV4 2HR + status: Active + - name: Belle Glover + email: Belle51@yahoo.com + phone: [] + address: + type: Delivery + line1: Suite 075 + line2: 9921 Dickens Walk + city: South Ali + region: Scotland + country: United Kingdom + postalCode: TI04 4OO + status: Active + registrationNumber: NI7JEJVM + taxNumber: '7505220209.583549' + status: Active + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2022-07-03T01:27:00' + metadata: + isDeleted: false + - id: 6d162ee4-47b4-46c6-a2e6-aa9edd0fe6b0 + customerName: 'Breitenberg, Emard and Schiller' + contactName: Miguel Hahn + emailAddress: contact@BreitenbergEmardandSchiller.biz + defaultCurrency: GBP + phone: 0800 445 6957 + addresses: + - type: Billing + line1: Apt. 184 + line2: 60578 Louie Springs + city: East Khalid + region: Wales + country: United Kingdom + postalCode: XW89 7NT + contacts: + - name: Miguel Hahn + email: Miguel.Hahn@gmail.com + phone: + - number: 018555 09614 + type: Landline + address: + type: Delivery + line1: Suite 400 + line2: 21930 Milan Lane + city: Reingerton + region: Wales + country: United Kingdom + postalCode: QG10 2DL + status: Active + registrationNumber: KME0AMIL + taxNumber: '8560920952.553111' + status: Archived + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2022-12-03T11:05:01' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 20 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 0e2f7751-7696-ed11-bff5-6045bd0d2ad6 + customerName: '' + contactName: '' + emailAddress: '' + defaultCurrency: GBP + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + contacts: + - name: '' + email: '' + phone: [] + address: + type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2023-01-17T14:50:54Z' + metadata: + isDeleted: false + - id: 0ef95175-48c4-eb11-9f0a-0022481b4343 + customerName: '' + contactName: '' + emailAddress: '' + defaultCurrency: GBP + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + contacts: + - name: '' + email: '' + phone: [] + address: + type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2021-06-03T08:48:36Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 42 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 555f8251-c65a-433a-a813-5dbe04321d1e + customerName: Ab Netherlands + defaultCurrency: EUR + addresses: + - type: Billing + country: NL + contacts: [] + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2021-06-14T15:26:37Z' + - id: 9fd1f78e-67aa-4af7-8a10-df1fc5fb5841 + customerName: anna test 2 + defaultCurrency: EUR + addresses: + - type: Billing + country: NL + contacts: [] + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2022-05-24T11:53:21Z' + pageNumber: 1 + pageSize: 2 + totalResults: 71 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 5f20075a-a28e-434d-81a6-2db0dc170e87 + customerName: Abdi 99 + emailAddress: email@codat.io + defaultCurrency: GBP + addresses: + - type: Billing + line1: Ink Rooms + city: London + country: GB + postalCode: WC1X 0BE + contacts: [] + registrationNumber: '123456789' + taxNumber: GB339 0727 47 + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2020-02-26T11:23:50Z' + - id: 1d9dc1a7-92d6-441b-93fd-42c9fb321b1c + customerName: Abdulbasit Al-haj + contactName: abeee + emailAddress: a.alhaj@codat.io + defaultCurrency: GBP + addresses: + - type: Billing + country: GB + contacts: + - name: abeee + phone: [] + address: + type: Unknown + line1: '' + country: 'GB ' + status: Active + modifiedDate: '2020-02-24T12:00:51.027Z' + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2020-02-24T12:00:50Z' + pageNumber: 1 + pageSize: 2 + totalResults: 53 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '11526230' + customerName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + contacts: + - name: Test 1 + phone: [] + address: + type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Unknown + status: Active + modifiedDate: '2023-04-25T14:19:12Z' + sourceModifiedDate: '2023-04-17T06:02:46Z' + metadata: + isDeleted: false + - id: '9677150' + customerName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + contacts: + - name: Test 1 + phone: [] + address: + type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Unknown + status: Active + modifiedDate: '2023-04-25T14:19:12Z' + sourceModifiedDate: '2023-04-24T06:19:23Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 159 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '634509' + customerName: A test customer 14 (updated) + contactName: test person name + emailAddress: test14@example.com + defaultCurrency: GBP + phone: 01876 541245 + addresses: + - type: Billing + line1: Line 1 + line2: Line 2 + city: Some city + region: A region + country: Country 1 + postalCode: SW1 2JQ + contacts: + - name: test person1 + email: test14A@example.com + phone: + - number: '24681012' + type: Primary + - number: '121086420' + type: Unknown + status: Active + - name: test person2 + email: test14B@example.com + phone: + - number: 1234 56789 + type: Primary + - number: 9876 54321 + type: Unknown + status: Active + - name: test person name + email: test14@example.com + phone: + - number: 01876 541245 + type: Unknown + status: Active + status: Active + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2022-05-18T09:23:56' + metadata: + isDeleted: false + - id: '634486' + customerName: A test customer name 2 + contactName: test person name + emailAddress: test8@example.com + defaultCurrency: GBP + phone: 01876 541245 + addresses: + - type: Billing + line1: Line 1 + line2: Line 2 + city: Some city + region: A region + country: Country 1 + postalCode: SW1 2JQ + contacts: + - name: test person1 + email: test9@example.com + phone: + - number: '24681012' + type: Primary + - number: '121086420' + type: Unknown + status: Active + - name: test person2 + email: test10@example.com + phone: + - number: '123456789' + type: Primary + - number: '987654321' + type: Unknown + status: Active + - name: test person name + email: test8@example.com + phone: + - number: 01876 541245 + type: Unknown + status: Active + status: Active + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2022-05-11T11:39:58' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 39 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '92227673' + customerName: Chekko Customer Test 01 + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + contacts: + - name: '' + email: '' + phone: [] + status: Active + taxNumber: '' + status: Active + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '0001-01-01T00:00:00' + - id: '88459410' + customerName: Diogo Sousa + contactName: Mr Diogo Sousa + emailAddress: diogomail@mail.com + phone: '123123123' + addresses: + - type: Billing + line1: Billing Address + line2: Billing line 2 Billing line 3 + city: Billing line 4 + country: United Kingdom + postalCode: '123321' + - type: Delivery + line1: Delivery Address + line2: Delivery line2 Delivery line3 + city: Delivery line4 + country: United Kingdom + postalCode: '123321' + contacts: + - name: Mr Diogo Sousa + email: diogomail@mail.com + phone: + - number: '123123123' + type: Landline + - number: '321321321' + type: Mobile + address: + type: Billing + line1: Billing Address + line2: Billing line 2 Billing line 3 + city: Billing line 4 + country: United Kingdom + postalCode: '123321' + status: Active + - name: Mr Diogo Sousa + phone: [] + address: + type: Delivery + line1: Delivery Address + line2: Delivery line2 Delivery line3 + city: Delivery line4 + country: United Kingdom + postalCode: '123321' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '2021-05-04T13:22:19' + pageNumber: 1 + pageSize: 2 + totalResults: 10 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '773' + customerName: 119 Test Customer + contactName: Mr Test Customer + defaultCurrency: GBP + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-01-30T14:48:02Z' + sourceModifiedDate: '2022-01-11T12:28:49' + - id: '172722' + customerName: 1248 European Company + contactName: European Company + defaultCurrency: GBP + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-01-30T14:48:02Z' + sourceModifiedDate: '2022-07-27T14:29:16' + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 150000-933272658 + customerName: 'Abercrombie, Kristy' + contactName: Kristy Abercrombie + emailAddress: kristy@samplename.com + defaultCurrency: GBP + phone: 415-555-6579 + addresses: + - type: Delivery + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + - type: Billing + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + contacts: + - name: 'Abercrombie, Kristy' + email: kristy@samplename.com + phone: + - number: 415-555-6579 + type: Primary + status: Active + - name: Kristy Abercrombie + phone: [] + status: Active + - name: Steve Darcangelo + phone: [] + status: Active + status: Active + modifiedDate: '2023-04-26T09:07:55Z' + sourceModifiedDate: '2023-12-16T05:06:42' + metadata: + isDeleted: false + - id: 800000D0-1182061376 + customerName: 'Allard, Robert' + contactName: Amanda Roberts + emailAddress: rallard@myemail.com + defaultCurrency: GBP + phone: 650-555-3422 + addresses: + - type: Delivery + line1: Robert Allard + line2: 92834 Chandler St. + city: Millbrae + region: CA + postalCode: '94030' + - type: Billing + line1: Robert Allard + line2: 92834 Chandler St. + city: Millbrae + region: CA + postalCode: '94030' + contacts: + - name: 'Allard, Robert' + email: rallard@myemail.com + phone: + - number: 650-555-3422 + type: Primary + - number: 650-555-9804 + type: Fax + - number: 650-555-8349 + type: Unknown + status: Active + - name: Robert Allard + phone: [] + status: Active + - name: Rachel Fisher + phone: [] + status: Active + status: Active + modifiedDate: '2023-04-26T09:07:55Z' + sourceModifiedDate: '2023-12-16T05:06:42' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '9' + customerName: Abe + contactName: Abraham's Company + emailAddress: ab@email.com + defaultCurrency: GBP + addresses: [] + contacts: + - name: Abe + email: ab@email.com + phone: + - number: '01111111111' + type: Mobile + status: Active + registrationNumber: XXXX9900001 + taxNumber: XXXX9900001 + status: Active + modifiedDate: '2023-01-18T11:02:35Z' + sourceModifiedDate: '2022-12-08T15:42:59Z' + - id: '49' + customerName: adeel qbo child test + contactName: Adeel test + emailAddress: adeel@adeel.com + defaultCurrency: GBP + phone: '123456789' + addresses: + - type: Billing + line1: 4 Privet Drive + city: London + country: United Kingdom + postalCode: WD25 7LR + - type: Delivery + line1: 4 Privet Drive + city: London + country: United Kingdom + postalCode: WD25 7LR + contacts: + - name: Adeel test + email: adeel@adeel.com + phone: + - number: '123456789' + type: Primary + - number: '07546543216' + type: Mobile + address: + type: Billing + line1: 4 Privet Drive + city: London + country: United Kingdom + postalCode: WD25 7LR + status: Active + status: Active + modifiedDate: '2023-01-18T11:02:35Z' + sourceModifiedDate: '2022-08-22T09:21:09Z' + pageNumber: 1 + pageSize: 2 + totalResults: 40 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '66' + customerName: Abercrombie International Group + contactName: Kristy Abercrombie + defaultCurrency: GBP + addresses: + - type: Billing + line1: 123 Main St + city: 'New York, NY' + contacts: + - name: Abercrombie International Group (deleted) + phone: [] + address: + type: Billing + line1: 123 Main St + city: 'New York, NY' + status: Archived + status: Archived + modifiedDate: '2023-04-26T09:35:56Z' + sourceModifiedDate: '2016-09-12T18:53:19Z' + metadata: + isDeleted: false + - id: '67' + customerName: Abercrombie International Group + contactName: Natalie Watts + emailAddress: n.watts@google.com + defaultCurrency: USD + addresses: + - type: Billing + - type: Delivery + contacts: + - name: Abercrombie International Group + email: n.watts@google.com + phone: [] + address: + type: Billing + status: Active + registrationNumber: XXXXVat123456 + taxNumber: XXXXVat123456 + status: Active + modifiedDate: '2023-04-26T09:35:56Z' + sourceModifiedDate: '2023-03-29T01:12:55Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 243 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: A1D001 + customerName: A1 Design Services + contactName: Lee Dalkin + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: '' + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: '' + postalCode: M2 6JK + - type: Billing + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: Great Britain + postalCode: BP12 7HT + contacts: + - name: Lee Dalkin + email: newbusinessadvice@sage.com + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Landline + - number: 01742 876 236 + type: Fax + status: Active + - name: Malcolm Leverret + email: '' + phone: [] + status: Active + - name: Jim Thomas + email: Jim@a1designservices.co.uk + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Fax + status: Active + - name: Jullian Plawsworth + email: Jullian@a1designservices.co.uk + phone: + - number: 0151 349 3939 + type: Landline + - number: 0151 349 3940 + type: Fax + status: Active + registrationNumber: '' + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2022-10-14T09:35:53Z' + sourceModifiedDate: '2022-04-27T15:17:36Z' + - id: A1D002 + customerName: A2 Design Services + contactName: Lee Dalkin + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Billing + line1: 77a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: Great Britain + postalCode: BP12 7HT + contacts: + - name: Lee Dalkin + email: newbusinessadvice@sage.com + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Landline + - number: 01742 876 236 + type: Fax + status: Active + - name: Malcolm Leverret + email: '' + phone: [] + status: Active + - name: Jim Thomas + email: Jim@a1designservices.co.uk + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Fax + status: Active + - name: Jullian Plawsworth + email: Jullian@a1designservices.co.uk + phone: + - number: 0151 349 3939 + type: Landline + - number: 0151 349 3940 + type: Fax + status: Active + registrationNumber: '' + taxNumber: GB238 3839 40 + status: Active + modifiedDate: '2022-10-14T09:35:53Z' + sourceModifiedDate: '2020-09-23T10:28:58Z' + pageNumber: 1 + pageSize: 2 + totalResults: 43 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: A1D001 + customerName: A1 Design Services + contactName: Ian Cairns + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: GB + postalCode: M2 6JK + - type: Unknown + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + contacts: [] + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2023-03-30T14:42:41Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + metadata: + isDeleted: false + - id: ABS001 + customerName: ABS Garages Ltd + contactName: Mike Hall + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 0191 254 5909 + addresses: + - type: Delivery + line1: Swanson Industries + line2: Dukes Industrial Estate + city: Whitley Bay + region: North Tyneside + country: GB + postalCode: NE56 4ER + - type: Delivery + line1: Unit 34 + line2: Holystone Ind Estate + city: Hebburn + region: Tyne & Wear + country: GB + postalCode: NE31 1VB + - type: Unknown + line1: Unit 34 + line2: Holystone Ind Estate + city: Hebburn + region: Tyne & Wear + country: GB + postalCode: NE31 1VB + contacts: [] + taxNumber: GB745 4584 68 + status: Active + modifiedDate: '2023-03-30T14:42:41Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 30 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 260f6a3f94a243738f2d5e08496a41a8 + customerName: 100 test name + contactName: Main Contact + emailAddress: email@codat.io + defaultCurrency: GBP + phone: contact phone number + addresses: + - type: Billing + line1: Aruba Address line 1 + line2: Aruba Address line 2 + city: Aruba City + region: Aruba Province + country: Aruba (AW) + postalCode: Aruba Post + contacts: + - phone: + - number: contact mobile number + type: Mobile + - number: contact fax number + type: Fax + status: Unknown + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2021-05-10T16:31:51Z' + - id: 44a5d9461d9e4f6d90a5ace251c5cf35 + customerName: 100 test name DS + contactName: Main Contact + emailAddress: DCemail@codat.io + defaultCurrency: GBP + phone: contact phone number + addresses: + - type: Billing + line1: POST - Aruba Address line 1 + line2: POST - Aruba Address line 2 + city: POST - Aruba City + region: Aruba Province + country: Aruba (AW) + postalCode: Aruba Post + contacts: [] + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2021-06-10T14:22:46Z' + pageNumber: 1 + pageSize: 2 + totalResults: 168 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '188' + customerName: 33Across + contactName: Yuna Conn + defaultCurrency: USD + phone: 520-393-4468 + addresses: + - type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + contacts: + - name: 'Conn, Yuna' + phone: + - number: 520-393-4468 + type: Primary + address: + type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + status: Unknown + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:21Z' + sourceModifiedDate: '2022-09-06T12:58:27' + metadata: + isDeleted: false + - id: '324' + customerName: 3Way International Logistics + contactName: Lauri O'Heagertie + defaultCurrency: CAD + phone: 410-309-3976 + addresses: + - type: Unknown + line1: 7 Lerdahl Junction + line2: '' + city: Sparwood + region: British Columbia + country: Canada + postalCode: L4R + contacts: + - name: 'O''Heagertie, Lauri' + phone: + - number: 410-309-3976 + type: Primary + address: + type: Unknown + line1: 7 Lerdahl Junction + line2: '' + city: Sparwood + region: British Columbia + country: Canada + postalCode: L4R + status: Unknown + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:21Z' + sourceModifiedDate: '2020-10-20T05:01:49' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 530 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers?page=2&pageSize=2 + Wave: + value: + results: + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 + customerName: ABC Textiles + contactName: '' + emailAddress: c.taylor@codat.io + defaultCurrency: USD + addresses: [] + contacts: [] + status: Active + modifiedDate: '2022-11-16T18:15:30Z' + sourceModifiedDate: '2019-10-17T07:59:04Z' + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjM3MTUzNDI2 + customerName: Coffee Cart + contactName: Coffee Carl + emailAddress: coffee.cart@example.com + defaultCurrency: GBP + phone: '0201111' + addresses: + - type: Billing + line1: 11 Coffee Lane + line2: Coffee Town + city: Coffee City + region: Hampshire + country: United Kingdom + postalCode: CC1 1CC + contacts: + - name: Coffee Carl + phone: + - number: '07733' + type: Mobile + status: Active + status: Active + modifiedDate: '2022-11-16T18:15:30Z' + sourceModifiedDate: '2020-03-17T19:12:39Z' + pageNumber: 1 + pageSize: 2 + totalResults: 10 + _links: + current: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers?page=1&pageSize=2 + self: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers + next: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers?page=2&pageSize=2 + Xero: + value: + results: + - id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + customerName: 24 Locks + emailAddress: '' + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-03-15T20:35:10Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + - id: bab779bc-c5fb-42cb-a888-953e8309711c + customerName: 7-Eleven + emailAddress: '' + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-03-15T20:35:10Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 48 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000032105' + customerName: A B + contactName: Contact (First Name) Contact (Last Name) + emailAddress: contactperson@whateveryouwantidontcare12345.com + defaultCurrency: GBP + phone: Work Phone + addresses: [] + contacts: + - name: Contact (First Name) Contact (Last Name) + email: contactperson@whateveryouwantidontcare12345.com + phone: + - number: Work Phone + type: Landline + - number: Mobile + type: Mobile + status: Active + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-06-09T14:36:47' + - id: '104957000000054050' + customerName: 'Doe, John' + contactName: John Doe + emailAddress: '' + defaultCurrency: GBP + addresses: [] + contacts: + - name: John Doe + email: '' + phone: [] + status: Active + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-09-28T15:09:22' + pageNumber: 1 + pageSize: 2 + totalResults: 14 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List customers* endpoint returns a list of [customers](https://docs.codat.io/lending-api#/schemas/Customer) for a given company's connection. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-customers + x-speakeasy-group: accounts-receivable.customers + '/companies/{companyId}/data/customers/{customerId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/customerId' + get: + tags: + - Accounts receivable + summary: Get customer + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCustomer' + examples: + Clear Books: + value: + id: c8180244-74ac-40cf-a5df-6d83661c44d7 + customerName: Arjun Kuvalis + contactName: Werner Langworth + emailAddress: Arjun34@hotmail.com + defaultCurrency: GBP + phone: 014605 64820 + addresses: + - type: Delivery + line1: Suite 214 + line2: 8439 Lueilwitz Passage + city: Fernandohaven + region: Northern Ireland + country: United Kingdom + postalCode: JG04 7PV + - type: Delivery + line1: Suite 096 + line2: 864 Halie Course + city: Juliochester + region: England + country: United Kingdom + postalCode: DZ8 4BF + - type: Delivery + line1: Suite 001 + line2: 416 Stokes Fords + city: Naderborough + region: Wales + country: United Kingdom + postalCode: XG25 0XX + contacts: + - name: Werner Langworth + email: Werner_Langworth@hotmail.com + phone: [] + address: + type: Delivery + line1: Apt. 145 + line2: 317 Williamson Freeway + city: Hortenseville + region: Scotland + country: United Kingdom + postalCode: CV4 2HR + status: Active + - name: Belle Glover + email: Belle51@yahoo.com + phone: [] + address: + type: Delivery + line1: Suite 075 + line2: 9921 Dickens Walk + city: South Ali + region: Scotland + country: United Kingdom + postalCode: TI04 4OO + status: Active + registrationNumber: NI7JEJVM + taxNumber: '7505220209.583549' + status: Active + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2022-07-03T01:27:00' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 0e2f7751-7696-ed11-bff5-6045bd0d2ad6 + customerName: '' + contactName: '' + emailAddress: '' + defaultCurrency: GBP + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + contacts: + - name: '' + email: '' + phone: [] + address: + type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2023-01-17T14:50:54Z' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 555f8251-c65a-433a-a813-5dbe04321d1e + customerName: Ab Netherlands + defaultCurrency: EUR + addresses: + - type: Billing + country: NL + contacts: [] + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2021-06-14T15:26:37Z' + Exact (UK): + value: + id: 5f20075a-a28e-434d-81a6-2db0dc170e87 + customerName: Abdi 99 + emailAddress: email@codat.io + defaultCurrency: GBP + addresses: + - type: Billing + line1: Ink Rooms + city: London + country: GB + postalCode: WC1X 0BE + contacts: [] + registrationNumber: '123456789' + taxNumber: GB339 0727 47 + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2020-02-26T11:23:50Z' + FreeAgent: + value: + id: '11526230' + customerName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + contacts: + - name: Test 1 + phone: [] + address: + type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Unknown + status: Active + modifiedDate: '2023-04-25T14:19:12Z' + sourceModifiedDate: '2023-04-17T06:02:46Z' + metadata: + isDeleted: false + FreshBooks: + value: + id: '634509' + customerName: A test customer 14 (updated) + contactName: test person name + emailAddress: test14@example.com + defaultCurrency: GBP + phone: 01876 541245 + addresses: + - type: Billing + line1: Line 1 + line2: Line 2 + city: Some city + region: A region + country: Country 1 + postalCode: SW1 2JQ + contacts: + - name: test person1 + email: test14A@example.com + phone: + - number: '24681012' + type: Primary + - number: '121086420' + type: Unknown + status: Active + - name: test person2 + email: test14B@example.com + phone: + - number: '123456789' + type: Primary + - number: '987654321' + type: Unknown + status: Active + - name: test person name + email: test14@example.com + phone: + - number: 01876 541245 + type: Unknown + status: Active + status: Active + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2022-05-18T09:23:56' + metadata: + isDeleted: false + KashFlow: + value: + id: '92227673' + customerName: Chekko Customer Test 01 + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + contacts: + - name: '' + email: '' + phone: [] + status: Active + taxNumber: '' + status: Active + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '0001-01-01T00:00:00' + Oracle NetSuite: + value: + id: '773' + customerName: 119 Test Customer + contactName: Mr Test Customer + defaultCurrency: GBP + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-01-30T14:48:02Z' + sourceModifiedDate: '2022-01-11T12:28:49' + QuickBooks Desktop: + value: + id: 150000-933272658 + customerName: 'Abercrombie, Kristy' + contactName: Kristy Abercrombie + emailAddress: kristy@samplename.com + defaultCurrency: GBP + phone: 415-555-6579 + addresses: + - type: Delivery + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + - type: Billing + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + contacts: + - name: 'Abercrombie, Kristy' + email: kristy@samplename.com + phone: + - number: 415-555-6579 + type: Primary + status: Active + - name: Kristy Abercrombie + phone: [] + status: Active + - name: Steve Darcangelo + phone: [] + status: Active + status: Active + modifiedDate: '2023-04-26T09:07:55Z' + sourceModifiedDate: '2023-12-16T05:06:42' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '9' + customerName: Abe + contactName: Abraham's Company + emailAddress: ab@email.com + defaultCurrency: GBP + addresses: [] + contacts: + - name: Abe + email: ab@email.com + phone: + - number: '01111111111' + type: Mobile + status: Active + registrationNumber: XXXX9900001 + taxNumber: XXXX9900001 + status: Active + modifiedDate: '2023-01-18T11:02:35Z' + sourceModifiedDate: '2022-12-08T15:42:59Z' + QuickBooks Online Sandbox: + value: + id: '66' + customerName: Abercrombie International Group + contactName: Kristy Abercrombie + defaultCurrency: GBP + addresses: + - type: Billing + line1: 123 Main St + city: 'New York, NY' + contacts: + - name: Abercrombie International Group (deleted) + phone: [] + address: + type: Billing + line1: 123 Main St + city: 'New York, NY' + status: Archived + status: Archived + modifiedDate: '2023-04-26T09:35:56Z' + sourceModifiedDate: '2016-09-12T18:53:19Z' + metadata: + isDeleted: false + Sage 200cloud: + value: + id: A1D001 + customerName: A1 Design Services + contactName: Lee Dalkin + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: '' + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: '' + postalCode: M2 6JK + - type: Billing + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: Great Britain + postalCode: BP12 7HT + contacts: + - name: Lee Dalkin + email: newbusinessadvice@sage.com + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Landline + - number: 01742 876 236 + type: Fax + status: Active + - name: Malcolm Leverret + email: '' + phone: [] + status: Active + - name: Jim Thomas + email: Jim@a1designservices.co.uk + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Fax + status: Active + - name: Jullian Plawsworth + email: Jullian@a1designservices.co.uk + phone: + - number: 0151 349 3939 + type: Landline + - number: 0151 349 3940 + type: Fax + status: Active + registrationNumber: '' + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2022-10-14T09:35:53Z' + sourceModifiedDate: '2022-04-27T15:17:36Z' + Sage 50 (UK): + value: + id: A1D001 + customerName: A1 Design Services + contactName: Ian Cairns + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: GB + postalCode: M2 6JK + - type: Unknown + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + contacts: [] + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2023-03-30T14:42:41Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: 260f6a3f94a243738f2d5e08496a41a8 + customerName: 100 test name + contactName: Main Contact + emailAddress: email@codat.io + defaultCurrency: GBP + phone: contact phone number + addresses: + - type: Billing + line1: Aruba Address line 1 + line2: Aruba Address line 2 + city: Aruba City + region: Aruba Province + country: Aruba (AW) + postalCode: Aruba Post + contacts: + - phone: + - number: contact mobile number + type: Mobile + - number: contact fax number + type: Fax + status: Unknown + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2021-05-10T16:31:51Z' + Sage Intacct: + value: + id: '188' + customerName: 33Across + contactName: Yuna Conn + defaultCurrency: USD + phone: 520-393-4468 + addresses: + - type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + contacts: + - name: 'Conn, Yuna' + phone: + - number: 520-393-4468 + type: Primary + address: + type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + status: Unknown + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:21Z' + sourceModifiedDate: '2022-09-06T12:58:27' + metadata: + isDeleted: false + Wave: + value: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 + customerName: ABC Textiles + contactName: '' + emailAddress: c.taylor@codat.io + defaultCurrency: USD + addresses: [] + contacts: [] + status: Active + modifiedDate: '2022-11-16T18:15:30Z' + sourceModifiedDate: '2019-10-17T07:59:04Z' + Xero: + value: + id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + customerName: 24 Locks + emailAddress: '' + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-03-15T20:35:10Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000032105' + customerName: A B + contactName: Contact (First Name) Contact (Last Name) + emailAddress: contactperson@whateveryouwantidontcare12345.com + defaultCurrency: GBP + phone: Work Phone + addresses: [] + contacts: + - name: Contact (First Name) Contact (Last Name) + email: contactperson@whateveryouwantidontcare12345.com + phone: + - number: Work Phone + type: Landline + - number: Mobile + type: Mobile + status: Active + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-06-09T14:36:47' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get customer* endpoint returns a single customer for a given customerId. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-customer + x-speakeasy-group: accounts-receivable.customers + '/companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/customerId' + get: + tags: + - Accounts receivable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: List customer attachments + description: |- + The *List customer attachments* endpoint returns a list of attachments avialable to download for given `customerId`. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + operationId: list-accounting-customer-attachments + x-speakeasy-group: accounts-receivable.customers + '/companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/customerId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts receivable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get customer attachment + description: | + The *Get customer attachment* endpoint returns a specific attachment for a given `customerId` and `attachmentId`. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + operationId: get-accounting-customer-attachment + x-speakeasy-group: accounts-receivable.customers + '/companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/customerId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts receivable + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Download customer attachment + description: |- + The *Download customer attachment* endpoint downloads a specific attachment for a given `customerId` and `attachmentId`. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + operationId: download-accounting-customer-attachment + x-speakeasy-group: accounts-receivable.customers + '/companies/{companyId}/connections/{connectionId}/data/directCosts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Transactions + summary: List direct costs + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingDirectCosts' + examples: + Clear Books: + value: + results: + - id: 994ad234-ca05-466e-8e6a-117783b38cf6 + reference: 005b7b62-dc9f-42d2-85a2-4a2cefc6bab2 + note: 'Direct Cost with 1 line items, totaling 242.20' + contactRef: + id: D4Q4iYwHou + dataType: suppliers + issueDate: '2022-04-27T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Saddle Branches 160mm x 110mm x 87 � + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 220.18 + quantity: 1 + discountAmount: 0 + discountPercentage: 0 + subTotal: 220.18 + taxAmount: 22.02 + totalAmount: 242.2 + itemRef: + id: '2' + name: Solvent Weld Branch 160mm x 110mm x 87 � + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 994ad234-ca05-466e-8e6a-117783b38cf6 + note: Payment for direct cost 994ad234-ca05-466e-8e6a-117783b38cf6 + reference: Direct Cost 994ad234-ca05-466e-8e6a-117783b38cf6 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-27T00:00:00' + totalAmount: 242.2 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-27T00:00:00' + totalAmount: -242.2 + subTotal: 220.18 + taxAmount: 22.02 + totalAmount: 242.2 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-09-18T20:59:02' + metadata: + isDeleted: false + - id: 735b5f9b-9e58-4f8f-8a9d-083de599986c + reference: 7d011ce8-89ae-43e7-a2ed-cf028534ccdc + note: 'Direct Cost with 4 line items, totaling 13684.57' + contactRef: + id: d3tf43eghS + dataType: suppliers + issueDate: '2022-05-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Yard Gully + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 148.88 + quantity: 5 + discountAmount: 73.62 + discountPercentage: 9.89 + subTotal: 670.78 + taxAmount: 67.08 + totalAmount: 737.86 + itemRef: + id: 00491160-6ee5-4d76-9f34-998f00687481 + name: Aluminium Silt Bucket + trackingCategoryRefs: [] + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 82.68 + quantity: 3 + discountAmount: 0 + discountPercentage: 0 + subTotal: 248.04 + taxAmount: 24.8 + totalAmount: 272.84 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + - description: Grease Trap + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 1192.51 + quantity: 8 + discountAmount: 0 + discountPercentage: 0 + subTotal: 9540.08 + taxAmount: 954.01 + totalAmount: 10494.09 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + - description: Underground - Drain Saddle Branches 160mm x 110mm x 87 � + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 220.18 + quantity: 9 + discountAmount: 0 + discountPercentage: 0 + subTotal: 1981.62 + taxAmount: 198.16 + totalAmount: 2179.78 + itemRef: + id: '2' + name: Solvent Weld Branch 160mm x 110mm x 87 � + trackingCategoryRefs: + - id: costcode_1 + name: Green Concrete + paymentAllocations: + - payment: + id: 735b5f9b-9e58-4f8f-8a9d-083de599986c + note: Payment for direct cost 735b5f9b-9e58-4f8f-8a9d-083de599986c + reference: Direct Cost 735b5f9b-9e58-4f8f-8a9d-083de599986c + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-02T00:00:00' + totalAmount: 13684.57 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-02T00:00:00' + totalAmount: -13684.57 + subTotal: 12440.52 + taxAmount: 1244.05 + totalAmount: 13684.57 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-10-13T07:15:02' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 90 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directCosts?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directCosts + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directCosts?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 6ab3e391-97d7-ec11-8e7e-000d3a0cfe40 + reference: INS000090 + note: '3931' + issueDate: '2022-05-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: test expenses 2 + accountRef: + id: '30' + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + unitAmount: 17.89 + quantity: -1 + subTotal: -17.89 + taxAmount: 0 + totalAmount: -17.89 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 6ab3e391-97d7-ec11-8e7e-000d3a0cfe40 + accountRef: + id: TEST + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-21T00:00:00' + totalAmount: -17.89 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-21T00:00:00' + totalAmount: -17.89 + subTotal: -17.89 + taxAmount: 0 + totalAmount: -17.89 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-19T17:17:33Z' + metadata: + isDeleted: false + - id: b832f518-88d7-ec11-8e7e-000d3a0cfe40 + reference: INS000050 + note: '3915' + issueDate: '2022-05-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Utilities Expense + accountRef: + id: '31300' + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + unitAmount: 14.76 + quantity: 1 + subTotal: 14.76 + taxAmount: 0 + totalAmount: 14.76 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: b832f518-88d7-ec11-8e7e-000d3a0cfe40 + accountRef: + id: TEST + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-23T00:00:00' + totalAmount: 14.76 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-23T00:00:00' + totalAmount: 14.76 + subTotal: 14.76 + taxAmount: 0 + totalAmount: 14.76 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-19T15:26:48Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 67 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directCosts?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directCosts + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directCosts?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '190325254' + note: 'Atomic Software Limite Wellington,Nzl' + issueDate: '2017-11-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: '285' + name: Accommodation and Meals + unitAmount: 11.92 + quantity: 1 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '190325254' + note: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + allocation: + currency: GBP + allocatedOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2019-11-22T14:31:14Z' + metadata: + isDeleted: false + - id: '348108455' + note: 'Atomic Software Limite Wellington,Nzl' + issueDate: '2017-11-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: '285' + name: Accommodation and Meals + unitAmount: 11.92 + quantity: 1 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '348108455' + note: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + allocation: + currency: GBP + allocatedOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2022-10-24T12:35:29Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 456 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directCosts?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directCosts + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directCosts?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '29870062' + reference: Food to keep me working + note: Food to keep me working + contactRef: + id: Sainsburys + dataType: suppliers + issueDate: '2019-02-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Food to keep me working + accountRef: + id: '3361426' + name: Meals & Entertainment + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + trackingCategoryRefs: + - id: '4370503' + name: Meals & Entertainment + paymentAllocations: [] + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-10-28T15:21:46' + metadata: + isDeleted: false + - id: '107509561' + reference: Buying pencils + note: Buying pencils + contactRef: + id: Pencils Wholesale + dataType: suppliers + issueDate: '2020-01-27T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Buying pencils + accountRef: + id: '3380551' + name: Supplies + unitAmount: 43.48 + quantity: 1 + subTotal: 43.48 + taxAmount: 6.52 + totalAmount: 50 + trackingCategoryRefs: + - id: '5397997' + name: Supplies + paymentAllocations: [] + subTotal: 43.48 + taxAmount: 6.52 + totalAmount: 50 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-10-28T15:21:47' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 73 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/connections/100d8da9-91b1-495c-ae2e-2219c244acae/data/directCosts?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/connections/100d8da9-91b1-495c-ae2e-2219c244acae/data/directCosts + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/connections/100d8da9-91b1-495c-ae2e-2219c244acae/data/directCosts?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: D7B-933784104 + reference: '93' + contactRef: + id: 360000-933272659 + dataType: suppliers + issueDate: '2022-12-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 3C0000-933270542 + name: Rent + unitAmount: 1200 + quantity: 1 + subTotal: 1200 + totalAmount: 1200 + trackingCategoryRefs: + - id: 80000007-1197713802 + name: Overhead + tracking: + recordRefs: + - id: 80000007-1197713802 + dataType: trackingCategories + - id: 800000B0-1197755238 + dataType: customers + paymentAllocations: + - payment: + id: D7B-933784104 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-01T00:00:00' + totalAmount: 1200 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-01T00:00:00' + totalAmount: 1200 + subTotal: 1200 + taxAmount: 0 + totalAmount: 1200 + modifiedDate: '2023-04-26T09:13:57Z' + sourceModifiedDate: '2023-12-16T05:04:10' + metadata: + isDeleted: false + - id: DFA-933785132 + reference: '95' + contactRef: + id: 320000-933272659 + dataType: suppliers + issueDate: '2022-12-05T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 280000-933270542 + name: Freight & Delivery + unitAmount: 35 + quantity: 1 + subTotal: 35 + totalAmount: 35 + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + tracking: + recordRefs: + - id: 40000-933272658 + dataType: trackingCategories + - id: 1E0000-933272658 + dataType: customers + paymentAllocations: + - payment: + id: DFA-933785132 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-05T00:00:00' + totalAmount: 35 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-05T00:00:00' + totalAmount: 35 + subTotal: 35 + taxAmount: 0 + totalAmount: 35 + modifiedDate: '2023-04-26T09:13:57Z' + sourceModifiedDate: '2023-12-16T05:04:11' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 250 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directCosts?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directCosts + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directCosts?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: PUR-85 + note: Opening Balance from Bank + issueDate: '2015-08-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '55' + name: Opening Balance Equity + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + unitAmount: 3831.8 + quantity: 1 + subTotal: 3831.8 + taxAmount: 0 + totalAmount: 3831.8 + trackingCategoryRefs: [] + tracking: + recordRefs: [] + paymentAllocations: + - payment: + id: '85' + reference: Opening Balance from Bank + accountRef: + id: '57' + name: Visa Credit Card + currency: GBP + currencyRate: 1 + paidOnDate: '2015-08-12T00:00:00' + totalAmount: 3831.8 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-08-12T00:00:00' + totalAmount: -3831.8 + subTotal: 3831.8 + taxAmount: 0 + totalAmount: 3831.8 + modifiedDate: '2023-04-26T09:36:40Z' + sourceModifiedDate: '2016-09-12T18:13:07Z' + metadata: + isDeleted: false + - id: PUR-3617 + reference: '2001' + contactRef: + id: '27' + dataType: suppliers + issueDate: '2015-11-27T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Insurance - general liability + accountRef: + id: '22' + name: Insurance Expense-General Liability Insurance + taxRateRef: + id: 3_Bills + name: 20.0% S Bills + effectiveTaxRate: 20 + unitAmount: 750 + quantity: 1 + subTotal: 750 + taxAmount: 150 + totalAmount: 900 + trackingCategoryRefs: [] + tracking: + recordRefs: [] + paymentAllocations: + - payment: + id: '3617' + note: '2001' + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2015-11-27T00:00:00' + totalAmount: 900 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-11-27T00:00:00' + totalAmount: -900 + subTotal: 750 + taxAmount: 150 + totalAmount: 900 + modifiedDate: '2023-04-26T09:36:40Z' + sourceModifiedDate: '2022-08-19T10:19:56Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 4460 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directCosts?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directCosts + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directCosts?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: PUR-15 + note: Payment to Google + issueDate: '2018-09-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Payment to Google + accountRef: + id: '37' + name: Computer equipment accumulated depreciation brought forward + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + unitAmount: 1.59 + quantity: 1 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '15' + reference: Payment to Google + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-09-21T00:00:00' + totalAmount: 1.59 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-09-21T00:00:00' + totalAmount: -1.59 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + modifiedDate: '2023-01-18T11:02:59Z' + sourceModifiedDate: '2018-12-17T14:56:44Z' + - id: PUR-9303 + note: Payment to Google + contactRef: + id: '4' + dataType: suppliers + issueDate: '2018-09-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Payment to Google + accountRef: + id: '37' + name: Computer equipment accumulated depreciation brought forward + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + unitAmount: 1.59 + quantity: 1 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '9303' + reference: Payment to Google + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-09-21T00:00:00' + totalAmount: 1.59 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-09-21T00:00:00' + totalAmount: -1.59 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + modifiedDate: '2023-01-18T11:02:59Z' + sourceModifiedDate: '2022-07-11T10:32:16Z' + pageNumber: 1 + pageSize: 2 + totalResults: 2176 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directCosts?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directCosts + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directCosts?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '73' + reference: DD/STO + issueDate: '2021-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Electrcity Direct Debit + accountRef: + id: '7200' + name: Electricity + taxRateRef: + id: '3' + unitAmount: 150 + quantity: 1 + subTotal: 150 + taxAmount: 12 + totalAmount: 162 + trackingCategoryRefs: + - id: department_0 + name: Default + paymentAllocations: + - payment: + id: '73' + reference: DD/STO + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-29T00:00:00' + totalAmount: 162 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-29T00:00:00' + totalAmount: 162 + subTotal: 150 + taxAmount: 12 + totalAmount: 162 + modifiedDate: '2023-03-30T14:42:35Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + - id: '52' + reference: '568953' + issueDate: '2021-01-30T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Vat Payment Quater End 3112.96 + accountRef: + id: '2202' + name: VAT Liability + taxRateRef: + id: '9' + name: Non-Vatable Tax Code + effectiveTaxRate: 0 + unitAmount: 1497.58 + quantity: 1 + subTotal: 1497.58 + taxAmount: 0 + totalAmount: 1497.58 + trackingCategoryRefs: + - id: department_0 + name: Default + paymentAllocations: + - payment: + id: '52' + reference: '568953' + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-30T00:00:00' + totalAmount: 1497.58 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-30T00:00:00' + totalAmount: 1497.58 + subTotal: 1497.58 + taxAmount: 0 + totalAmount: 1497.58 + modifiedDate: '2023-03-30T14:42:35Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 106 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/directCosts?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/directCosts + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/directCosts?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: 'CCTRANSACTION:4355' + reference: '' + note: Test 1 + issueDate: '2020-01-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '195' + name: Insurance + taxRateRef: + id: '62018' + unitAmount: 9.99 + quantity: 1 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '4355' + note: '' + reference: '' + accountRef: + id: '348' + name: CMRR Renewal + currency: GBP + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + allocation: + currency: GBP + allocatedOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + modifiedDate: '2022-10-28T11:10:28Z' + sourceModifiedDate: '2022-08-22T09:26:42' + - id: 'CCTRANSACTION:4356' + reference: '' + note: Test 1 + issueDate: '2020-01-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '195' + name: Insurance + taxRateRef: + id: '62022' + unitAmount: 9.99 + quantity: 1 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '4356' + note: '' + reference: '' + accountRef: + id: '348' + name: CMRR Renewal + currency: GBP + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + allocation: + currency: GBP + allocatedOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + modifiedDate: '2022-10-28T11:10:28Z' + sourceModifiedDate: '2022-02-17T23:26:16' + pageNumber: 1 + pageSize: 2 + totalResults: 57 + _links: + current: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directCosts?page=1&pageSize=2 + self: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directCosts + next: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directCosts?page=2&pageSize=2 + Xero: + value: + results: + - id: dc1bb034-7bbf-4e84-b418-b7f4aee59d72 + reference: '' + contactRef: + id: 737982b0-2811-44c9-bdb3-3b26a3a6ef8c + dataType: suppliers + issueDate: '2022-11-22T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Bank fee + accountRef: + id: 2c410b86-de57-49d1-b540-4e8ce824979c + name: Bank Fees + unitAmount: 15 + quantity: 1 + subTotal: 15 + taxAmount: 0 + totalAmount: 15 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: dc1bb034-7bbf-4e84-b418-b7f4aee59d72 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-11-22T00:00:00' + totalAmount: 15 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-11-22T00:00:00' + totalAmount: 15 + subTotal: 15 + taxAmount: 0 + totalAmount: 15 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-03T21:43:46' + metadata: + isDeleted: false + - id: 521c2396-7f74-404c-9cca-31115296b808 + reference: Eft + contactRef: + id: 74ea95ea-6e1e-435d-9c30-0dff8ae1bd80 + dataType: suppliers + issueDate: '2022-11-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Misc stationery + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + unitAmount: 18.09 + quantity: 1 + subTotal: 18.09 + taxAmount: 3.62 + totalAmount: 21.71 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 521c2396-7f74-404c-9cca-31115296b808 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-11-23T00:00:00' + totalAmount: 21.71 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-11-23T00:00:00' + totalAmount: 21.71 + subTotal: 18.09 + taxAmount: 3.62 + totalAmount: 21.71 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-03T21:43:51' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 15 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directCosts?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directCosts + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directCosts?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List direct costs* endpoint returns a list of [direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) for a given company's connection. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-direct-costs + x-speakeasy-group: transactions.direct-costs + '/companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectCostId' + get: + tags: + - Transactions + summary: Get direct cost + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingDirectCost' + examples: + Clear Books: + value: + id: 994ad234-ca05-466e-8e6a-117783b38cf6 + reference: 005b7b62-dc9f-42d2-85a2-4a2cefc6bab2 + note: 'Direct Cost with 1 line items, totaling 242.20' + contactRef: + id: D4Q4iYwHou + dataType: suppliers + issueDate: '2022-04-27T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Saddle Branches 160mm x 110mm x 87 � + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 220.18 + quantity: 1 + discountAmount: 0 + discountPercentage: 0 + subTotal: 220.18 + taxAmount: 22.02 + totalAmount: 242.2 + itemRef: + id: '2' + name: Solvent Weld Branch 160mm x 110mm x 87 � + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 994ad234-ca05-466e-8e6a-117783b38cf6 + note: Payment for direct cost 994ad234-ca05-466e-8e6a-117783b38cf6 + reference: Direct Cost 994ad234-ca05-466e-8e6a-117783b38cf6 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-27T00:00:00' + totalAmount: 242.2 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-27T00:00:00' + totalAmount: -242.2 + subTotal: 220.18 + taxAmount: 22.02 + totalAmount: 242.2 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-09-18T20:59:02' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 6ab3e391-97d7-ec11-8e7e-000d3a0cfe40 + reference: INS000090 + note: '3931' + issueDate: '2022-05-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: test expenses 2 + accountRef: + id: '30' + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + unitAmount: 17.89 + quantity: -1 + subTotal: -17.89 + taxAmount: 0 + totalAmount: -17.89 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 6ab3e391-97d7-ec11-8e7e-000d3a0cfe40 + accountRef: + id: TEST + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-21T00:00:00' + totalAmount: -17.89 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-21T00:00:00' + totalAmount: -17.89 + subTotal: -17.89 + taxAmount: 0 + totalAmount: -17.89 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-19T17:17:33Z' + metadata: + isDeleted: false + FreeAgent: + value: + id: '190325254' + note: 'Atomic Software Limite Wellington,Nzl' + issueDate: '2017-11-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: '285' + name: Accommodation and Meals + unitAmount: 11.92 + quantity: 1 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '190325254' + note: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + allocation: + currency: GBP + allocatedOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2019-11-22T14:31:14Z' + metadata: + isDeleted: false + FreshBooks: + value: + id: '29870062' + reference: Food to keep me working + note: Food to keep me working + contactRef: + id: Sainsburys + dataType: suppliers + issueDate: '2019-02-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Food to keep me working + accountRef: + id: '3361426' + name: Meals & Entertainment + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + trackingCategoryRefs: + - id: '4370503' + name: Meals & Entertainment + paymentAllocations: [] + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-10-28T15:21:46' + metadata: + isDeleted: false + QuickBooks Desktop: + value: + id: D7B-933784104 + reference: '93' + contactRef: + id: 360000-933272659 + dataType: suppliers + issueDate: '2022-12-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 3C0000-933270542 + name: Rent + unitAmount: 1200 + quantity: 1 + subTotal: 1200 + totalAmount: 1200 + trackingCategoryRefs: + - id: 80000007-1197713802 + name: Overhead + tracking: + recordRefs: + - id: 80000007-1197713802 + dataType: trackingCategories + - id: 800000B0-1197755238 + dataType: customers + paymentAllocations: + - payment: + id: D7B-933784104 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-01T00:00:00' + totalAmount: 1200 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-01T00:00:00' + totalAmount: 1200 + subTotal: 1200 + taxAmount: 0 + totalAmount: 1200 + modifiedDate: '2023-04-26T09:13:57Z' + sourceModifiedDate: '2023-12-16T05:04:10' + metadata: + isDeleted: false + QuickBooks Online Sandbox: + value: + id: PUR-85 + note: Opening Balance from Bank + issueDate: '2015-08-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '55' + name: Opening Balance Equity + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + unitAmount: 3831.8 + quantity: 1 + subTotal: 3831.8 + taxAmount: 0 + totalAmount: 3831.8 + trackingCategoryRefs: [] + tracking: + recordRefs: [] + paymentAllocations: + - payment: + id: '85' + reference: Opening Balance from Bank + accountRef: + id: '57' + name: Visa Credit Card + currency: GBP + currencyRate: 1 + paidOnDate: '2015-08-12T00:00:00' + totalAmount: 3831.8 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-08-12T00:00:00' + totalAmount: -3831.8 + subTotal: 3831.8 + taxAmount: 0 + totalAmount: 3831.8 + modifiedDate: '2023-04-26T09:36:40Z' + sourceModifiedDate: '2016-09-12T18:13:07Z' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: PUR-15 + note: Payment to Google + issueDate: '2018-09-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Payment to Google + accountRef: + id: '37' + name: Computer equipment accumulated depreciation brought forward + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + unitAmount: 1.59 + quantity: 1 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '15' + reference: Payment to Google + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-09-21T00:00:00' + totalAmount: 1.59 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-09-21T00:00:00' + totalAmount: -1.59 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + modifiedDate: '2023-01-18T11:02:59Z' + sourceModifiedDate: '2018-12-17T14:56:44Z' + Sage 50 (UK): + value: + id: '73' + reference: DD/STO + issueDate: '2021-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Electrcity Direct Debit + accountRef: + id: '7200' + name: Electricity + taxRateRef: + id: '3' + unitAmount: 150 + quantity: 1 + subTotal: 150 + taxAmount: 12 + totalAmount: 162 + trackingCategoryRefs: + - id: department_0 + name: Default + paymentAllocations: + - payment: + id: '73' + reference: DD/STO + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-29T00:00:00' + totalAmount: 162 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-29T00:00:00' + totalAmount: 162 + subTotal: 150 + taxAmount: 12 + totalAmount: 162 + modifiedDate: '2023-03-30T14:42:35Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + Sage Intacct: + value: + id: 'CCTRANSACTION:4355' + reference: '' + note: Test 1 + issueDate: '2020-01-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '195' + name: Insurance + taxRateRef: + id: '62018' + unitAmount: 9.99 + quantity: 1 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '4355' + note: '' + reference: '' + accountRef: + id: '348' + name: CMRR Renewal + currency: GBP + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + allocation: + currency: GBP + allocatedOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + modifiedDate: '2022-10-28T11:10:28Z' + sourceModifiedDate: '2022-08-22T09:26:42' + Xero: + value: + id: dc1bb034-7bbf-4e84-b418-b7f4aee59d72 + reference: '' + contactRef: + id: 737982b0-2811-44c9-bdb3-3b26a3a6ef8c + dataType: suppliers + issueDate: '2022-11-22T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Bank fee + accountRef: + id: 2c410b86-de57-49d1-b540-4e8ce824979c + name: Bank Fees + unitAmount: 15 + quantity: 1 + subTotal: 15 + taxAmount: 0 + totalAmount: 15 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: dc1bb034-7bbf-4e84-b418-b7f4aee59d72 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-11-22T00:00:00' + totalAmount: 15 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-11-22T00:00:00' + totalAmount: 15 + subTotal: 15 + taxAmount: 0 + totalAmount: 15 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-03T21:43:46' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get direct cost* endpoint returns a single direct cost for a given directCostId. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-direct-cost + x-speakeasy-group: transactions.direct-costs + '/companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectCostId' + get: + tags: + - Transactions + summary: Get direct cost attachment + parameters: + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Get direct cost attachment* endpoint returns a specific attachment for a given `directCostId` and `attachmentId`. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + operationId: get-accounting-direct-cost-attachment + x-speakeasy-group: transactions.direct-costs + '/companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectCostId' + get: + tags: + - Transactions + summary: Download direct cost attachment + parameters: + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Download direct cost attachment* endpoint downloads a specific attachment for a given `directCostId` and `attachmentId`. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + operationId: download-accounting-direct-cost-attachment + x-speakeasy-group: transactions.direct-costs + '/companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectCostId' + get: + tags: + - Transactions + summary: List direct cost attachments + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *List direct cost attachments* endpoint returns a list of attachments available to download for given `directCostId`. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + operationId: list-accounting-direct-cost-attachments + x-speakeasy-group: transactions.direct-costs + '/companies/{companyId}/connections/{connectionId}/data/directIncomes': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Accounts receivable + summary: List direct incomes + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingDirectIncomes' + examples: + Clear Books: + value: + results: + - id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + reference: 3cb8ced3-3ecb-4974-ada5-8290b0ec3355 + note: 'Direct Income with 1 line items, totaling 188.33' + contactRef: + id: 51f03576-f6b0-40d5-9fba-81a490411c03 + dataType: customers + issueDate: '2022-04-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Yard Gully + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 171.21 + quantity: 1 + discountAmount: 0 + discountPercentage: 0 + subTotal: 171.21 + taxAmount: 17.12 + totalAmount: 188.33 + itemRef: + id: 00491160-6ee5-4d76-9f34-998f00687481 + name: Aluminium Silt Bucket + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + note: Payment for direct income 38e8c917-0afc-4583-8ffe-1b53ad601197 + reference: Direct Income 38e8c917-0afc-4583-8ffe-1b53ad601197 + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-19T00:00:00' + totalAmount: 188.33 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-19T00:00:00' + totalAmount: -188.33 + subTotal: 171.21 + taxAmount: 17.12 + totalAmount: 188.33 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-05-13T01:06:00' + metadata: + isDeleted: false + - id: c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + reference: ee4ea56f-8806-494d-9c69-7ec22e68dc5e + note: 'Direct Income with 4 line items, totaling 32095.91' + contactRef: + id: 453ddfc0-49ce-4f66-a815-dae734be885c + dataType: customers + issueDate: '2022-04-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 95.08 + quantity: 2 + discountAmount: 0 + discountPercentage: 0 + subTotal: 190.16 + taxAmount: 19.02 + totalAmount: 209.18 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: + - id: costcode_9 + name: PandaConstruction + - id: department_3 + name: MarshallBrotherContracting + - description: Grease Trap + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 1251.89 + quantity: 6 + discountAmount: 778.93 + discountPercentage: 10.37 + subTotal: 6732.41 + taxAmount: 673.24 + totalAmount: 7405.66 + itemRef: + id: 51077072-d5c3-463b-9cb4-7da2e11886f9 + name: 150 Litre Grease Trap + trackingCategoryRefs: [] + - description: Grease Trap + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 2781.94 + quantity: 2 + discountAmount: 0 + discountPercentage: 0 + subTotal: 5563.88 + taxAmount: 556.39 + totalAmount: 6120.27 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + - description: Grease Trap + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 2781.94 + quantity: 6 + discountAmount: 0 + discountPercentage: 0 + subTotal: 16691.64 + taxAmount: 1669.16 + totalAmount: 18360.8 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + note: Payment for direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + reference: Direct Income c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-19T00:00:00' + totalAmount: 32095.91 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-19T00:00:00' + totalAmount: -32095.91 + subTotal: 29178.09 + taxAmount: 2917.81 + totalAmount: 32095.91 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2023-02-13T00:34:00' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 518 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directIncomes + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directIncomes?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 8be30162-feec-ec11-82f9-000d3a8746a9 + reference: B1234 + note: '4006' + issueDate: '2022-06-18T00:00:00' + currency: USD + currencyRate: 0.648364486 + lineItems: + - description: Interest Income + accountRef: + id: 221217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Interest Income + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + unitAmount: 7.13 + quantity: 1 + subTotal: 7.13 + taxAmount: 1.43 + totalAmount: 8.56 + trackingCategoryRefs: + - id: adbc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: ADM-Administration + paymentAllocations: + - payment: + id: 8be30162-feec-ec11-82f9-000d3a8746a9 + accountRef: + id: 8277672c-b8e6-ec11-82f8-0022481a77f0 + name: B020-BoA + currency: USD + currencyRate: 0.6483644859813084 + paidOnDate: '2022-06-18T00:00:00' + totalAmount: 8.56 + allocation: + currency: USD + currencyRate: 0.6483644859813084 + allocatedOnDate: '2022-06-18T00:00:00' + totalAmount: 8.56 + subTotal: 7.13 + taxAmount: 1.43 + totalAmount: 8.56 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-06-15T22:56:26Z' + metadata: + isDeleted: false + - id: f68e56e0-b8bd-ed11-9a88-6045bd0f9361 + reference: B110 + note: '4990' + issueDate: '2023-03-07T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Accounts Receivable + accountRef: + id: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Receivable + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + unitAmount: 649.4 + quantity: -1 + subTotal: -649.4 + taxAmount: 0 + totalAmount: -649.4 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: f68e56e0-b8bd-ed11-9a88-6045bd0f9361 + accountRef: + id: b6545a08-a9bd-ed11-9a88-0022484358c7 + name: HOLDING_LENDING + currency: GBP + currencyRate: 1 + paidOnDate: '2023-03-07T00:00:00' + totalAmount: -649.4 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-03-07T00:00:00' + totalAmount: -649.4 + subTotal: -649.4 + taxAmount: 0 + totalAmount: -649.4 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2023-03-08T13:55:34Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directIncomes + FreeAgent: + value: + results: + - id: '344673327' + note: Test Transaction 2 + issueDate: '2017-11-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Test Transaction 2 + accountRef: + id: '001' + name: Sales + unitAmount: 10.5 + quantity: 1 + subTotal: 10.5 + taxAmount: 0 + totalAmount: 10.5 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '344673327' + note: Test Transaction 2 + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-01T00:00:00' + totalAmount: 10.5 + allocation: + currency: GBP + allocatedOnDate: '2017-11-01T00:00:00' + totalAmount: 10.5 + subTotal: 10.5 + taxAmount: 0 + totalAmount: 10.5 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2022-10-06T10:38:24Z' + metadata: + isDeleted: false + - id: '348104863' + note: 'Codat Ltd Ref: Nov Topup' + issueDate: '2017-11-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Codat Ltd Ref: Nov Topup' + accountRef: + id: '001' + name: Sales + unitAmount: 100 + quantity: 1 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '348104863' + note: 'Codat Ltd Ref: Nov Topup' + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-23T00:00:00' + totalAmount: 100 + allocation: + currency: GBP + allocatedOnDate: '2017-11-23T00:00:00' + totalAmount: 100 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2022-10-24T12:13:27Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 211 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directIncomes + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directIncomes?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 9B87-1181931723 + reference: 9C08-1181931827 + contactRef: + id: 280000-933272658 + dataType: customers + issueDate: '2023-01-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 80000-933270541 + name: Undeposited Funds + unitAmount: 1228.18 + quantity: 1 + subTotal: 1228.18 + taxAmount: 0 + totalAmount: 1228.18 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 9B87-1181931723 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-15T00:00:00' + totalAmount: 1228.18 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-01-15T00:00:00' + totalAmount: 1228.18 + subTotal: 1228.18 + taxAmount: 0 + totalAmount: 1228.18 + modifiedDate: '2023-04-26T09:14:12Z' + sourceModifiedDate: '2023-12-16T05:06:23' + metadata: + isDeleted: false + - id: 68E0-1197775239 + reference: 96F3-1197775718 + contactRef: + id: 800000B5-1197701259 + dataType: customers + issueDate: '2023-01-17T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 80000-933270541 + name: Undeposited Funds + unitAmount: 361.08 + quantity: 1 + subTotal: 361.08 + taxAmount: 0 + totalAmount: 361.08 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 68E0-1197775239 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-17T00:00:00' + totalAmount: 15281.67 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-01-17T00:00:00' + totalAmount: 361.08 + subTotal: 361.08 + taxAmount: 0 + totalAmount: 361.08 + modifiedDate: '2023-04-26T09:14:12Z' + sourceModifiedDate: '2023-12-16T05:06:11' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 104 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directIncomes + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directIncomes?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: 5-1 + contactRef: + id: '52' + dataType: suppliers + issueDate: '2015-11-24T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: contribution to start business + accountRef: + id: '61' + name: Owner's Equity - Contributions + taxRateRef: + id: 2_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + unitAmount: 10000 + quantity: 1 + discountAmount: 0 + subTotal: 10000 + taxAmount: 0 + totalAmount: 10000 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 5-1 + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2015-11-24T00:00:00' + totalAmount: 10000 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-11-24T00:00:00' + totalAmount: -10000 + subTotal: 10000 + taxAmount: 0 + totalAmount: 10000 + modifiedDate: '2023-04-26T09:36:04Z' + sourceModifiedDate: '2016-09-12T15:26:26Z' + metadata: + isDeleted: false + - id: 5-2 + contactRef: + id: '53' + dataType: suppliers + issueDate: '2015-11-24T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: funds borrowed to start business + accountRef: + id: '63' + name: Note Payable + taxRateRef: + id: 2_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + unitAmount: 25000 + quantity: 1 + discountAmount: 0 + subTotal: 25000 + taxAmount: 0 + totalAmount: 25000 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 5-2 + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2015-11-24T00:00:00' + totalAmount: 25000 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-11-24T00:00:00' + totalAmount: -25000 + subTotal: 25000 + taxAmount: 0 + totalAmount: 25000 + modifiedDate: '2023-04-26T09:36:04Z' + sourceModifiedDate: '2016-09-12T15:26:26Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 741 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directIncomes + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directIncomes?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '1' + note: Opening Balance from Bank + issueDate: '2018-09-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '53' + name: Retained profit balance forward account + unitAmount: 170.23 + quantity: 1 + discountAmount: 0 + subTotal: 170.23 + taxAmount: 0 + totalAmount: 170.23 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '1' + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-09-21T00:00:00' + totalAmount: 170.23 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-09-21T00:00:00' + totalAmount: -170.23 + subTotal: 170.23 + taxAmount: 0 + totalAmount: 170.23 + modifiedDate: '2023-01-18T11:02:50Z' + sourceModifiedDate: '2018-12-17T14:56:20Z' + - id: '11' + note: 'Payment from CD Baby, a division of Audio and Video Labs Inc' + issueDate: '2018-10-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Payment from CD Baby, a division of Audio and Video Labs Inc' + accountRef: + id: '57' + name: Sales of Product Income + unitAmount: 8.12 + quantity: 1 + discountAmount: 0 + subTotal: 8.12 + taxAmount: 0 + totalAmount: 8.12 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '11' + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-10-15T00:00:00' + totalAmount: 8.12 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-10-15T00:00:00' + totalAmount: -8.12 + subTotal: 8.12 + taxAmount: 0 + totalAmount: 8.12 + modifiedDate: '2023-01-18T11:02:50Z' + sourceModifiedDate: '2018-12-17T14:56:44Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1171 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directIncomes + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directIncomes?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '4973' + reference: dt test contact + note: dt header description + issueDate: '2022-03-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Dt test line1 + accountRef: + id: '151' + name: Cash + taxRateRef: + id: '99' + name: UK Sale Goods Standard Rate + effectiveTaxRate: 20 + unitAmount: 125 + quantity: 1 + subTotal: 125 + taxAmount: 25 + totalAmount: 150 + trackingCategoryRefs: + - id: DEPARTMENT-1 + name: Sales + - id: LOCATION-8 + name: United Kingdom + - description: dt test line 2 + accountRef: + id: '152' + name: Cash Equivalents + taxRateRef: + id: '99' + name: UK Sale Goods Standard Rate + effectiveTaxRate: 20 + unitAmount: 166.67 + quantity: 1 + subTotal: 166.67 + taxAmount: 33.33 + totalAmount: 200 + trackingCategoryRefs: + - id: DEPARTMENT-2 + name: Services + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '4973' + note: dt header description + accountRef: + id: '289' + name: Checking 5 - Bank Of England + currency: GBP + paidOnDate: '2022-03-15T00:00:00' + totalAmount: 350 + allocation: + currency: GBP + allocatedOnDate: '2022-03-15T00:00:00' + totalAmount: 350 + subTotal: 291.67 + taxAmount: 58.33 + totalAmount: 350 + modifiedDate: '2022-10-28T11:10:26Z' + sourceModifiedDate: '2022-03-15T12:45:58Z' + - id: '5314' + reference: Test Int Income + note: Test Description + issueDate: '2022-03-24T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Interest earned + accountRef: + id: '5' + name: Other Income + unitAmount: 300 + quantity: 1 + subTotal: 300 + totalAmount: 300 + trackingCategoryRefs: + - id: DEPARTMENT-1 + name: Sales + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '5314' + note: Test Description + reference: Test Int Income + accountRef: + id: '289' + name: Checking 5 - Bank Of England + currency: GBP + paidOnDate: '2022-03-24T00:00:00' + totalAmount: 300 + allocation: + currency: GBP + allocatedOnDate: '2022-03-24T00:00:00' + totalAmount: 300 + subTotal: 300 + taxAmount: 0 + totalAmount: 300 + modifiedDate: '2022-10-28T11:10:26Z' + pageNumber: 1 + pageSize: 2 + totalResults: 43 + _links: + current: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directIncomes + next: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directIncomes?page=2&pageSize=2 + Xero: + value: + results: + - id: 3a1be853-5964-4afe-ad6a-fb89cbaf6606 + reference: Sub 098801 + contactRef: + id: bc446de5-971e-48b5-8efd-1745149844ef + dataType: customers + issueDate: '2023-02-14T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Long-term subscriber discount - refund on sub + accountRef: + id: a40f43e2-c7b0-4187-919a-04ccdc14a630 + name: Subscriptions + taxRateRef: + id: EXEMPTINPUT + name: Exempt Expenses + effectiveTaxRate: 0 + unitAmount: 35 + quantity: 1 + subTotal: 35 + taxAmount: 0 + totalAmount: 35 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 3a1be853-5964-4afe-ad6a-fb89cbaf6606 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2023-02-14T00:00:00' + totalAmount: 35 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-02-14T00:00:00' + totalAmount: 35 + subTotal: 35 + taxAmount: 0 + totalAmount: 35 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2011-04-11T00:45:38' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directIncomes + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List direct incomes* endpoint returns a list of [direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) for a given company's connection. + + [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are incomes received directly from the business' operations at the point of the sale. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-direct-incomes + x-speakeasy-group: accounts-receivable.direct-incomes + '/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Accounts receivable + summary: Get direct income + parameters: + - $ref: '#/components/parameters/accountingDirectIncomeId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingDirectIncome' + examples: + Clear Books: + value: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + reference: 3cb8ced3-3ecb-4974-ada5-8290b0ec3355 + note: 'Direct Income with 1 line items, totaling 188.33' + contactRef: + id: 51f03576-f6b0-40d5-9fba-81a490411c03 + dataType: customers + issueDate: '2022-04-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Yard Gully + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 171.21 + quantity: 1 + discountAmount: 0 + discountPercentage: 0 + subTotal: 171.21 + taxAmount: 17.12 + totalAmount: 188.33 + itemRef: + id: 00491160-6ee5-4d76-9f34-998f00687481 + name: Aluminium Silt Bucket + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + note: Payment for direct income 38e8c917-0afc-4583-8ffe-1b53ad601197 + reference: Direct Income 38e8c917-0afc-4583-8ffe-1b53ad601197 + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-19T00:00:00' + totalAmount: 188.33 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-19T00:00:00' + totalAmount: -188.33 + subTotal: 171.21 + taxAmount: 17.12 + totalAmount: 188.33 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-05-13T01:06:00' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 8be30162-feec-ec11-82f9-000d3a8746a9 + reference: B1234 + note: '4006' + issueDate: '2022-06-18T00:00:00' + currency: USD + currencyRate: 0.648364486 + lineItems: + - description: Interest Income + accountRef: + id: 221217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Interest Income + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + unitAmount: 7.13 + quantity: 1 + subTotal: 7.13 + taxAmount: 1.43 + totalAmount: 8.56 + trackingCategoryRefs: + - id: adbc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: ADM-Administration + paymentAllocations: + - payment: + id: 8be30162-feec-ec11-82f9-000d3a8746a9 + accountRef: + id: 8277672c-b8e6-ec11-82f8-0022481a77f0 + name: B020-BoA + currency: USD + currencyRate: 0.6483644859813084 + paidOnDate: '2022-06-18T00:00:00' + totalAmount: 8.56 + allocation: + currency: USD + currencyRate: 0.6483644859813084 + allocatedOnDate: '2022-06-18T00:00:00' + totalAmount: 8.56 + subTotal: 7.13 + taxAmount: 1.43 + totalAmount: 8.56 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-06-15T22:56:26Z' + metadata: + isDeleted: false + FreeAgent: + value: + id: '344673327' + note: Test Transaction 2 + issueDate: '2017-11-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Test Transaction 2 + accountRef: + id: '001' + name: Sales + unitAmount: 10.5 + quantity: 1 + subTotal: 10.5 + taxAmount: 0 + totalAmount: 10.5 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '344673327' + note: Test Transaction 2 + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-01T00:00:00' + totalAmount: 10.5 + allocation: + currency: GBP + allocatedOnDate: '2017-11-01T00:00:00' + totalAmount: 10.5 + subTotal: 10.5 + taxAmount: 0 + totalAmount: 10.5 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2022-10-06T10:38:24Z' + metadata: + isDeleted: false + QuickBooks Desktop: + value: + id: 9B87-1181931723 + reference: 9C08-1181931827 + contactRef: + id: 280000-933272658 + dataType: customers + issueDate: '2023-01-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 80000-933270541 + name: Undeposited Funds + unitAmount: 1228.18 + quantity: 1 + subTotal: 1228.18 + taxAmount: 0 + totalAmount: 1228.18 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 9B87-1181931723 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-15T00:00:00' + totalAmount: 1228.18 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-01-15T00:00:00' + totalAmount: 1228.18 + subTotal: 1228.18 + taxAmount: 0 + totalAmount: 1228.18 + modifiedDate: '2023-04-26T09:14:12Z' + sourceModifiedDate: '2023-12-16T05:06:23' + metadata: + isDeleted: false + QuickBooks Online Sandbox: + value: + id: 5-1 + contactRef: + id: '52' + dataType: suppliers + issueDate: '2015-11-24T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: contribution to start business + accountRef: + id: '61' + name: Owner's Equity - Contributions + taxRateRef: + id: 2_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + unitAmount: 10000 + quantity: 1 + discountAmount: 0 + subTotal: 10000 + taxAmount: 0 + totalAmount: 10000 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 5-1 + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2015-11-24T00:00:00' + totalAmount: 10000 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-11-24T00:00:00' + totalAmount: -10000 + subTotal: 10000 + taxAmount: 0 + totalAmount: 10000 + modifiedDate: '2023-04-26T09:36:04Z' + sourceModifiedDate: '2016-09-12T15:26:26Z' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '1' + note: Opening Balance from Bank + issueDate: '2018-09-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '53' + name: Retained profit balance forward account + unitAmount: 170.23 + quantity: 1 + discountAmount: 0 + subTotal: 170.23 + taxAmount: 0 + totalAmount: 170.23 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '1' + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-09-21T00:00:00' + totalAmount: 170.23 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-09-21T00:00:00' + totalAmount: -170.23 + subTotal: 170.23 + taxAmount: 0 + totalAmount: 170.23 + modifiedDate: '2023-01-18T11:02:50Z' + sourceModifiedDate: '2018-12-17T14:56:20Z' + Sage Intacct: + value: + id: '4973' + reference: dt test contact + note: dt header description + issueDate: '2022-03-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Dt test line1 + accountRef: + id: '151' + name: Cash + taxRateRef: + id: '99' + name: UK Sale Goods Standard Rate + effectiveTaxRate: 20 + unitAmount: 125 + quantity: 1 + subTotal: 125 + taxAmount: 25 + totalAmount: 150 + trackingCategoryRefs: + - id: DEPARTMENT-1 + name: Sales + - id: LOCATION-8 + name: United Kingdom + - description: dt test line 2 + accountRef: + id: '152' + name: Cash Equivalents + taxRateRef: + id: '99' + name: UK Sale Goods Standard Rate + effectiveTaxRate: 20 + unitAmount: 166.67 + quantity: 1 + subTotal: 166.67 + taxAmount: 33.33 + totalAmount: 200 + trackingCategoryRefs: + - id: DEPARTMENT-2 + name: Services + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '4973' + note: dt header description + accountRef: + id: '289' + name: Checking 5 - Bank Of England + currency: GBP + paidOnDate: '2022-03-15T00:00:00' + totalAmount: 350 + allocation: + currency: GBP + allocatedOnDate: '2022-03-15T00:00:00' + totalAmount: 350 + subTotal: 291.67 + taxAmount: 58.33 + totalAmount: 350 + modifiedDate: '2022-10-28T11:10:26Z' + sourceModifiedDate: '2022-03-15T12:45:58Z' + Xero: + value: + id: 3a1be853-5964-4afe-ad6a-fb89cbaf6606 + reference: Sub 098801 + contactRef: + id: bc446de5-971e-48b5-8efd-1745149844ef + dataType: customers + issueDate: '2023-02-14T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Long-term subscriber discount - refund on sub + accountRef: + id: a40f43e2-c7b0-4187-919a-04ccdc14a630 + name: Subscriptions + taxRateRef: + id: EXEMPTINPUT + name: Exempt Expenses + effectiveTaxRate: 0 + unitAmount: 35 + quantity: 1 + subTotal: 35 + taxAmount: 0 + totalAmount: 35 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 3a1be853-5964-4afe-ad6a-fb89cbaf6606 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2023-02-14T00:00:00' + totalAmount: 35 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-02-14T00:00:00' + totalAmount: 35 + subTotal: 35 + taxAmount: 0 + totalAmount: 35 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2011-04-11T00:45:38' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get direct income* endpoint returns a single direct income for a given directIncomeId. + + [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are incomes received directly from the business' operations at the point of the sale. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-direct-income + x-speakeasy-group: accounts-receivable.direct-incomes + '/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectIncomeId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts receivable + summary: Get direct income attachment + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Get direct income attachment* endpoint returns a specific attachment for a given `directIncomeId` and `attachmentId`. + + [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are incomes received directly from the business' operations at the point of the sale. + operationId: get-accounting-direct-income-attachment + x-speakeasy-group: accounts-receivable.direct-incomes + '/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectIncomeId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts receivable + summary: Download direct income attachment + parameters: + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Download direct income attachment* endpoint downloads a specific attachment for a given `directIncomeId` and `attachmentId`. + + [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are incomes received directly from the business' operations at the point of the sale. + operationId: download-accounting-direct-income-attachment + x-speakeasy-group: accounts-receivable.direct-incomes + '/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectIncomeId' + get: + tags: + - Accounts receivable + summary: List direct income attachments + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List direct income attachments* endpoint returns a list of attachments available to download for given `directIncomeId`. + + [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are incomes received directly from the business' operations at the point of the sale. + operationId: list-accounting-direct-income-attachments + x-speakeasy-group: accounts-receivable.direct-incomes + '/companies/{companyId}/data/info': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: Get company accounting profile + description: Gets the latest basic info for a company. + operationId: get-accounting-profile + x-speakeasy-name-override: get-accounting-profile + tags: + - Company info + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCompanyInfo' + examples: + Example 1: + value: + companyName: Codat + accountingPlatformRef: 1700060034_ETD + companyLegalName: Codat Ltd + addresses: + - type: Billing + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + region: England + country: United Kingdom + postalCode: WC1X 0BE + - type: Delivery + line1: 28 Easton Street + city: London + country: UK + postalCode: WC1X 0BE + phoneNumbers: + - number: 02012 345678 + type: Landline + - number: 07123 456789 + type: Mobile + - number: 02012 345678 + type: Fax + webLinks: + - type: Website + url: 'https://www.codat.io/' + - type: Social + url: 'https://www.linkedin.com/company/codat-limited/' + registrationNumber: '5590111724' + taxNumber: '74111622555799035846' + financialYearStartDate: '2023-04-01T00:00:00' + baseCurrency: GBP + sourceUrls: + Api: 'https://api.codat.io' + createdDate: '2020-03-09T15:19:26' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/invoices': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + summary: List invoices + description: | + The *List invoices* endpoint returns a list of [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) for a given company's connection. + + [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + ### Useful queries + + - Outstanding invoices - `query = amountDue > 0` + - Invoices due after a certain date: `query = dueDate > 2021-01-28` + + [Read more about querying](https://docs.codat.io/using-the-api/querying). + + ### Tips and traps + + To access the `paymentAllocations` property, ensure that the `payments` data type is queued and cached in Codat before retrieving `invoices` from Codat's cache. + operationId: list-accounting-invoices + x-speakeasy-group: accounts-receivable.invoices + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingInvoices' + examples: + Clear Books: + value: + results: + - id: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + invoiceNumber: TKj7oD38 + customerRef: + id: d65ac505-072c-49ec-be3c-3cb74228966d + companyName: Jensen Steuber + salesOrderRefs: [] + issueDate: '2022-04-25T13:04:02' + dueDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2023-01-28T14:41:02' + paidOnDate: '2022-04-25T13:04:02' + currency: GBP + currencyRate: 1 + lineItems: + - description: Heavy Duty Hinged Gully Grating x4.00 + unitAmount: 402.89 + quantity: 4 + subTotal: 1611.56 + taxAmount: 161.16 + totalAmount: 1772.72 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + name: Heavy Duty Hinged Gully Grating + trackingCategoryRefs: + - id: costcode_9 + name: PandaConstruction + isDirectIncome: true + paymentAllocations: + - payment: + id: 9407d5ee-893a-4547-bd89-bc7b795ee774 + note: Payment against invoice 2518ca08-5e2a-4630-8cee-a6bcd1625660 + reference: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-25T13:04:02' + totalAmount: 1772.72 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + totalAmount: -1772.72 + withholdingTax: [] + totalDiscount: 0 + subTotal: 1611.56 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 161.16 + totalAmount: 1772.72 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + - id: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + invoiceNumber: 4F6ONfFP + customerRef: + id: a82042f1-a005-4ca5-bfd3-5bc237123aa5 + companyName: Keara Leffler + salesOrderRefs: [] + issueDate: '2022-04-25T13:04:02' + dueDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-08-22T07:43:02' + paidOnDate: '2022-04-25T13:04:02' + currency: GBP + currencyRate: 1 + lineItems: + - description: Heavy Duty Hinged Gully Grating x8.28 + unitAmount: 402.89 + quantity: 8.28 + subTotal: 3335.93 + taxAmount: 333.59 + totalAmount: 3669.52 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + name: Heavy Duty Hinged Gully Grating + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 7ba4fc1b-e248-49ba-8bf8-0813d7f203a8 + note: Payment against invoice ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + reference: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-25T13:04:02' + totalAmount: 3669.52 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + totalAmount: -3669.52 + withholdingTax: [] + totalDiscount: 0 + subTotal: 3335.93 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 333.59 + totalAmount: 3669.52 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 142 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/invoices?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/invoices + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/invoices?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 18c906bf-89d1-ea11-bbaa-000d3a2b9185 + invoiceNumber: '103001' + customerRef: + id: b61217b3-89d1-ea11-bbaa-000d3a2b9185 + companyName: Trey Researches + salesOrderRefs: [] + issueDate: '2019-01-15T00:00:00' + dueDate: '2019-01-15T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-17T16:29:00Z' + paidOnDate: '2019-01-15T00:00:00' + currency: GBP + lineItems: + - description: AMSTERDAM Lamp + unitAmount: 35.6 + quantity: 3 + discountAmount: 0 + subTotal: 106.8 + taxAmount: 21.36 + totalAmount: 128.16 + accountRef: + id: 181217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 'Income, Product Sales' + discountPercentage: 0 + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-d41217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'AMSTERDAM Lamp / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: e0299ced-89d1-ea11-bbaa-000d3a2b9185 + note: Invoice 102001 + reference: 'Document No: 103001' + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + currency: GBP + currencyRate: 1 + paidOnDate: '2019-01-15T00:00:00' + totalAmount: 128.16 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-01-15T00:00:00' + totalAmount: -128.16 + withholdingTax: [] + totalDiscount: 0 + subTotal: 106.8 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 21.36 + totalAmount: 128.16 + amountDue: 0 + discountPercentage: 0 + status: Paid + note: '' + metadata: + isDeleted: false + - id: 31e97827-bb18-ed11-90eb-000d3a8747a0 + invoiceNumber: '102287' + customerRef: + id: 0ef95175-48c4-eb11-9f0a-0022481b4343 + companyName: '' + salesOrderRefs: [] + issueDate: '2019-01-15T00:00:00' + dueDate: '2019-01-15T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-08-10T14:46:08Z' + currency: USD + lineItems: [] + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 0 + amountDue: 0 + discountPercentage: 0 + status: Draft + note: '' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 368 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/invoices?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/invoices + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/invoices?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 91dccc63-b1af-4363-bee0-2aec6bab1bef + invoiceNumber: '19700002' + customerRef: + id: c3bf08a3-4d51-4859-acbb-5075f9484f87 + companyName: Mr Abe + salesOrderRefs: [] + issueDate: '2019-11-08T00:00:00Z' + dueDate: '2019-11-29T00:00:00Z' + modifiedDate: '2022-10-26T13:57:52Z' + sourceModifiedDate: '2019-11-08T11:56:22Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Consultancy per uur - Consultancy per uur + unitAmount: 75 + quantity: 8 + discountAmount: 0 + subTotal: 600 + taxAmount: 0 + totalAmount: 600 + accountRef: + id: 2421e8a0-5355-4ec0-af11-021fe4f39fcd + name: Omzet binnenland hoog tarief + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 600 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 600 + amountDue: 599 + discountPercentage: 0 + status: PartiallyPaid + - id: 0078bc15-10a4-433d-86fa-b1bb235fc0ab + invoiceNumber: '19700004' + customerRef: + id: 46951dc4-a170-42ce-bb38-9a80b776404f + companyName: Cust 03 + salesOrderRefs: [] + issueDate: '2019-11-13T00:00:00Z' + dueDate: '2019-12-04T00:00:00Z' + modifiedDate: '2022-10-26T13:57:52Z' + sourceModifiedDate: '2019-11-13T11:47:51Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Standaard artikel - Standaard artikel + unitAmount: 25 + quantity: 1 + discountAmount: 0 + subTotal: 25 + taxAmount: 5.25 + totalAmount: 30.25 + accountRef: + id: 2421e8a0-5355-4ec0-af11-021fe4f39fcd + name: Omzet binnenland hoog tarief + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 25 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 5.25 + totalAmount: 30.25 + amountDue: 30.25 + discountPercentage: 0 + status: Submitted + pageNumber: 1 + pageSize: 2 + totalResults: 5844 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/invoices?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/invoices + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/invoices?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: a05d1256-f253-46bd-aa13-c6f6a992aa47 + invoiceNumber: '17700002' + customerRef: + id: 570321bb-8b0c-49f1-a1f5-6fb1d6d94a62 + companyName: Some customer + salesOrderRefs: [] + issueDate: '2017-08-02T00:00:00Z' + dueDate: '2017-09-01T00:00:00Z' + modifiedDate: '2022-10-26T13:39:08Z' + sourceModifiedDate: '2017-08-02T18:23:43Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: A bunch of stuff - A bunch of stuff + unitAmount: 100 + quantity: 1000 + discountAmount: 0 + subTotal: 100000 + taxAmount: 0 + totalAmount: 100000 + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 100000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 100000 + amountDue: 0 + discountPercentage: 0 + status: Paid + - id: 0981b5d1-a817-40be-a101-4848f7b1a258 + invoiceNumber: '17700004' + customerRef: + id: 570321bb-8b0c-49f1-a1f5-6fb1d6d94a62 + companyName: Some customer + salesOrderRefs: [] + issueDate: '2017-08-03T00:00:00Z' + dueDate: '2017-09-02T00:00:00Z' + modifiedDate: '2022-10-26T13:39:08Z' + sourceModifiedDate: '2017-08-03T12:22:27Z' + paidOnDate: '2017-08-03T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: A bunch of stuff - A bunch of stuff + unitAmount: 100 + quantity: 150 + discountAmount: 0 + subTotal: 15000 + taxAmount: 0 + totalAmount: 15000 + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 15000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 15000 + amountDue: 0 + discountPercentage: 0 + status: Paid + pageNumber: 1 + pageSize: 2 + totalResults: 4214 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/invoices?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/invoices + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/invoices?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '50541736' + invoiceNumber: '2348' + customerRef: + id: '10123537' + companyName: _Test 1 + salesOrderRefs: [] + issueDate: '2016-12-30T00:00:00' + dueDate: '2016-12-30T00:00:00' + modifiedDate: '2023-04-25T14:19:19Z' + sourceModifiedDate: '2022-10-20T14:28:00Z' + paidOnDate: '2020-11-05T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 3.0 items with VatPercentage of 0.0 + unitAmount: 25.26 + quantity: 1 + discountAmount: 0 + subTotal: 25.26 + taxAmount: 0 + totalAmount: 25.26 + accountRef: + id: '001' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + - description: 3 service charges with 0.0% vat + unitAmount: 8.85 + quantity: 1 + discountAmount: 0 + subTotal: 8.85 + taxAmount: 0 + totalAmount: 8.85 + accountRef: + id: '001' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + - description: Tax + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '262466203' + note: E2E Test transaction 2 CREDIT �250.00 - Invoice receipt against 2348 + currency: GBP + paidOnDate: '2020-11-05T00:00:00' + totalAmount: 250 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.11 + withholdingTax: [] + subTotal: 34.11 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 34.11 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + - id: '21974783' + invoiceNumber: '023' + customerRef: + id: '6162023' + companyName: Alderley plc + salesOrderRefs: [] + issueDate: '2017-01-09T00:00:00' + dueDate: '2017-02-08T00:00:00' + modifiedDate: '2023-04-25T14:19:19Z' + sourceModifiedDate: '2023-02-06T15:31:38Z' + paidOnDate: '2023-02-06T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Laptop + unitAmount: 500 + quantity: 22 + discountAmount: 0 + subTotal: 11000 + taxAmount: 0 + totalAmount: 11000 + accountRef: + id: '001' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + - description: Tax + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '154350605' + note: Test Push Transaction OTHER �123.46 - Invoice receipt against 023 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2018-08-26T00:00:00' + totalAmount: 123.46 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -2 + - payment: + id: '154350605' + note: Test Push Transaction OTHER �123.46 - Invoice receipt against 023 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2018-08-26T00:00:00' + totalAmount: 123.46 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: '214509356' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214338075' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214327399' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214327371' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214672049' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-22T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214671769' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-22T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214671495' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-22T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214671482' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-22T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214671308' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-22T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216167014' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '215687795' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216167064' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-12-02T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256992092' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256991833' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256991177' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256987893' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256987069' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256983353' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256982947' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256955690' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256953648' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216464177' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216453277' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216453273' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216168092' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216168080' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '260537850' + note: E2E Test transaction 19 DEBIT �250.00 - E2 E Test Transaction 19 - E2 E Test Transaction 19 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2020-10-23T00:00:00' + totalAmount: 235 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -225 + - payment: + id: '413909805' + note: �1.00 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2023-02-06T00:00:00' + totalAmount: 1 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1 + withholdingTax: [] + subTotal: 11000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 11000 + amountDue: 10766.74 + status: PartiallyPaid + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1449 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/invoices?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/invoices + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/invoices?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '2596455' + invoiceNumber: test-AL + customerRef: + id: '602174' + companyName: ab1 + salesOrderRefs: [] + issueDate: '1987-10-01T00:00:00' + dueDate: '1987-10-01T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2023-03-03T09:27:42' + paidOnDate: '2023-03-03T00:00:00' + currency: USD + lineItems: + - description: Editing creative writing for a client + unitAmount: 222.88 + quantity: 1 + discountAmount: 0 + subTotal: 222.88 + taxAmount: 0 + totalAmount: 222.88 + itemRef: + id: '639579' + name: Creative Writing Editorial + trackingCategoryRefs: [] + isDirectIncome: false + - description: '' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '2570292' + note: '' + currency: USD + paidOnDate: '2023-03-03T00:00:00' + totalAmount: 0.17 + allocation: + currency: USD + currencyRate: 1 + totalAmount: -0.17 + withholdingTax: [] + totalDiscount: 0 + subTotal: 222.88 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 222.88 + amountDue: 222.71 + status: Submitted + note: '' + metadata: + isDeleted: false + - id: '2396753' + invoiceNumber: '0000062' + customerRef: + id: '512927' + companyName: Wood Turnerss + salesOrderRefs: [] + issueDate: '2016-04-04T00:00:00' + dueDate: '2016-04-04T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-02-24T07:34:31' + currency: GBP + lineItems: [] + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 0 + amountDue: 0 + status: Submitted + note: '' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 172 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/invoices?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/invoices + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/invoices?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '143008521' + invoiceNumber: '40' + customerRef: + id: '86832299' + companyName: Mr French Person + salesOrderRefs: [] + issueDate: '2005-12-15T00:00:00' + dueDate: '2006-01-12T00:00:00' + modifiedDate: '2022-09-30T10:29:15Z' + currency: EUR + currencyRate: 0.844737287 + lineItems: + - unitAmount: 0 + quantity: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: '0' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 0 + amountDue: 0 + status: Paid + - id: '143008597' + invoiceNumber: '41' + customerRef: + id: '86832299' + companyName: Mr French Person + salesOrderRefs: [] + issueDate: '2010-01-01T00:00:00' + dueDate: '2010-01-29T00:00:00' + modifiedDate: '2022-09-30T10:29:15Z' + paidOnDate: '2020-11-03T00:00:00' + currency: EUR + currencyRate: 0.844737287 + lineItems: + - unitAmount: 0 + quantity: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: '0' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '146438947' + note: '' + currency: EUR + paidOnDate: '2020-11-03T00:00:00' + totalAmount: 0 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: 0 + withholdingTax: [] + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 0 + amountDue: 0 + status: Paid + pageNumber: 1 + pageSize: 2 + totalResults: 37 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/invoices?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/invoices + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/invoices?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '416' + invoiceNumber: INV01 + customerRef: + id: '417' + companyName: 10 Breww Ltd + salesOrderRefs: [] + issueDate: '2021-04-09T00:00:00' + dueDate: '2021-04-30T00:00:00' + modifiedDate: '2022-09-20T08:16:10Z' + sourceModifiedDate: '2021-08-25T15:55:36' + paidOnDate: '2021-04-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Non-Recurring Services - EC + unitAmount: 100 + quantity: 1 + subTotal: 100 + totalAmount: 100 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: location-1 + isDirectIncome: false + paymentAllocations: + - payment: + id: '428' + reference: 'Payment #PYMT01' + accountRef: + id: '122' + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2021-04-20T00:00:00' + totalAmount: 90 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '428' + reference: 'Payment #PYMT01' + accountRef: + id: '122' + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2021-04-20T00:00:00' + totalAmount: 90 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -90 + withholdingTax: [] + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 100 + amountDue: 0 + status: Paid + - id: '8529' + invoiceNumber: INV63 + customerRef: + id: '417' + companyName: 10 Breww Ltd + salesOrderRefs: [] + issueDate: '2021-04-09T00:00:00' + dueDate: '2021-04-30T00:00:00' + modifiedDate: '2022-09-20T08:16:10Z' + sourceModifiedDate: '2022-02-24T13:51:58' + paidOnDate: '2022-09-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Andy Test Item + unitAmount: 2 + quantity: 3 + subTotal: 6 + totalAmount: 6 + accountRef: + id: '54' + name: Sales + itemRef: + id: '143' + name: Andy Test Item + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + - description: Non-Recurring Services - EC + unitAmount: 4 + quantity: 5 + subTotal: 20 + totalAmount: 20 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + paymentAllocations: + - payment: + id: '17588' + note: Payment Example - Invoice allocation + reference: 'Payment #PYMT90' + accountRef: + id: '1' + name: Cheque Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-06-01T00:00:00' + totalAmount: 10 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '17589' + note: Example - Payment of an invoice + reference: 'Payment #PYMT91' + accountRef: + id: '1' + name: Cheque Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-06-01T00:00:00' + totalAmount: 20 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '24558' + note: Test Push Payments - 1 test + reference: 'Payment #PYMT109' + accountRef: + id: '1' + name: Cheque Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-09-12T00:00:00' + totalAmount: 0.1 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.1 + - payment: + id: '24659' + note: Test Push Payments - 1 test + reference: 'Payment #PYMT111' + accountRef: + id: '1' + name: Cheque Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-09-12T00:00:00' + totalAmount: 0.1 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.1 + withholdingTax: [] + totalDiscount: 0 + subTotal: 26 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 26 + amountDue: 5.8 + status: PartiallyPaid + pageNumber: 1 + pageSize: 2 + totalResults: 107 + _links: + current: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/invoices?page=1&pageSize=2 + self: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/invoices + next: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/invoices?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 2453-1071526256 + invoiceNumber: '975' + customerRef: + id: 420000-1071522044 + companyName: 'Prentice, Adelaide' + salesOrderRefs: [] + issueDate: '2022-11-28T00:00:00' + dueDate: '2023-12-28T00:00:00' + modifiedDate: '2023-04-26T09:08:12Z' + sourceModifiedDate: '2023-12-16T05:06:11' + paidOnDate: '2023-01-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Foundation slab - prep and pouring + unitAmount: 167.5 + quantity: 1 + subTotal: 167.5 + taxAmount: 0 + totalAmount: 167.5 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 320000-1071525597 + name: Concrete Slab + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - unitAmount: 0 + quantity: 1 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Rough lumber + unitAmount: 48 + quantity: 1 + subTotal: 48 + taxAmount: 0 + totalAmount: 48 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1C0000-933272656 + name: 'Lumber:Rough' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Trim lumber + unitAmount: 38 + quantity: 1 + subTotal: 38 + taxAmount: 0 + totalAmount: 38 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1D0000-933272656 + name: 'Lumber:Trim' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Window + unitAmount: 25 + quantity: 2 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Flooring + unitAmount: 50 + quantity: 1 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 310000-1071509547 + name: Flooring + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Window + unitAmount: 30 + quantity: 2 + subTotal: 60 + taxAmount: 0 + totalAmount: 60 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + paymentAllocations: + - payment: + id: 6973-1197775625 + note: Check - 80000-933270541 + reference: '983409' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-15T00:00:00' + totalAmount: 431.95 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -431.95 + withholdingTax: [] + totalDiscount: 0 + subTotal: 413.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 18.45 + totalAmount: 431.95 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + - id: '469E-1071530054' + invoiceNumber: '978' + customerRef: + id: 220000-933272658 + companyName: 'Melton, Johnny' + salesOrderRefs: [] + issueDate: '2022-11-30T00:00:00' + dueDate: '2023-12-30T00:00:00' + modifiedDate: '2023-04-26T09:08:12Z' + sourceModifiedDate: '2023-12-16T05:06:09' + paidOnDate: '2023-01-10T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: See attached specification for details on work below. + unitAmount: 0 + quantity: 1 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - unitAmount: 0 + quantity: 1 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Installation labor + unitAmount: 45.5 + quantity: 1 + subTotal: 45.5 + taxAmount: 0 + totalAmount: 45.5 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 20000-933272655 + name: Installation + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Install drywall + unitAmount: 1320 + quantity: 1 + subTotal: 1320 + taxAmount: 0 + totalAmount: 1320 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 70000-933272656 + name: 'Subs:Drywall' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Electrical work + unitAmount: 1650 + quantity: 1 + subTotal: 1650 + taxAmount: 0 + totalAmount: 1650 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 80000-933272656 + name: 'Subs:Electrical' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Metal Work + unitAmount: 660 + quantity: 1 + subTotal: 660 + taxAmount: 0 + totalAmount: 660 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: A0000-933272656 + name: 'Subs:Metal Wrk' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Install insulation + unitAmount: 1100 + quantity: 1 + subTotal: 1100 + taxAmount: 0 + totalAmount: 1100 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 90000-933272656 + name: 'Subs:Insulating' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Plumbing + unitAmount: 1650 + quantity: 1 + subTotal: 1650 + taxAmount: 0 + totalAmount: 1650 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: C0000-933272656 + name: 'Subs:Plumbing' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Painting + unitAmount: 2420 + quantity: 1 + subTotal: 2420 + taxAmount: 0 + totalAmount: 2420 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: B0000-933272656 + name: 'Subs:Painting' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Install carpeting + unitAmount: 3300 + quantity: 1 + subTotal: 3300 + taxAmount: 0 + totalAmount: 3300 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 60000-933272656 + name: 'Subs:Carpet' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Custom Bay Window + unitAmount: 1925 + quantity: 1 + subTotal: 1925 + taxAmount: 0 + totalAmount: 1925 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Window + unitAmount: 115.5 + quantity: 1 + subTotal: 115.5 + taxAmount: 0 + totalAmount: 115.5 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Equipment Rental + unitAmount: 700 + quantity: 1 + subTotal: 700 + taxAmount: 0 + totalAmount: 700 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 230000-933272656 + name: Equip Rental + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: 10% retainage to be billed after job is complete and approved. + unitAmount: -555.5 + quantity: 1 + subTotal: -555.5 + taxAmount: 0 + totalAmount: -555.5 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 260000-933272656 + name: Retainage 1 + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + paymentAllocations: + - payment: + id: 6915-1197775450 + note: Check - 80000-933270541 + reference: '19650' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-10T00:00:00' + totalAmount: 14488.64 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -14488.64 + withholdingTax: [] + totalDiscount: 0 + subTotal: 14330.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 158.14 + totalAmount: 14488.64 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 113 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/invoices?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/invoices + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/invoices?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '16' + invoiceNumber: '1001' + customerRef: + id: '3' + companyName: Information Sharing Technology + salesOrderRefs: [] + issueDate: '2019-02-18T00:00:00' + dueDate: '2019-03-20T00:00:00' + modifiedDate: '2023-01-18T11:03:02Z' + sourceModifiedDate: '2022-09-20T10:12:08Z' + paidOnDate: '2020-06-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Service + unitAmount: 500 + quantity: 10 + subTotal: 5000 + taxAmount: 0 + totalAmount: 5000 + accountRef: + id: '1' + name: Sales + itemRef: + id: '1' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '500' + note: Payments of type PrepaidPayment + reference: '498254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 37.77 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -37.77 + - payment: + id: '507' + note: Payments of type PrepaidPayment + reference: '505288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 62.82 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -54.62 + - payment: + id: '499' + note: Payments of type Cash + reference: '498147' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 1017 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5.08 + - payment: + id: '491' + note: Payments of type PrepaidPayment + reference: '489239' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-18T00:00:00' + totalAmount: 48.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -48.74 + - payment: + id: '490' + note: Payments of type Cash + reference: '489120' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-18T00:00:00' + totalAmount: 1112.76 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.74 + - payment: + id: '482' + note: Payments of type PrepaidPayment + reference: '480242' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-17T00:00:00' + totalAmount: 33.9 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.9 + - payment: + id: '481' + note: Payments of type Cash + reference: '480129' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-17T00:00:00' + totalAmount: 965.85 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.21 + - payment: + id: '470' + note: Payments of type PrepaidPayment + reference: '468248' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 67.83 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -41.38 + - payment: + id: '463' + note: Payments of type PrepaidPayment + reference: '461243' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 7.47 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.47 + - payment: + id: '462' + note: Payments of type Cash + reference: '461144' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 914.05 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.76 + - payment: + id: '456' + note: Payments of type PrepaidPayment + reference: '454252' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 70.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.72 + - payment: + id: '447' + note: Payments of type PrepaidPayment + reference: '445278' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 24.95 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -24.95 + - payment: + id: '446' + note: Payments of type Cash + reference: '44518' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 904.82 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.96 + - payment: + id: '438' + note: Payments of type PrepaidPayment + reference: '436234' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-10T00:00:00' + totalAmount: 6.03 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.03 + - payment: + id: '437' + note: Payments of type Cash + reference: '436168' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-10T00:00:00' + totalAmount: 760.05 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -31.48 + - payment: + id: '647' + note: Payments of type PrepaidPayment + reference: '645263' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-03-20T00:00:00' + totalAmount: 40.43 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '429' + note: Payments of type PrepaidPayment + reference: '427270' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-09T00:00:00' + totalAmount: 56.75 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -28.75 + - payment: + id: '420' + note: Payments of type PrepaidPayment + reference: '418258' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-08T00:00:00' + totalAmount: 8.92 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.92 + - payment: + id: '419' + note: Payments of type Cash + reference: '418157' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-08T00:00:00' + totalAmount: 407.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -2.55 + - payment: + id: '705' + note: Payments of type PrepaidPayment + reference: '703246' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-03T00:00:00' + totalAmount: 25 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25 + - payment: + id: '411' + note: Payments of type PrepaidPayment + reference: '409292' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-07T00:00:00' + totalAmount: 6.22 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.22 + - payment: + id: '410' + note: Payments of type Cash + reference: '409145' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-07T00:00:00' + totalAmount: 725.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.79 + - payment: + id: '772' + note: Payments of type PrepaidPayment + reference: '770263' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-24T00:00:00' + totalAmount: 10.35 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '779' + note: Payments of type PrepaidPayment + reference: '777217' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-24T00:00:00' + totalAmount: 39.55 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '792' + note: Payments of type PrepaidPayment + reference: '790262' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-29T00:00:00' + totalAmount: 12.46 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '402' + note: Payments of type PrepaidPayment + reference: '400275' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-06T00:00:00' + totalAmount: 32.88 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -29.29 + - payment: + id: '393' + note: Payments of type PrepaidPayment + reference: '391247' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 16.73 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.73 + - payment: + id: '392' + note: Payments of type Cash + reference: '391115' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 1094.8 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -47.35 + - payment: + id: '386' + note: Payments of type PrepaidPayment + reference: '384213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-04T00:00:00' + totalAmount: 9.99 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -9.99 + - payment: + id: '385' + note: Payments of type Cash + reference: '38418' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-04T00:00:00' + totalAmount: 858.41 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.4 + - payment: + id: '377' + note: Payments of type PrepaidPayment + reference: '375298' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-03T00:00:00' + totalAmount: 39.06 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -39.06 + - payment: + id: '376' + note: Payments of type Cash + reference: '375123' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-03T00:00:00' + totalAmount: 802.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.54 + - payment: + id: '368' + note: Payments of type PrepaidPayment + reference: '366288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-02T00:00:00' + totalAmount: 12.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -12.15 + - payment: + id: '367' + note: Payments of type Cash + reference: '366195' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-02T00:00:00' + totalAmount: 827.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25.4 + - payment: + id: '361' + note: Payments of type PrepaidPayment + reference: '359220' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-01T00:00:00' + totalAmount: 54.12 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -40.61 + - payment: + id: '349' + note: Payments of type PrepaidPayment + reference: '347216' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-31T00:00:00' + totalAmount: 25.32 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25.32 + - payment: + id: '348' + note: Payments of type Cash + reference: '34710' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-31T00:00:00' + totalAmount: 949.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.07 + - payment: + id: '342' + note: Payments of type PrepaidPayment + reference: '340292' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 26.59 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -26.59 + - payment: + id: '341' + note: Payments of type Cash + reference: '340128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 859.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -29.21 + - payment: + id: '333' + note: Payments of type PrepaidPayment + reference: '331236' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 17.94 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.58 + - payment: + id: '322' + note: Payments of type PrepaidPayment + reference: '320256' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 14.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -14.33 + - payment: + id: '321' + note: Payments of type Cash + reference: '320186' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 798.79 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.08 + - payment: + id: '313' + note: Payments of type PrepaidPayment + reference: '311211' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 45.06 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -41.47 + - payment: + id: '304' + note: Payments of type PrepaidPayment + reference: '302284' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-28T00:00:00' + totalAmount: 17.04 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.04 + - payment: + id: '303' + note: Payments of type Cash + reference: '302128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-28T00:00:00' + totalAmount: 837.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.66 + - payment: + id: '297' + note: Payments of type PrepaidPayment + reference: '295264' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-27T00:00:00' + totalAmount: 14.92 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -14.92 + - payment: + id: '296' + note: Payments of type Cash + reference: '295176' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-27T00:00:00' + totalAmount: 687.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4.18 + - payment: + id: '288' + note: Payments of type PrepaidPayment + reference: '286250' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-26T00:00:00' + totalAmount: 12.73 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -12.73 + - payment: + id: '287' + note: Payments of type Cash + reference: '286188' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-26T00:00:00' + totalAmount: 539.55 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.97 + - payment: + id: '279' + note: Payments of type PrepaidPayment + reference: '277281' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-25T00:00:00' + totalAmount: 30.58 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -30.58 + - payment: + id: '278' + note: Payments of type Cash + reference: '277153' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-25T00:00:00' + totalAmount: 1063.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -37.08 + - payment: + id: '270' + note: Payments of type PrepaidPayment + reference: '268269' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 11.69 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.69 + - payment: + id: '269' + note: Payments of type Cash + reference: '268154' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 968.21 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -48.58 + - payment: + id: '263' + note: Payments of type PrepaidPayment + reference: '261215' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 7.24 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.24 + - payment: + id: '262' + note: Payments of type Cash + reference: '261162' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 425.69 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.02 + - payment: + id: '256' + note: Payments of type PrepaidPayment + reference: '254258' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 37.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.6 + - payment: + id: '249' + note: Payments of type PrepaidPayment + reference: '247245' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 22.03 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.84 + - payment: + id: '240' + note: Payments of type PrepaidPayment + reference: '238213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 47.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -31.98 + - payment: + id: '231' + note: Payments of type Prepaid + reference: '229276' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 38.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -30.52 + - payment: + id: '218' + note: Payments of type Prepaid + reference: '216237' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-22T00:00:00' + totalAmount: 19.67 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -19.67 + - payment: + id: '217' + note: Payments of type Cash + reference: '216161' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-22T00:00:00' + totalAmount: 565.24 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1.66 + - payment: + id: '209' + note: Payments of type Prepaid + reference: '207254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-21T00:00:00' + totalAmount: 27.62 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.62 + - payment: + id: '208' + note: Payments of type Cash + reference: '207189' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-21T00:00:00' + totalAmount: 914.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.86 + - payment: + id: '200' + note: Payments of type Prepaid + reference: '198234' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 18.35 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.35 + - payment: + id: '199' + note: Payments of type Cash + reference: '198128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 1209.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -20.22 + - payment: + id: '191' + note: Payments of type Prepaid + reference: '18922' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 16.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.44 + - payment: + id: '190' + note: Payments of type Cash + reference: '189174' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 607.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.34 + - payment: + id: '182' + note: Payments of type Prepaid + reference: '180274' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 47.91 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -47.91 + - payment: + id: '181' + note: Payments of type Cash + reference: '180197' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 1087.13 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.04 + - payment: + id: '173' + note: Payments of type Prepaid + reference: '171213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 35.36 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -26.29 + - payment: + id: '166' + note: Payments of type Prepaid + reference: '164260' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 39.98 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -39.98 + - payment: + id: '165' + note: Payments of type Cash + reference: '164142' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 913.09 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.99 + - payment: + id: '157' + note: Payments of type Prepaid + reference: '155266' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 14.32 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4.87 + - payment: + id: '150' + note: Payments of type Prepaid + reference: '148217' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 11.57 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.57 + - payment: + id: '149' + note: Payments of type Cash + reference: '148151' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 643.97 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -22.26 + - payment: + id: '141' + note: Payments of type Prepaid + reference: '139288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 27.88 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.88 + - payment: + id: '140' + note: Payments of type Cash + reference: '139163' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 1078.72 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.71 + - payment: + id: '132' + note: Payments of type Prepaid + reference: '13022' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 47.38 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -42.36 + - payment: + id: '123' + note: Payments of type Prepaid + reference: '121293' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 34.45 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.45 + - payment: + id: '122' + note: Payments of type Cash + reference: '121197' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 771.61 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.31 + - payment: + id: '116' + note: Payments of type Prepaid + reference: '114213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 65.77 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -23.86 + - payment: + id: '521' + note: Payments of type PrepaidPayment + reference: '519243' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 14.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '843' + note: Payments of type PrepaidPayment + reference: '841264' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-07T00:00:00' + totalAmount: 25.64 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '850' + note: Payments of type PrepaidPayment + reference: '848254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-14T00:00:00' + totalAmount: 53.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '877' + note: Payments of type PrepaidPayment + reference: '875210' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-06-01T00:00:00' + totalAmount: 12.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + withholdingTax: [] + totalDiscount: 0 + subTotal: 5000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 5000 + amountDue: 3296.44 + status: PartiallyPaid + note: Invoice for service + - id: '17' + invoiceNumber: '1002' + customerRef: + id: '2' + companyName: Software Coperation + salesOrderRefs: [] + issueDate: '2019-02-18T00:00:00' + dueDate: '2019-03-20T00:00:00' + modifiedDate: '2023-01-18T11:03:02Z' + sourceModifiedDate: '2019-02-21T17:51:49Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: IT Support + unitAmount: 80 + quantity: 40 + subTotal: 3200 + taxAmount: 0 + totalAmount: 3200 + accountRef: + id: '1' + name: Sales + itemRef: + id: '2' + name: Hours + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 0 + subTotal: 3200 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 3200 + amountDue: 3200 + status: Submitted + pageNumber: 1 + pageSize: 2 + totalResults: 1326 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/invoices?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/invoices + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/invoices?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '30' + invoiceNumber: '1002' + customerRef: + id: '59' + companyName: Ecker Holiday event + salesOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-02-05T00:00:00' + modifiedDate: '2023-04-26T09:36:12Z' + sourceModifiedDate: '2023-01-25T13:49:52Z' + paidOnDate: '2016-02-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Holiday party - gold level test v1 + unitAmount: 2000 + quantity: 1 + subTotal: 2000 + taxAmount: 400 + totalAmount: 2400 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '7' + name: Gold party + trackingCategoryRefs: [] + isDirectIncome: false + - description: Venue rental + unitAmount: 10000 + quantity: 1 + subTotal: 10000 + taxAmount: 2000 + totalAmount: 12000 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '20' + name: Venue Rental + trackingCategoryRefs: [] + isDirectIncome: false + - description: promotional items -- misc engraved items + unitAmount: 13.5 + quantity: 75 + subTotal: 1012.5 + taxAmount: 202.5 + totalAmount: 1215 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '12' + name: Misc + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '31' + note: '' + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2016-02-12T00:00:00' + totalAmount: 15615 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15615 + withholdingTax: [] + totalDiscount: 0 + subTotal: 13012.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 2602.5 + totalAmount: 15615 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + - id: '3793' + invoiceNumber: 276e29c1 + customerRef: + id: '59' + companyName: Ecker Holiday event + salesOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-02-05T00:00:00' + modifiedDate: '2023-04-26T09:36:12Z' + sourceModifiedDate: '2022-08-22T13:04:50Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Holiday party - gold level test v1 + unitAmount: 2000 + quantity: 1 + subTotal: 2000 + taxAmount: 400 + totalAmount: 2400 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '7' + name: Gold party + trackingCategoryRefs: [] + isDirectIncome: false + - description: Venue rental + unitAmount: 10000 + quantity: 1 + subTotal: 10000 + taxAmount: 2000 + totalAmount: 12000 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '20' + name: Venue Rental + trackingCategoryRefs: [] + isDirectIncome: false + - description: promotional items -- misc engraved items + unitAmount: 13.5 + quantity: 75 + subTotal: 1012.5 + taxAmount: 202.5 + totalAmount: 1215 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '12' + name: Misc + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 0 + subTotal: 13012.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 2602.5 + totalAmount: 15615 + amountDue: 15615 + status: Submitted + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1077 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/invoices?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/invoices + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/invoices?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '82322' + invoiceNumber: '0000000110' + customerRef: + id: A1D001 + companyName: A1 Design Services + salesOrderRefs: [] + issueDate: '2020-07-13T00:00:00Z' + dueDate: '2020-08-12T00:00:00Z' + modifiedDate: '2022-10-14T09:36:12Z' + sourceModifiedDate: '2020-07-13T11:06:40Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Standard rate + unitAmount: 0 + quantity: 0 + discountAmount: 0.22 + subTotal: 0 + taxAmount: 8.67 + totalAmount: 8.67 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 1.08 + subTotal: 43.34 + taxAmount: 0 + totalAmount: 43.34 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 1.3 + subTotal: 43.34 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 8.67 + totalAmount: 52.01 + amountDue: 52.01 + discountPercentage: 2.49 + status: Submitted + note: '0000000114' + - id: '83515' + invoiceNumber: '0000000111' + customerRef: + id: BRO001 + companyName: Bronson Inc + salesOrderRefs: [] + issueDate: '2020-07-15T00:00:00Z' + dueDate: '2020-08-29T00:00:00Z' + modifiedDate: '2022-10-14T09:36:12Z' + sourceModifiedDate: '2020-07-15T10:45:56Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Zero rated + unitAmount: 0 + quantity: 0 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + taxRateRef: + id: '1728' + name: Zero rated + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 3.13 + subTotal: 125 + taxAmount: 0 + totalAmount: 125 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 3.13 + subTotal: 125 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 125 + amountDue: 125 + discountPercentage: 2.5 + status: Submitted + note: '0000000111' + pageNumber: 1 + pageSize: 2 + totalResults: 409 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/invoices?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/invoices + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/invoices?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: INV-1 + invoiceNumber: '1' + customerRef: + id: A1D001 + companyName: A1 Design Services + salesOrderRefs: [] + issueDate: '2021-01-02T00:00:00' + modifiedDate: '2023-03-30T14:42:42Z' + sourceModifiedDate: '2022-11-25T09:43:54' + paidOnDate: '2022-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: AT Mini Tower Case + unitAmount: 14.25 + quantity: 1 + discountAmount: 0 + subTotal: 14.25 + taxAmount: 2.43 + totalAmount: 16.68 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Whiteboard - Drywipe (900 x 1200) + unitAmount: 19 + quantity: 4 + discountAmount: 0 + subTotal: 76 + taxAmount: 12.97 + totalAmount: 88.97 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: A4 Ledger Book - 5 Column + unitAmount: 7.59 + quantity: 8 + discountAmount: 0 + subTotal: 60.72 + taxAmount: 10.36 + totalAmount: 71.08 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Shorthand Notebook - 80 Sheets + unitAmount: 4.27 + quantity: 20 + discountAmount: 0 + subTotal: 85.4 + taxAmount: 14.57 + totalAmount: 99.97 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Desktop + unitAmount: 9.5 + quantity: 1 + discountAmount: 0 + subTotal: 9.5 + taxAmount: 1.62 + totalAmount: 11.12 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Desktop (Printing) + unitAmount: 16.15 + quantity: 1 + discountAmount: 0 + subTotal: 16.15 + taxAmount: 2.76 + totalAmount: 18.91 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Printing Rolls + unitAmount: 5.7 + quantity: 15 + discountAmount: 0 + subTotal: 85.5 + taxAmount: 14.59 + totalAmount: 100.09 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Correction Fluid - White + unitAmount: 2.37 + quantity: 7 + discountAmount: 0 + subTotal: 16.59 + taxAmount: 2.83 + totalAmount: 19.42 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Envelope - White (110 x 220) Plain + unitAmount: 8.54 + quantity: 20 + discountAmount: 0 + subTotal: 170.8 + taxAmount: 29.14 + totalAmount: 199.94 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Flip Chart - A1 Pad + unitAmount: 15.2 + quantity: 10 + discountAmount: 0 + subTotal: 152 + taxAmount: 25.94 + totalAmount: 177.94 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Laminator Pouches - A4 + unitAmount: 11.4 + quantity: 5 + discountAmount: 0 + subTotal: 57 + taxAmount: 9.73 + totalAmount: 66.73 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Mouse Mat - (241 x 203) Blue + unitAmount: 1.42 + quantity: 5 + discountAmount: 0 + subTotal: 7.1 + taxAmount: 1.21 + totalAmount: 8.31 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Copy Paper - Economy Grade + unitAmount: 2.46 + quantity: 80 + discountAmount: 0 + subTotal: 196.8 + taxAmount: 33.58 + totalAmount: 230.38 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Coloured Paper - Pastel Blue + unitAmount: 3.61 + quantity: 5 + discountAmount: 0 + subTotal: 18.05 + taxAmount: 3.08 + totalAmount: 21.13 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Ball Point Pen - Black + unitAmount: 1.9 + quantity: 8 + discountAmount: 0 + subTotal: 15.2 + taxAmount: 2.59 + totalAmount: 17.79 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Pencil - HB + unitAmount: 2.37 + quantity: 3 + discountAmount: 0 + subTotal: 7.11 + taxAmount: 1.21 + totalAmount: 8.32 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Remember-Me Sticky Notes (Recycled) + unitAmount: 3.32 + quantity: 6 + discountAmount: 0 + subTotal: 19.92 + taxAmount: 3.4 + totalAmount: 23.32 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Scissors - Economy + unitAmount: 2.85 + quantity: 1 + discountAmount: 0 + subTotal: 2.85 + taxAmount: 0.49 + totalAmount: 3.34 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Adhesive Tape - Brown (50mm x 66m) + unitAmount: 2.66 + quantity: 5 + discountAmount: 0 + subTotal: 13.3 + taxAmount: 2.27 + totalAmount: 15.57 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: JP010 Jet Printer Cartridge + unitAmount: 17.1 + quantity: 5 + discountAmount: 0 + subTotal: 85.5 + taxAmount: 14.59 + totalAmount: 100.09 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Letter Trays - 3 pack (Red) + unitAmount: 6.65 + quantity: 2 + discountAmount: 0 + subTotal: 13.3 + taxAmount: 2.27 + totalAmount: 15.57 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -100.09 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -66.73 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -117.5 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -177.94 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -230.38 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.79 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -71.08 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -88.97 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.57 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -3.34 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -199.94 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -100.09 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.68 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.91 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -23.32 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -99.97 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -21.13 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.57 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -19.42 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.31 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.12 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.32 + withholdingTax: [] + totalDiscount: 0 + subTotal: 1223.04 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 209.13 + totalAmount: 1432.17 + amountDue: 0 + status: Paid + note: '' + metadata: + isDeleted: false + - id: INV-9 + invoiceNumber: '9' + customerRef: + id: KIN001 + companyName: Kinghorn & French + salesOrderRefs: [] + issueDate: '2021-01-04T00:00:00' + modifiedDate: '2023-03-30T14:42:42Z' + sourceModifiedDate: '2022-11-25T09:43:54' + paidOnDate: '2022-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: PC Combo Pack 4 + unitAmount: 765 + quantity: 5 + discountAmount: 765 + subTotal: 3060 + taxAmount: 522.11 + totalAmount: 3582.11 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 20 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: PC Combo Pack 5 + unitAmount: 1080 + quantity: 4 + discountAmount: 864 + subTotal: 3456 + taxAmount: 589.68 + totalAmount: 4045.68 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 20 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: PC Combo Pack 6 + unitAmount: 1350 + quantity: 2 + discountAmount: 540 + subTotal: 2160 + taxAmount: 368.55 + totalAmount: 2528.55 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 20 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: FX030 Multifunctional Fax + unitAmount: 414 + quantity: 2 + discountAmount: 165.6 + subTotal: 662.4 + taxAmount: 113.02 + totalAmount: 775.42 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 20 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Copy Paper - Premium Grade + unitAmount: 3.06 + quantity: 100 + discountAmount: 61.2 + subTotal: 244.8 + taxAmount: 41.77 + totalAmount: 286.57 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 20 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '271' + note: Sales receipt 271 linked to sales invoice inv-9. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 11123.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -276.57 + - payment: + id: '271' + note: Sales receipt 271 linked to sales invoice inv-9. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 11123.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -765.42 + - payment: + id: '271' + note: Sales receipt 271 linked to sales invoice inv-9. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 11123.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4035.68 + - payment: + id: '271' + note: Sales receipt 271 linked to sales invoice inv-9. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 11123.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -2518.55 + - payment: + id: '271' + note: Sales receipt 271 linked to sales invoice inv-9. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 11123.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -3527.11 + - payment: + id: '272' + note: Sales discount 272 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '272' + note: Sales discount 272 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '272' + note: Sales discount 272 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '272' + note: Sales discount 272 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '272' + note: Sales discount 272 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '9' + note: Sales credit tx-9 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-12-31T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -45 + withholdingTax: [] + totalDiscount: 2395.8 + subTotal: 9583.2 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 1635.13 + totalAmount: 11218.33 + amountDue: 0 + status: Paid + note: '' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 86 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/invoices?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/invoices + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/invoices?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: b039b0a733de11e797950a57719b2edb + invoiceNumber: SI-1 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + salesOrderRefs: [] + issueDate: '2017-05-08T00:00:00' + dueDate: '2017-06-07T00:00:00' + modifiedDate: '2022-10-24T15:03:37Z' + sourceModifiedDate: '2021-07-23T13:42:59Z' + paidOnDate: '2021-07-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 8 + discountAmount: 0 + subTotal: 7200 + taxAmount: 1440 + totalAmount: 8640 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: e1c2bd659a6111e8bad90617b3da4b8a + note: Sales credit note + currency: GBP + currencyRate: 1 + paidOnDate: '2018-08-07T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1000 + - payment: + id: e1c2bd659a6111e8bad90617b3da4b8a + note: Sales credit note + currency: GBP + currencyRate: 1 + paidOnDate: '2018-08-07T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1000 + - payment: + id: 579388a0215911e8b45c025132dab352 + note: Customer receipt using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-01-02T00:00:00' + totalAmount: 1400 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1400 + - payment: + id: 52237e4e215911e8b45c025132dab352 + note: Customer receipt using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-01-02T00:00:00' + totalAmount: 4000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4000 + withholdingTax: [] + totalDiscount: 0 + subTotal: 7200 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 1440 + totalAmount: 8640 + amountDue: 1240 + status: PartiallyPaid + - id: 6420b3f8209611e8b45c025132dab352 + invoiceNumber: SI-2 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + salesOrderRefs: [] + issueDate: '2018-03-05T00:00:00' + dueDate: '2018-04-04T00:00:00' + modifiedDate: '2022-10-24T15:03:37Z' + sourceModifiedDate: '2018-03-05T16:58:39Z' + paidOnDate: '2018-03-05T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 5 + discountAmount: 0 + subTotal: 4500 + taxAmount: 900 + totalAmount: 5400 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 73a0490d209611e8b45c025132dab352 + note: Customer receipt using cash - PAYMENT-CASH-001 + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-03-05T00:00:00' + totalAmount: 5400 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5400 + withholdingTax: [] + totalDiscount: 0 + subTotal: 4500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 900 + totalAmount: 5400 + amountDue: 0 + status: Paid + pageNumber: 1 + pageSize: 2 + totalResults: 10759 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/invoices?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/invoices + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/invoices?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '2916' + invoiceNumber: IN0480 + customerRef: + id: '12' + companyName: MK Manufacturing + salesOrderRefs: [] + issueDate: '2021-04-22T00:00:00' + dueDate: '2021-05-22T00:00:00' + modifiedDate: '2023-04-04T16:31:54Z' + sourceModifiedDate: '2021-04-22T11:01:11Z' + paidOnDate: '2021-04-22T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 100 + quantity: 1 + subTotal: 100 + taxAmount: 20 + totalAmount: 120 + accountRef: + id: '176' + name: Revenue - Services + taxRateRef: + id: '105' + name: UK Sale Services Standard Rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: CUSTOMER-12 + name: MK Manufacturing + - id: DEPARTMENT-2 + name: Services + - id: LOCATION-11 + name: Codat Test Entity + isDirectIncome: false + paymentAllocations: + - payment: + id: '2918' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2021-04-22T00:00:00' + totalAmount: 120 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -120 + withholdingTax: [] + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 20 + totalAmount: 120 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + - id: '18827' + invoiceNumber: IN1515 + customerRef: + id: '6' + companyName: AG Insurance + salesOrderRefs: [] + issueDate: '2022-09-28T00:00:00' + dueDate: '2022-10-28T00:00:00' + modifiedDate: '2023-04-04T16:31:54Z' + sourceModifiedDate: '2022-10-05T11:02:22Z' + currency: USD + currencyRate: 0.9294 + lineItems: + - description: test desc Test05102022-1 + unitAmount: 180 + quantity: 1 + subTotal: 180 + taxAmount: 0 + totalAmount: 180 + accountRef: + id: '2' + name: Accounts Receivable + taxRateRef: + id: '58' + name: EC Sale Goods Standard Rate + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: CUSTOMER-6 + name: AG Insurance + - id: DEPARTMENT-1 + name: Sales + - id: LOCATION-11 + name: Codat Test Entity + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 0 + subTotal: 180 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 180 + amountDue: 180 + status: Submitted + note: test desc Test05102022-1 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/invoices?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/invoices + Wave: + value: + results: + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0ludm9pY2U6NzgyNDQ4OTg1Nzc1MzE5MTYw + invoiceNumber: '1' + customerRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 + companyName: ABC Textiles + salesOrderRefs: [] + issueDate: '2019-10-17T00:00:00' + dueDate: '2019-10-17T00:00:00' + modifiedDate: '2022-11-16T18:15:23Z' + sourceModifiedDate: '2019-12-05T23:20:36Z' + paidOnDate: '2019-12-05T23:20:36Z' + currency: USD + currencyRate: 0.784736781 + lineItems: + - description: '' + unitAmount: 10 + quantity: 5 + subTotal: 50 + taxAmount: 2.5 + totalAmount: 52.5 + accountRef: + id: QWNjb3VudDo3OTE3NTA2MDA0MjQ0NTExMTU7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Sales + itemRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1Byb2R1Y3Q6MzU2NjcyNTI= + name: Golf balls + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 50 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 2.5 + totalAmount: 52.5 + amountDue: 0 + status: Paid + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0ludm9pY2U6ODgzOTc4MDA2NDIxMzUwODIx + invoiceNumber: '2' + customerRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjM2OTkxOTYw + companyName: NIC Cookies + salesOrderRefs: [] + issueDate: '2020-03-05T00:00:00' + dueDate: '2020-03-05T00:00:00' + modifiedDate: '2022-11-16T18:15:23Z' + sourceModifiedDate: '2020-03-30T14:10:21Z' + paidOnDate: '2020-03-30T14:10:21Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Decorated cookies + unitAmount: 4 + quantity: 50 + subTotal: 200 + taxAmount: 40 + totalAmount: 240 + accountRef: + id: QWNjb3VudDo3OTE3NTA2MDA0MjQ0NTExMTU7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Sales + itemRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1Byb2R1Y3Q6NDEzNzEwOTU= + name: Cookies + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 200 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 40 + totalAmount: 240 + amountDue: 0 + status: Paid + pageNumber: 1 + pageSize: 2 + totalResults: 19 + _links: + current: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/invoices?page=1&pageSize=2 + self: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/invoices + next: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/invoices?page=2&pageSize=2 + Xero: + value: + results: + - id: 321bfed3-2da2-4969-9358-4de97821181b + invoiceNumber: INV-001-0 + customerRef: + id: afd4093b-c655-4847-8ee2-10a4f2c3eae3 + companyName: Maddox Publishing Group + salesOrderRefs: [] + issueDate: '2021-12-20T00:00:00' + dueDate: '2022-01-17T00:00:00' + modifiedDate: '2023-03-15T20:38:11Z' + sourceModifiedDate: '2021-01-02T20:34:51' + paidOnDate: '2022-02-17T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Project management - onsite daily rate - your CRM integration project + unitAmount: 583.3333333333 + quantity: 6 + discountAmount: 0 + subTotal: 3500 + taxAmount: 700 + totalAmount: 4200 + accountRef: + id: a969500a-377c-4cea-8f2b-a4e385607fd0 + name: Other Revenue + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + itemRef: + id: aa1c5f84-4453-42fa-9c92-69d4085607c9 + name: Project management - daily rate + trackingCategoryRefs: + - id: 34b9b859-07a9-451a-b4d3-effc9946634a + name: North + isDirectIncome: false + paymentAllocations: + - payment: + id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-17T00:00:00' + totalAmount: 4200 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4200 + withholdingTax: [] + totalDiscount: 0 + subTotal: 3500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 700 + totalAmount: 4200 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + - id: 4b6d0c8f-10fa-42cd-a6e5-53b175e90005 + invoiceNumber: INV-0001 + customerRef: + id: a871a956-05b5-4e2a-9419-7aeb478ca647 + companyName: Ridgeway University + salesOrderRefs: [] + issueDate: '2022-02-07T00:00:00' + dueDate: '2022-02-17T00:00:00' + modifiedDate: '2023-03-15T20:38:11Z' + sourceModifiedDate: '2021-01-02T22:51:43' + paidOnDate: '2022-02-17T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Retainer for consulting work + unitAmount: 416.67 + quantity: 1 + discountAmount: 0 + subTotal: 416.67 + taxAmount: 83.33 + totalAmount: 500 + accountRef: + id: c563b607-fb0e-4d06-9ddb-76fdeef20ae3 + name: Sales + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 8c481b70-b5d7-4de4-a7f7-9e161be2c472 + reference: '' + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-17T00:00:00' + totalAmount: 500 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -500 + withholdingTax: [] + totalDiscount: 0 + subTotal: 416.67 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 83.33 + totalAmount: 500 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 44 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/invoices?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/invoices + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/invoices?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000038034' + invoiceNumber: INV-102 + customerRef: + id: '104957000000037097' + companyName: Test Company + salesOrderRefs: [] + issueDate: '2020-02-06T10:54:03' + dueDate: '2020-02-17T00:00:00' + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-05-19T15:36:26' + paidOnDate: '2020-05-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + paymentAllocations: + - payment: + id: '104957000000129048' + note: '' + reference: '9' + accountRef: + id: '104957000000000349' + name: Petty Cash + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-29T00:00:00' + totalAmount: 9000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -9000 + - payment: + id: '104957000000137017' + note: '' + reference: '11' + accountRef: + id: '104957000000060010' + name: Abdi Test + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-19T00:00:00' + totalAmount: 9000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1 + withholdingTax: [] + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 9001 + amountDue: 0 + status: Paid + - id: '104957000000038052' + invoiceNumber: INV-104 + customerRef: + id: '104957000000037097' + companyName: Test Company + salesOrderRefs: [] + issueDate: '2020-02-06T10:54:04' + dueDate: '2020-02-17T00:00:00' + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-02-17T14:21:05' + paidOnDate: '2020-02-06T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + paymentAllocations: + - payment: + id: '104957000000070175' + note: Cheque deposit + reference: '4' + accountRef: + id: '104957000000060010' + name: Abdi Test + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-06T00:00:00' + totalAmount: 9001 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -9001 + withholdingTax: [] + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 9001 + amountDue: 0 + status: Paid + pageNumber: 1 + pageSize: 2 + totalResults: 48 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/invoices?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/invoices + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/invoices?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/invoices/{invoiceId}': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingInvoiceId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingInvoice' + examples: + Clear Books: + value: + id: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + invoiceNumber: TKj7oD38 + customerRef: + id: d65ac505-072c-49ec-be3c-3cb74228966d + companyName: Jensen Steuber + salesOrderRefs: [] + issueDate: '2022-04-25T13:04:02' + dueDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2023-01-28T14:41:02' + paidOnDate: '2022-04-25T13:04:02' + currency: GBP + currencyRate: 1 + lineItems: + - description: Heavy Duty Hinged Gully Grating x4.00 + unitAmount: 402.89 + quantity: 4 + subTotal: 1611.56 + taxAmount: 161.16 + totalAmount: 1772.72 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + name: Heavy Duty Hinged Gully Grating + trackingCategoryRefs: + - id: costcode_9 + name: PandaConstruction + isDirectIncome: true + paymentAllocations: + - payment: + id: 9407d5ee-893a-4547-bd89-bc7b795ee774 + note: Payment against invoice 2518ca08-5e2a-4630-8cee-a6bcd1625660 + reference: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-25T13:04:02' + totalAmount: 1772.72 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + totalAmount: -1772.72 + withholdingTax: [] + totalDiscount: 0 + subTotal: 1611.56 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 161.16 + totalAmount: 1772.72 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 18c906bf-89d1-ea11-bbaa-000d3a2b9185 + invoiceNumber: '103001' + customerRef: + id: b61217b3-89d1-ea11-bbaa-000d3a2b9185 + companyName: Trey Researches + salesOrderRefs: [] + issueDate: '2019-01-15T00:00:00' + dueDate: '2019-01-15T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-17T16:29:00Z' + paidOnDate: '2019-01-15T00:00:00' + currency: GBP + lineItems: + - description: AMSTERDAM Lamp + unitAmount: 35.6 + quantity: 3 + discountAmount: 0 + subTotal: 106.8 + taxAmount: 21.36 + totalAmount: 128.16 + accountRef: + id: 181217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 'Income, Product Sales' + discountPercentage: 0 + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-d41217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'AMSTERDAM Lamp / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: e0299ced-89d1-ea11-bbaa-000d3a2b9185 + note: Invoice 102001 + reference: 'Document No: 103001' + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + currency: GBP + currencyRate: 1 + paidOnDate: '2019-01-15T00:00:00' + totalAmount: 128.16 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-01-15T00:00:00' + totalAmount: -128.16 + withholdingTax: [] + totalDiscount: 0 + subTotal: 106.8 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 21.36 + totalAmount: 128.16 + amountDue: 0 + discountPercentage: 0 + status: Paid + note: '' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 91dccc63-b1af-4363-bee0-2aec6bab1bef + invoiceNumber: '19700002' + customerRef: + id: c3bf08a3-4d51-4859-acbb-5075f9484f87 + companyName: Mr Abe + salesOrderRefs: [] + issueDate: '2019-11-08T00:00:00Z' + dueDate: '2019-11-29T00:00:00Z' + modifiedDate: '2022-10-26T13:57:52Z' + sourceModifiedDate: '2019-11-08T11:56:22Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Consultancy per uur - Consultancy per uur + unitAmount: 75 + quantity: 8 + discountAmount: 0 + subTotal: 600 + taxAmount: 0 + totalAmount: 600 + accountRef: + id: 2421e8a0-5355-4ec0-af11-021fe4f39fcd + name: Omzet binnenland hoog tarief + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 600 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 600 + amountDue: 599 + discountPercentage: 0 + status: PartiallyPaid + Exact (UK): + value: + id: a05d1256-f253-46bd-aa13-c6f6a992aa47 + invoiceNumber: '17700002' + customerRef: + id: 570321bb-8b0c-49f1-a1f5-6fb1d6d94a62 + companyName: Some customer + salesOrderRefs: [] + issueDate: '2017-08-02T00:00:00Z' + dueDate: '2017-09-01T00:00:00Z' + modifiedDate: '2022-10-26T13:39:08Z' + sourceModifiedDate: '2017-08-02T18:23:43Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: A bunch of stuff - A bunch of stuff + unitAmount: 100 + quantity: 1000 + discountAmount: 0 + subTotal: 100000 + taxAmount: 0 + totalAmount: 100000 + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 100000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 100000 + amountDue: 0 + discountPercentage: 0 + status: Paid + FreeAgent: + value: + id: '50541736' + invoiceNumber: '2348' + customerRef: + id: '10123537' + companyName: _Test 1 + salesOrderRefs: [] + issueDate: '2016-12-30T00:00:00' + dueDate: '2016-12-30T00:00:00' + modifiedDate: '2023-04-25T14:19:19Z' + sourceModifiedDate: '2022-10-20T14:28:00Z' + paidOnDate: '2020-11-05T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 3.0 items with VatPercentage of 0.0 + unitAmount: 25.26 + quantity: 1 + discountAmount: 0 + subTotal: 25.26 + taxAmount: 0 + totalAmount: 25.26 + accountRef: + id: '001' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + - description: 3 service charges with 0.0% vat + unitAmount: 8.85 + quantity: 1 + discountAmount: 0 + subTotal: 8.85 + taxAmount: 0 + totalAmount: 8.85 + accountRef: + id: '001' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + - description: Tax + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '262466203' + note: E2E Test transaction 2 CREDIT �250.00 - Invoice receipt against 2348 + currency: GBP + paidOnDate: '2020-11-05T00:00:00' + totalAmount: 250 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.11 + withholdingTax: [] + subTotal: 34.11 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 34.11 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + FreshBooks: + value: + id: '2596455' + invoiceNumber: test-AL + customerRef: + id: '602174' + companyName: ab1 + salesOrderRefs: [] + issueDate: '1987-10-01T00:00:00' + dueDate: '1987-10-01T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2023-03-03T09:27:42' + paidOnDate: '2023-03-03T00:00:00' + currency: USD + lineItems: + - description: Editing creative writing for a client + unitAmount: 222.88 + quantity: 1 + discountAmount: 0 + subTotal: 222.88 + taxAmount: 0 + totalAmount: 222.88 + itemRef: + id: '639579' + name: Creative Writing Editorial + trackingCategoryRefs: [] + isDirectIncome: false + - description: '' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '2570292' + note: '' + currency: USD + paidOnDate: '2023-03-03T00:00:00' + totalAmount: 0.17 + allocation: + currency: USD + currencyRate: 1 + totalAmount: -0.17 + withholdingTax: [] + totalDiscount: 0 + subTotal: 222.88 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 222.88 + amountDue: 222.71 + status: Submitted + note: '' + metadata: + isDeleted: false + KashFlow: + value: + id: '143008521' + invoiceNumber: '40' + customerRef: + id: '86832299' + companyName: Mr French Person + salesOrderRefs: [] + issueDate: '2005-12-15T00:00:00' + dueDate: '2006-01-12T00:00:00' + modifiedDate: '2022-09-30T10:29:15Z' + currency: EUR + currencyRate: 0.844737287 + lineItems: + - unitAmount: 0 + quantity: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: '0' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 0 + amountDue: 0 + status: Paid + Oracle NetSuite: + value: + id: '416' + invoiceNumber: INV01 + customerRef: + id: '417' + companyName: 10 Breww Ltd + salesOrderRefs: [] + issueDate: '2021-04-09T00:00:00' + dueDate: '2021-04-30T00:00:00' + modifiedDate: '2022-09-20T08:16:10Z' + sourceModifiedDate: '2021-08-25T15:55:36' + paidOnDate: '2021-04-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Non-Recurring Services - EC + unitAmount: 100 + quantity: 1 + subTotal: 100 + totalAmount: 100 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: location-1 + isDirectIncome: false + paymentAllocations: + - payment: + id: '428' + reference: 'Payment #PYMT01' + accountRef: + id: '122' + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2021-04-20T00:00:00' + totalAmount: 90 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -90 + - payment: + id: '428' + reference: 'Payment #PYMT01' + accountRef: + id: '122' + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2021-04-20T00:00:00' + totalAmount: 90 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + withholdingTax: [] + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 100 + amountDue: 0 + status: Paid + QuickBooks Desktop: + value: + id: 2453-1071526256 + invoiceNumber: '975' + customerRef: + id: 420000-1071522044 + companyName: 'Prentice, Adelaide' + salesOrderRefs: [] + issueDate: '2022-11-28T00:00:00' + dueDate: '2023-12-28T00:00:00' + modifiedDate: '2023-04-26T09:08:12Z' + sourceModifiedDate: '2023-12-16T05:06:11' + paidOnDate: '2023-01-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Foundation slab - prep and pouring + unitAmount: 167.5 + quantity: 1 + subTotal: 167.5 + taxAmount: 0 + totalAmount: 167.5 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 320000-1071525597 + name: Concrete Slab + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - unitAmount: 0 + quantity: 1 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Rough lumber + unitAmount: 48 + quantity: 1 + subTotal: 48 + taxAmount: 0 + totalAmount: 48 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1C0000-933272656 + name: 'Lumber:Rough' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Trim lumber + unitAmount: 38 + quantity: 1 + subTotal: 38 + taxAmount: 0 + totalAmount: 38 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1D0000-933272656 + name: 'Lumber:Trim' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Window + unitAmount: 25 + quantity: 2 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Flooring + unitAmount: 50 + quantity: 1 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 310000-1071509547 + name: Flooring + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Window + unitAmount: 30 + quantity: 2 + subTotal: 60 + taxAmount: 0 + totalAmount: 60 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + paymentAllocations: + - payment: + id: 6973-1197775625 + note: Check - 80000-933270541 + reference: '983409' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-15T00:00:00' + totalAmount: 431.95 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -431.95 + withholdingTax: [] + totalDiscount: 0 + subTotal: 413.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 18.45 + totalAmount: 431.95 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '16' + invoiceNumber: '1001' + customerRef: + id: '3' + companyName: Information Sharing Technology + salesOrderRefs: [] + issueDate: '2019-02-18T00:00:00' + dueDate: '2019-03-20T00:00:00' + modifiedDate: '2023-01-18T11:03:02Z' + sourceModifiedDate: '2022-09-20T10:12:08Z' + paidOnDate: '2020-06-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Service + unitAmount: 500 + quantity: 10 + subTotal: 5000 + taxAmount: 0 + totalAmount: 5000 + accountRef: + id: '1' + name: Sales + itemRef: + id: '1' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '116' + note: Payments of type Prepaid + reference: '114213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 65.77 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -23.86 + - payment: + id: '122' + note: Payments of type Cash + reference: '121197' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 771.61 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.31 + - payment: + id: '123' + note: Payments of type Prepaid + reference: '121293' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 34.45 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.45 + - payment: + id: '132' + note: Payments of type Prepaid + reference: '13022' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 47.38 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -42.36 + - payment: + id: '140' + note: Payments of type Cash + reference: '139163' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 1078.72 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.71 + - payment: + id: '141' + note: Payments of type Prepaid + reference: '139288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 27.88 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.88 + - payment: + id: '149' + note: Payments of type Cash + reference: '148151' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 643.97 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -22.26 + - payment: + id: '150' + note: Payments of type Prepaid + reference: '148217' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 11.57 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.57 + - payment: + id: '157' + note: Payments of type Prepaid + reference: '155266' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 14.32 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4.87 + - payment: + id: '165' + note: Payments of type Cash + reference: '164142' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 913.09 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.99 + - payment: + id: '166' + note: Payments of type Prepaid + reference: '164260' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 39.98 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -39.98 + - payment: + id: '173' + note: Payments of type Prepaid + reference: '171213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 35.36 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -26.29 + - payment: + id: '181' + note: Payments of type Cash + reference: '180197' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 1087.13 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.04 + - payment: + id: '182' + note: Payments of type Prepaid + reference: '180274' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 47.91 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -47.91 + - payment: + id: '190' + note: Payments of type Cash + reference: '189174' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 607.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.34 + - payment: + id: '191' + note: Payments of type Prepaid + reference: '18922' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 16.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.44 + - payment: + id: '199' + note: Payments of type Cash + reference: '198128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 1209.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -20.22 + - payment: + id: '200' + note: Payments of type Prepaid + reference: '198234' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 18.35 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.35 + - payment: + id: '208' + note: Payments of type Cash + reference: '207189' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-21T00:00:00' + totalAmount: 914.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.86 + - payment: + id: '209' + note: Payments of type Prepaid + reference: '207254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-21T00:00:00' + totalAmount: 27.62 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.62 + - payment: + id: '217' + note: Payments of type Cash + reference: '216161' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-22T00:00:00' + totalAmount: 565.24 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1.66 + - payment: + id: '218' + note: Payments of type Prepaid + reference: '216237' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-22T00:00:00' + totalAmount: 19.67 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -19.67 + - payment: + id: '231' + note: Payments of type Prepaid + reference: '229276' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 38.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -30.52 + - payment: + id: '240' + note: Payments of type PrepaidPayment + reference: '238213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 47.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -31.98 + - payment: + id: '249' + note: Payments of type PrepaidPayment + reference: '247245' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 22.03 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.84 + - payment: + id: '256' + note: Payments of type PrepaidPayment + reference: '254258' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 37.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.6 + - payment: + id: '262' + note: Payments of type Cash + reference: '261162' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 425.69 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.02 + - payment: + id: '263' + note: Payments of type PrepaidPayment + reference: '261215' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 7.24 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.24 + - payment: + id: '269' + note: Payments of type Cash + reference: '268154' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 968.21 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -48.58 + - payment: + id: '270' + note: Payments of type PrepaidPayment + reference: '268269' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 11.69 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.69 + - payment: + id: '278' + note: Payments of type Cash + reference: '277153' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-25T00:00:00' + totalAmount: 1063.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -37.08 + - payment: + id: '279' + note: Payments of type PrepaidPayment + reference: '277281' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-25T00:00:00' + totalAmount: 30.58 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -30.58 + - payment: + id: '287' + note: Payments of type Cash + reference: '286188' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-26T00:00:00' + totalAmount: 539.55 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.97 + - payment: + id: '288' + note: Payments of type PrepaidPayment + reference: '286250' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-26T00:00:00' + totalAmount: 12.73 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -12.73 + - payment: + id: '296' + note: Payments of type Cash + reference: '295176' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-27T00:00:00' + totalAmount: 687.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4.18 + - payment: + id: '297' + note: Payments of type PrepaidPayment + reference: '295264' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-27T00:00:00' + totalAmount: 14.92 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -14.92 + - payment: + id: '303' + note: Payments of type Cash + reference: '302128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-28T00:00:00' + totalAmount: 837.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.66 + - payment: + id: '304' + note: Payments of type PrepaidPayment + reference: '302284' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-28T00:00:00' + totalAmount: 17.04 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.04 + - payment: + id: '313' + note: Payments of type PrepaidPayment + reference: '311211' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 45.06 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -41.47 + - payment: + id: '321' + note: Payments of type Cash + reference: '320186' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 798.79 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.08 + - payment: + id: '322' + note: Payments of type PrepaidPayment + reference: '320256' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 14.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -14.33 + - payment: + id: '333' + note: Payments of type PrepaidPayment + reference: '331236' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 17.94 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.58 + - payment: + id: '341' + note: Payments of type Cash + reference: '340128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 859.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -29.21 + - payment: + id: '342' + note: Payments of type PrepaidPayment + reference: '340292' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 26.59 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -26.59 + - payment: + id: '348' + note: Payments of type Cash + reference: '34710' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-31T00:00:00' + totalAmount: 949.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.07 + - payment: + id: '349' + note: Payments of type PrepaidPayment + reference: '347216' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-31T00:00:00' + totalAmount: 25.32 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25.32 + - payment: + id: '361' + note: Payments of type PrepaidPayment + reference: '359220' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-01T00:00:00' + totalAmount: 54.12 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -40.61 + - payment: + id: '367' + note: Payments of type Cash + reference: '366195' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-02T00:00:00' + totalAmount: 827.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25.4 + - payment: + id: '368' + note: Payments of type PrepaidPayment + reference: '366288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-02T00:00:00' + totalAmount: 12.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -12.15 + - payment: + id: '376' + note: Payments of type Cash + reference: '375123' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-03T00:00:00' + totalAmount: 802.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.54 + - payment: + id: '377' + note: Payments of type PrepaidPayment + reference: '375298' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-03T00:00:00' + totalAmount: 39.06 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -39.06 + - payment: + id: '385' + note: Payments of type Cash + reference: '38418' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-04T00:00:00' + totalAmount: 858.41 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.4 + - payment: + id: '386' + note: Payments of type PrepaidPayment + reference: '384213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-04T00:00:00' + totalAmount: 9.99 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -9.99 + - payment: + id: '392' + note: Payments of type Cash + reference: '391115' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 1094.8 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -47.35 + - payment: + id: '393' + note: Payments of type PrepaidPayment + reference: '391247' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 16.73 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.73 + - payment: + id: '402' + note: Payments of type PrepaidPayment + reference: '400275' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-06T00:00:00' + totalAmount: 32.88 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -29.29 + - payment: + id: '410' + note: Payments of type Cash + reference: '409145' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-07T00:00:00' + totalAmount: 725.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.79 + - payment: + id: '411' + note: Payments of type PrepaidPayment + reference: '409292' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-07T00:00:00' + totalAmount: 6.22 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.22 + - payment: + id: '419' + note: Payments of type Cash + reference: '418157' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-08T00:00:00' + totalAmount: 407.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -2.55 + - payment: + id: '420' + note: Payments of type PrepaidPayment + reference: '418258' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-08T00:00:00' + totalAmount: 8.92 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.92 + - payment: + id: '429' + note: Payments of type PrepaidPayment + reference: '427270' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-09T00:00:00' + totalAmount: 56.75 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -28.75 + - payment: + id: '437' + note: Payments of type Cash + reference: '436168' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-10T00:00:00' + totalAmount: 760.05 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -31.48 + - payment: + id: '438' + note: Payments of type PrepaidPayment + reference: '436234' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-10T00:00:00' + totalAmount: 6.03 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.03 + - payment: + id: '446' + note: Payments of type Cash + reference: '44518' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 904.82 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.96 + - payment: + id: '447' + note: Payments of type PrepaidPayment + reference: '445278' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 24.95 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -24.95 + - payment: + id: '456' + note: Payments of type PrepaidPayment + reference: '454252' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 70.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.72 + - payment: + id: '462' + note: Payments of type Cash + reference: '461144' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 914.05 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.76 + - payment: + id: '463' + note: Payments of type PrepaidPayment + reference: '461243' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 7.47 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.47 + - payment: + id: '470' + note: Payments of type PrepaidPayment + reference: '468248' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 67.83 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -41.38 + - payment: + id: '481' + note: Payments of type Cash + reference: '480129' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-17T00:00:00' + totalAmount: 965.85 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.21 + - payment: + id: '482' + note: Payments of type PrepaidPayment + reference: '480242' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-17T00:00:00' + totalAmount: 33.9 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.9 + - payment: + id: '490' + note: Payments of type Cash + reference: '489120' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-18T00:00:00' + totalAmount: 1112.76 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.74 + - payment: + id: '491' + note: Payments of type PrepaidPayment + reference: '489239' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-18T00:00:00' + totalAmount: 48.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -48.74 + - payment: + id: '499' + note: Payments of type Cash + reference: '498147' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 1017 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5.08 + - payment: + id: '500' + note: Payments of type PrepaidPayment + reference: '498254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 37.77 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -37.77 + - payment: + id: '507' + note: Payments of type PrepaidPayment + reference: '505288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 62.82 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -54.62 + - payment: + id: '521' + note: Payments of type PrepaidPayment + reference: '519243' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 14.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '647' + note: Payments of type PrepaidPayment + reference: '645263' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-03-20T00:00:00' + totalAmount: 40.43 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '705' + note: Payments of type PrepaidPayment + reference: '703246' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-03T00:00:00' + totalAmount: 25 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25 + - payment: + id: '772' + note: Payments of type PrepaidPayment + reference: '770263' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-24T00:00:00' + totalAmount: 10.35 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '779' + note: Payments of type PrepaidPayment + reference: '777217' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-24T00:00:00' + totalAmount: 39.55 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '792' + note: Payments of type PrepaidPayment + reference: '790262' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-29T00:00:00' + totalAmount: 12.46 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '843' + note: Payments of type PrepaidPayment + reference: '841264' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-07T00:00:00' + totalAmount: 25.64 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '850' + note: Payments of type PrepaidPayment + reference: '848254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-14T00:00:00' + totalAmount: 53.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '877' + note: Payments of type PrepaidPayment + reference: '875210' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-06-01T00:00:00' + totalAmount: 12.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + withholdingTax: [] + totalDiscount: 0 + subTotal: 5000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 5000 + amountDue: 3296.44 + status: PartiallyPaid + note: Invoice for service + QuickBooks Online Sandbox: + value: + id: '30' + invoiceNumber: '1002' + customerRef: + id: '59' + companyName: Ecker Holiday event + salesOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-02-05T00:00:00' + modifiedDate: '2023-04-26T09:36:12Z' + sourceModifiedDate: '2023-01-25T13:49:52Z' + paidOnDate: '2016-02-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Holiday party - gold level test v1 + unitAmount: 2000 + quantity: 1 + subTotal: 2000 + taxAmount: 400 + totalAmount: 2400 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '7' + name: Gold party + trackingCategoryRefs: [] + isDirectIncome: false + - description: Venue rental + unitAmount: 10000 + quantity: 1 + subTotal: 10000 + taxAmount: 2000 + totalAmount: 12000 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '20' + name: Venue Rental + trackingCategoryRefs: [] + isDirectIncome: false + - description: promotional items -- misc engraved items + unitAmount: 13.5 + quantity: 75 + subTotal: 1012.5 + taxAmount: 202.5 + totalAmount: 1215 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '12' + name: Misc + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '31' + note: '' + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2016-02-12T00:00:00' + totalAmount: 15615 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15615 + withholdingTax: [] + totalDiscount: 0 + subTotal: 13012.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 2602.5 + totalAmount: 15615 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '82322' + invoiceNumber: '0000000110' + customerRef: + id: A1D001 + companyName: A1 Design Services + salesOrderRefs: [] + issueDate: '2020-07-13T00:00:00Z' + dueDate: '2020-08-12T00:00:00Z' + modifiedDate: '2022-10-14T09:36:12Z' + sourceModifiedDate: '2020-07-13T11:06:40Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Standard rate + unitAmount: 0 + quantity: 0 + discountAmount: 0.22 + subTotal: 0 + taxAmount: 8.67 + totalAmount: 8.67 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 1.08 + subTotal: 43.34 + taxAmount: 0 + totalAmount: 43.34 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 1.3 + subTotal: 43.34 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 8.67 + totalAmount: 52.01 + amountDue: 52.01 + discountPercentage: 2.49 + status: Submitted + note: '0000000114' + Sage 50 (UK): + value: + id: INV-1 + invoiceNumber: '1' + customerRef: + id: A1D001 + companyName: A1 Design Services + salesOrderRefs: [] + issueDate: '2021-01-02T00:00:00' + modifiedDate: '2023-03-30T14:42:42Z' + sourceModifiedDate: '2022-11-25T09:43:54' + paidOnDate: '2022-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: AT Mini Tower Case + unitAmount: 14.25 + quantity: 1 + discountAmount: 0 + subTotal: 14.25 + taxAmount: 2.43 + totalAmount: 16.68 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Whiteboard - Drywipe (900 x 1200) + unitAmount: 19 + quantity: 4 + discountAmount: 0 + subTotal: 76 + taxAmount: 12.97 + totalAmount: 88.97 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: A4 Ledger Book - 5 Column + unitAmount: 7.59 + quantity: 8 + discountAmount: 0 + subTotal: 60.72 + taxAmount: 10.36 + totalAmount: 71.08 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Shorthand Notebook - 80 Sheets + unitAmount: 4.27 + quantity: 20 + discountAmount: 0 + subTotal: 85.4 + taxAmount: 14.57 + totalAmount: 99.97 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Desktop + unitAmount: 9.5 + quantity: 1 + discountAmount: 0 + subTotal: 9.5 + taxAmount: 1.62 + totalAmount: 11.12 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Desktop (Printing) + unitAmount: 16.15 + quantity: 1 + discountAmount: 0 + subTotal: 16.15 + taxAmount: 2.76 + totalAmount: 18.91 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Printing Rolls + unitAmount: 5.7 + quantity: 15 + discountAmount: 0 + subTotal: 85.5 + taxAmount: 14.59 + totalAmount: 100.09 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Correction Fluid - White + unitAmount: 2.37 + quantity: 7 + discountAmount: 0 + subTotal: 16.59 + taxAmount: 2.83 + totalAmount: 19.42 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Envelope - White (110 x 220) Plain + unitAmount: 8.54 + quantity: 20 + discountAmount: 0 + subTotal: 170.8 + taxAmount: 29.14 + totalAmount: 199.94 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Flip Chart - A1 Pad + unitAmount: 15.2 + quantity: 10 + discountAmount: 0 + subTotal: 152 + taxAmount: 25.94 + totalAmount: 177.94 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Laminator Pouches - A4 + unitAmount: 11.4 + quantity: 5 + discountAmount: 0 + subTotal: 57 + taxAmount: 9.73 + totalAmount: 66.73 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Mouse Mat - (241 x 203) Blue + unitAmount: 1.42 + quantity: 5 + discountAmount: 0 + subTotal: 7.1 + taxAmount: 1.21 + totalAmount: 8.31 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Copy Paper - Economy Grade + unitAmount: 2.46 + quantity: 80 + discountAmount: 0 + subTotal: 196.8 + taxAmount: 33.58 + totalAmount: 230.38 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Coloured Paper - Pastel Blue + unitAmount: 3.61 + quantity: 5 + discountAmount: 0 + subTotal: 18.05 + taxAmount: 3.08 + totalAmount: 21.13 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Ball Point Pen - Black + unitAmount: 1.9 + quantity: 8 + discountAmount: 0 + subTotal: 15.2 + taxAmount: 2.59 + totalAmount: 17.79 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Pencil - HB + unitAmount: 2.37 + quantity: 3 + discountAmount: 0 + subTotal: 7.11 + taxAmount: 1.21 + totalAmount: 8.32 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Remember-Me Sticky Notes (Recycled) + unitAmount: 3.32 + quantity: 6 + discountAmount: 0 + subTotal: 19.92 + taxAmount: 3.4 + totalAmount: 23.32 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Scissors - Economy + unitAmount: 2.85 + quantity: 1 + discountAmount: 0 + subTotal: 2.85 + taxAmount: 0.49 + totalAmount: 3.34 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Adhesive Tape - Brown (50mm x 66m) + unitAmount: 2.66 + quantity: 5 + discountAmount: 0 + subTotal: 13.3 + taxAmount: 2.27 + totalAmount: 15.57 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: JP010 Jet Printer Cartridge + unitAmount: 17.1 + quantity: 5 + discountAmount: 0 + subTotal: 85.5 + taxAmount: 14.59 + totalAmount: 100.09 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Letter Trays - 3 pack (Red) + unitAmount: 6.65 + quantity: 2 + discountAmount: 0 + subTotal: 13.3 + taxAmount: 2.27 + totalAmount: 15.57 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.32 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.12 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.31 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -19.42 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.57 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -21.13 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -99.97 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -23.32 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.91 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.68 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -100.09 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -199.94 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -3.34 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.57 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -100.09 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -66.73 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -117.5 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -177.94 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -230.38 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.79 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -71.08 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -88.97 + withholdingTax: [] + totalDiscount: 0 + subTotal: 1223.04 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 209.13 + totalAmount: 1432.17 + amountDue: 0 + status: Paid + note: '' + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: b039b0a733de11e797950a57719b2edb + invoiceNumber: SI-1 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + salesOrderRefs: [] + issueDate: '2017-05-08T00:00:00' + dueDate: '2017-06-07T00:00:00' + modifiedDate: '2022-10-24T15:03:37Z' + sourceModifiedDate: '2021-07-23T13:42:59Z' + paidOnDate: '2021-07-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 8 + discountAmount: 0 + subTotal: 7200 + taxAmount: 1440 + totalAmount: 8640 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 52237e4e215911e8b45c025132dab352 + note: Customer receipt using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-01-02T00:00:00' + totalAmount: 4000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4000 + - payment: + id: 579388a0215911e8b45c025132dab352 + note: Customer receipt using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-01-02T00:00:00' + totalAmount: 1400 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1400 + - payment: + id: e1c2bd659a6111e8bad90617b3da4b8a + note: Sales credit note + currency: GBP + currencyRate: 1 + paidOnDate: '2018-08-07T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1000 + - payment: + id: e1c2bd659a6111e8bad90617b3da4b8a + note: Sales credit note + currency: GBP + currencyRate: 1 + paidOnDate: '2018-08-07T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1000 + withholdingTax: [] + totalDiscount: 0 + subTotal: 7200 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 1440 + totalAmount: 8640 + amountDue: 1240 + status: PartiallyPaid + Sage Intacct: + value: + id: '2916' + invoiceNumber: IN0480 + customerRef: + id: '12' + companyName: MK Manufacturing + salesOrderRefs: [] + issueDate: '2021-04-22T00:00:00' + dueDate: '2021-05-22T00:00:00' + modifiedDate: '2023-04-04T16:31:54Z' + sourceModifiedDate: '2021-04-22T11:01:11Z' + paidOnDate: '2021-04-22T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 100 + quantity: 1 + subTotal: 100 + taxAmount: 20 + totalAmount: 120 + accountRef: + id: '176' + name: Revenue - Services + taxRateRef: + id: '105' + name: UK Sale Services Standard Rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: CUSTOMER-12 + name: MK Manufacturing + - id: DEPARTMENT-2 + name: Services + - id: LOCATION-11 + name: Codat Test Entity + isDirectIncome: false + paymentAllocations: + - payment: + id: '2918' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2021-04-22T00:00:00' + totalAmount: 120 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -120 + withholdingTax: [] + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 20 + totalAmount: 120 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + Wave: + value: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0ludm9pY2U6NzgyNDQ4OTg1Nzc1MzE5MTYw + invoiceNumber: '1' + customerRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 + companyName: ABC Textiles + salesOrderRefs: [] + issueDate: '2019-10-17T00:00:00' + dueDate: '2019-10-17T00:00:00' + modifiedDate: '2022-11-16T18:15:23Z' + sourceModifiedDate: '2019-12-05T23:20:36Z' + paidOnDate: '2019-12-05T23:20:36Z' + currency: USD + currencyRate: 0.784736781 + lineItems: + - description: '' + unitAmount: 10 + quantity: 5 + subTotal: 50 + taxAmount: 2.5 + totalAmount: 52.5 + accountRef: + id: QWNjb3VudDo3OTE3NTA2MDA0MjQ0NTExMTU7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Sales + itemRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1Byb2R1Y3Q6MzU2NjcyNTI= + name: Golf balls + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 50 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 2.5 + totalAmount: 52.5 + amountDue: 0 + status: Paid + Xero: + value: + id: 321bfed3-2da2-4969-9358-4de97821181b + invoiceNumber: INV-001-0 + customerRef: + id: afd4093b-c655-4847-8ee2-10a4f2c3eae3 + companyName: Maddox Publishing Group + salesOrderRefs: [] + issueDate: '2021-12-20T00:00:00' + dueDate: '2022-01-17T00:00:00' + modifiedDate: '2023-03-15T20:38:11Z' + sourceModifiedDate: '2021-01-02T20:34:51' + paidOnDate: '2022-02-17T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Project management - onsite daily rate - your CRM integration project + unitAmount: 583.3333333333 + quantity: 6 + discountAmount: 0 + subTotal: 3500 + taxAmount: 700 + totalAmount: 4200 + accountRef: + id: a969500a-377c-4cea-8f2b-a4e385607fd0 + name: Other Revenue + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + itemRef: + id: aa1c5f84-4453-42fa-9c92-69d4085607c9 + name: Project management - daily rate + trackingCategoryRefs: + - id: 34b9b859-07a9-451a-b4d3-effc9946634a + name: North + isDirectIncome: false + paymentAllocations: + - payment: + id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-17T00:00:00' + totalAmount: 4200 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4200 + withholdingTax: [] + totalDiscount: 0 + subTotal: 3500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 700 + totalAmount: 4200 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000038034' + invoiceNumber: INV-102 + customerRef: + id: '104957000000037097' + companyName: Test Company + salesOrderRefs: [] + issueDate: '2020-02-06T10:54:03' + dueDate: '2020-02-17T00:00:00' + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-05-19T15:36:26' + paidOnDate: '2020-05-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + paymentAllocations: + - payment: + id: '104957000000129048' + note: '' + reference: '9' + accountRef: + id: '104957000000000349' + name: Petty Cash + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-29T00:00:00' + totalAmount: 9000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -9000 + - payment: + id: '104957000000137017' + note: '' + reference: '11' + accountRef: + id: '104957000000060010' + name: Abdi Test + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-19T00:00:00' + totalAmount: 9000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1 + withholdingTax: [] + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 9001 + amountDue: 0 + status: Paid + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get invoice + description: | + The *Get invoice* endpoint returns a single invoice for a given invoiceId. + + [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + ### Tips and traps + + To access the `paymentAllocations` property, ensure that the `payments` data type is queued and cached in Codat before retrieving `invoices` from Codat's cache. + operationId: get-accounting-invoice + x-speakeasy-group: accounts-receivable.invoices + '/companies/{companyId}/data/invoices/{invoiceId}/pdf': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingInvoiceId' + responses: + '200': + description: Success + content: + application/pdf: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get invoice as PDF + description: "\uFEFFDownload invoice as a pdf." + operationId: download-accounting-invoice-pdf + x-speakeasy-name-override: download-pdf + x-speakeasy-group: accounts-receivable.invoices + '/companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingInvoiceId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: List invoice attachments + description: |- + The *List invoice attachments* endpoint returns a list of attachments available to download for given `invoiceId`. + + [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + operationId: list-accounting-invoice-attachments + x-speakeasy-group: accounts-receivable.invoices + '/companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingInvoiceId' + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get invoice attachment + description: | + The *Get invoice attachment* endpoint returns a specific attachment for a given `invoiceId` and `attachmentId`. + + [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + operationId: get-accounting-invoice-attachment + x-speakeasy-group: accounts-receivable.invoices + '/companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingInvoiceId' + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Download invoice attachment + description: | + The *Download invoice attachment* endpoint downloads a specific attachment for a given `invoiceId` and `attachmentId`. + + [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + operationId: download-accounting-invoice-attachment + x-speakeasy-group: accounts-receivable.invoices + '/companies/{companyId}/data/journalEntries': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Transactions + summary: List journal entries + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingJournalEntries' + examples: + Clear Books: + value: + results: + - id: 770c89bb-3d6a-449a-9243-739378b4cd7d + postedOn: '2022-04-19T00:00:00' + createdOn: '2022-04-19T00:00:00' + journalRef: + id: 90bb7784-083b-4bcb-a534-b30756cee65d + name: General Journal + journalLines: + - description: '' + netAmount: 32095.91 + currency: GBP + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + - description: Tax for direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + netAmount: -2917.81 + currency: GBP + accountRef: + id: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + name: VAT + - description: '' + netAmount: -29178.09 + currency: GBP + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + modifiedDate: '2023-04-26T12:38:18Z' + recordRef: + id: c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + dataType: directIncomes + metadata: + isDeleted: false + - id: 9f96606f-6846-40c6-b423-9b1753458e75 + postedOn: '2022-04-19T00:00:00' + createdOn: '2022-04-19T00:00:00' + journalRef: + id: 90bb7784-083b-4bcb-a534-b30756cee65d + name: General Journal + journalLines: + - description: '' + netAmount: 188.33 + currency: GBP + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + - description: Tax for direct income 38e8c917-0afc-4583-8ffe-1b53ad601197 + netAmount: -17.12 + currency: GBP + accountRef: + id: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + name: VAT + - description: '' + netAmount: -171.21 + currency: GBP + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + modifiedDate: '2023-04-26T12:38:18Z' + recordRef: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + dataType: directIncomes + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1862 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/journalEntries + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/journalEntries?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: START + postedOn: '2018-12-31T00:00:00' + createdOn: '2018-12-31T00:00:00' + journalRef: + id: 4caabc3e-3d64-ed11-8c34-000d3a870cba + name: DEFAULT + journalLines: + - description: Opening Entry + netAmount: -69723.14 + currency: GBP + accountRef: + id: ac1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Retained Earnings + - description: Opening Entry + netAmount: -20000 + currency: GBP + accountRef: + id: aa1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Share Capital + - description: Opening Entry + netAmount: -2329.42 + currency: GBP + accountRef: + id: 8a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Payable + - description: Opening Entry + netAmount: 3499 + currency: GBP + accountRef: + id: 6e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accumulated Depreciation + - description: Opening Entry + netAmount: 5498 + currency: GBP + accountRef: + id: 6c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Equipment + - description: Opening Entry + netAmount: 28547.16 + currency: GBP + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + - description: Opening Entry + netAmount: 31638.4 + currency: GBP + accountRef: + id: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Receivable + - description: Opening Entry + netAmount: 2870 + currency: GBP + accountRef: + id: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Receivable + - description: Opening Entry + netAmount: 20000 + currency: GBP + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + modifiedDate: '2023-03-27T14:21:31Z' + sourceModifiedDate: '2020-07-29T10:56:12Z' + metadata: + isDeleted: false + - id: 01-2019 + postedOn: '2019-01-01T00:00:00' + createdOn: '2019-01-01T00:00:00' + journalRef: + id: 4caabc3e-3d64-ed11-8c34-000d3a870cba + name: DEFAULT + journalLines: + - description: January 2019 + netAmount: -2000 + currency: GBP + accountRef: + id: 5e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Checking account + - description: January 2019 + netAmount: 1000 + currency: GBP + accountRef: + id: 401217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Salaries Expense + - description: January 2019 + netAmount: 1000 + currency: GBP + accountRef: + id: 341217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Rent Expense + modifiedDate: '2023-03-27T14:21:31Z' + sourceModifiedDate: '2020-07-29T10:56:12Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 825 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/journalEntries + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/journalEntries?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 00002c0a-8061-4ad2-84fa-c879eea880a7 + createdOn: '2022-01-11T14:18:54' + updatedOn: '2022-01-11T14:18:54' + journalRef: + id: 55ff34a3-0857-4202-b7ec-a399cfc26a4e + name: Memoriaal + journalLines: + - description: 1 transactions of type CARD_PAYMENT_FEE_REFUND + netAmount: -6.94 + currency: EUR + accountRef: + id: e0217fbf-8963-4134-80ef-929d5de8612d + name: Kosten 13e maand + tracking: + recordRefs: [] + - description: 1 transactions of type CARD_PAYMENT_FEE_REFUND + netAmount: 6.94 + currency: EUR + accountRef: + id: 0166c96b-adf2-4667-a755-87e67c741f41 + name: Resultaat verkoop activa + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:37:10Z' + sourceModifiedDate: '2022-01-11T14:18:54Z' + - id: 000154f0-e83a-4012-96a3-7db0b036b96b + createdOn: '2020-04-22T13:56:46' + updatedOn: '2020-04-22T13:56:46' + journalRef: + id: 151313ae-55b1-4ba0-b32a-e2ef6a8ce52a + name: Nominal Card + journalLines: + - description: Refunds with payment type of Cash + netAmount: -144.36 + currency: EUR + accountRef: + id: 0741cc89-e33a-4358-bcbd-3acb07b005dc + name: Nominal Card + tracking: + recordRefs: [] + - description: Refunds with payment type of Cash + netAmount: 144.36 + currency: EUR + accountRef: + id: ef2fde36-4416-4bc5-b239-315b2929348c + name: Debiteuren + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:37:08Z' + sourceModifiedDate: '2020-04-22T13:56:46Z' + pageNumber: 1 + pageSize: 2 + totalResults: 35972 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/journalEntries + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/journalEntries?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 0008ef00-c5f8-4f97-bce9-5094b2f569dd + createdOn: '2020-07-03T10:51:46' + updatedOn: '2020-07-03T10:51:46' + journalRef: + id: ed5068ff-cb0e-4edd-9777-36ac94a5d6f0 + name: Sales journal + journalLines: + - netAmount: -9.1 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - description: 6 service charges with 0.0% vat + netAmount: -11.21 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 28.0 items with VatPercentage of 0.0 + netAmount: -308.61 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: Gratuity + netAmount: -25.87 + currency: GBP + accountRef: + id: febc52c4-a1ed-4000-b51a-76f9f525445d + name: Salary Control Account + tracking: + recordRefs: [] + - netAmount: -47.14 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - description: 19.0 items with VatPercentage of 20.0 + netAmount: -235.72 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 13.0 items with VatPercentage of 5.0 + netAmount: -182.06 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 1.0 gift cards + netAmount: -1 + currency: GBP + accountRef: + id: febc52c4-a1ed-4000-b51a-76f9f525445d + name: Salary Control Account + tracking: + recordRefs: [] + - netAmount: 820.71 + currency: GBP + accountRef: + id: cf9572e7-8afa-4339-9113-af32a66d9df9 + name: Trade Debtors + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:35:45Z' + sourceModifiedDate: '2020-07-03T10:51:46Z' + recordRef: + id: 0008ef00-c5f8-4f97-bce9-5094b2f569dd + dataType: invoices + - id: 001a8d63-2d5b-4b00-b17f-894108b6ce81 + createdOn: '2021-07-30T18:02:23' + updatedOn: '2021-07-30T18:02:23' + journalRef: + id: ed5068ff-cb0e-4edd-9777-36ac94a5d6f0 + name: Sales journal + journalLines: + - netAmount: 1038.01 + currency: GBP + accountRef: + id: cf9572e7-8afa-4339-9113-af32a66d9df9 + name: Trade Debtors + tracking: + recordRefs: [] + - description: 1.0 gift cards + netAmount: -1 + currency: GBP + accountRef: + id: cc0ab812-d89a-452b-88a8-61666a0f0211 + name: Accruals + tracking: + recordRefs: [] + - netAmount: -19.29 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - netAmount: -60.82 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - description: 15.0 items with VatPercentage of 0.0 + netAmount: -248.28 + currency: GBP + accountRef: + id: ba7d27d1-72cf-411b-8ef3-55ca4b13dac3 + name: Sundry Non-Operating Expenses + tracking: + recordRefs: [] + - description: Gratuity + netAmount: -8.97 + currency: GBP + accountRef: + id: 8f27a6b8-101d-4613-a059-2b462fb01b2f + name: anna_test_prod + tracking: + recordRefs: [] + - description: 28.0 items with VatPercentage of 5.0 + netAmount: -385.7 + currency: GBP + accountRef: + id: ba7d27d1-72cf-411b-8ef3-55ca4b13dac3 + name: Sundry Non-Operating Expenses + tracking: + recordRefs: [] + - description: 2 service charges with 0.0% vat + netAmount: -9.85 + currency: GBP + accountRef: + id: ba7d27d1-72cf-411b-8ef3-55ca4b13dac3 + name: Sundry Non-Operating Expenses + tracking: + recordRefs: [] + - description: 27.0 items with VatPercentage of 20.0 + netAmount: -304.1 + currency: GBP + accountRef: + id: ba7d27d1-72cf-411b-8ef3-55ca4b13dac3 + name: Sundry Non-Operating Expenses + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:35:45Z' + sourceModifiedDate: '2021-07-30T18:02:23Z' + recordRef: + id: 001a8d63-2d5b-4b00-b17f-894108b6ce81 + dataType: invoices + pageNumber: 1 + pageSize: 2 + totalResults: 6785 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/journalEntries + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/journalEntries?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '24389149' + postedOn: '1987-10-01T00:00:00' + createdOn: '1987-10-01T00:00:00' + updatedOn: '1987-10-01T00:00:00' + journalLines: + - description: '' + netAmount: 222.88 + currency: GBP + accountRef: + id: '128611' + name: Accounts Receivable + - description: Creative Writing Editorial + netAmount: -222.88 + currency: GBP + accountRef: + id: '128613' + name: Sales + - description: '' + netAmount: 0 + currency: GBP + accountRef: + id: '128613' + name: Sales + modifiedDate: '2023-03-24T16:07:38Z' + sourceModifiedDate: '1987-10-01T00:00:00' + recordRef: + id: '2596455' + dataType: invoices + metadata: + isDeleted: false + - id: '24389396' + postedOn: '1987-10-01T00:00:00' + createdOn: '1987-10-01T00:00:00' + updatedOn: '1987-10-01T00:00:00' + journalLines: + - description: '' + netAmount: -222.88 + currency: GBP + accountRef: + id: '128611' + name: Accounts Receivable + - description: Creative Writing Editorial + netAmount: 222.88 + currency: GBP + accountRef: + id: '128613' + name: Sales + - description: '' + netAmount: 0 + currency: GBP + accountRef: + id: '128613' + name: Sales + modifiedDate: '2023-03-24T16:07:38Z' + sourceModifiedDate: '1987-10-01T00:00:00' + recordRef: + id: '2596455' + dataType: invoices + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 734 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/journalEntries + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/journalEntries?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '112' + postedOn: '2021-03-26T00:00:00' + createdOn: '2021-03-26T10:31:05' + updatedOn: '2021-03-26T10:31:06' + journalLines: + - netAmount: -120 + currency: GBP + accountRef: + id: '825' + name: Codat Europe Bank + tracking: + recordRefs: + - id: location-4 + dataType: trackingCategories + - id: '724' + dataType: suppliers + - netAmount: 120 + currency: GBP + accountRef: + id: '111' + name: Accounts Payable + tracking: + recordRefs: + - id: location-4 + dataType: trackingCategories + - id: '724' + dataType: suppliers + modifiedDate: '2023-01-30T14:49:07Z' + sourceModifiedDate: '2021-03-26T10:31:06' + recordRef: + id: '112' + dataType: billPayments + - id: '7' + postedOn: '2021-03-26T00:00:00' + createdOn: '2021-03-26T10:02:18' + updatedOn: '2022-07-05T13:38:10' + journalLines: + - netAmount: -144 + currency: GBP + accountRef: + id: '111' + name: Accounts Payable + tracking: + recordRefs: + - id: '724' + dataType: suppliers + - netAmount: 120 + currency: GBP + accountRef: + id: '716' + name: Inventory In Transit + tracking: + recordRefs: + - id: location-4 + dataType: trackingCategories + - description: VAT + netAmount: 24 + currency: GBP + accountRef: + id: '211' + name: VAT on Purchases + tracking: + recordRefs: + - id: '713' + dataType: suppliers + modifiedDate: '2023-01-30T14:49:07Z' + sourceModifiedDate: '2022-07-05T13:38:10' + recordRef: + id: '7' + dataType: bills + pageNumber: 1 + pageSize: 2 + totalResults: 11 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/journalEntries + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/journalEntries?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 2453-1071526256 + postedOn: '2022-11-28T00:00:00' + createdOn: '2022-11-28T00:00:00' + journalLines: + - description: '' + netAmount: 431.95 + currency: GBP + accountRef: + id: 40000-933270541 + name: Accounts Receivable + - description: Foundation slab - prep and pouring + netAmount: -167.5 + currency: GBP + accountRef: + id: 190000-933270541 + name: Labor Income + - description: 'CA sales tax, San Domingo County' + netAmount: -18.45 + currency: GBP + accountRef: + id: 100000-933270541 + name: Sales Tax Payable + - description: Rough lumber + netAmount: -48 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Trim lumber + netAmount: -38 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Window + netAmount: -50 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Flooring + netAmount: -50 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Window + netAmount: -60 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + modifiedDate: '2023-04-26T09:11:56Z' + sourceModifiedDate: '2023-12-16T05:04:21' + recordRef: + id: 2453-1071526256 + dataType: invoices + metadata: + isDeleted: false + - id: '469E-1071530054' + postedOn: '2022-11-30T00:00:00' + createdOn: '2022-11-30T00:00:00' + journalLines: + - description: '' + netAmount: 14488.64 + currency: GBP + accountRef: + id: 40000-933270541 + name: Accounts Receivable + - description: Installation labor + netAmount: -45.5 + currency: GBP + accountRef: + id: 190000-933270541 + name: Labor Income + - description: Install drywall + netAmount: -1320 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Electrical work + netAmount: -1650 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Metal Work + netAmount: -660 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Install insulation + netAmount: -1100 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Plumbing + netAmount: -1650 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Painting + netAmount: -2420 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Install carpeting + netAmount: -3300 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Custom Bay Window + netAmount: -1925 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Window + netAmount: -115.5 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Equipment Rental + netAmount: -700 + currency: GBP + accountRef: + id: 190000-933270541 + name: Labor Income + - description: 10% retainage to be billed after job is complete and approved. + netAmount: 555.5 + currency: GBP + accountRef: + id: 70000-933270541 + name: Retainage Receivable + - description: 'CA sales tax, San Tomas County' + netAmount: -158.14 + currency: GBP + accountRef: + id: 100000-933270541 + name: Sales Tax Payable + modifiedDate: '2023-04-26T09:11:56Z' + sourceModifiedDate: '2023-12-16T05:05:41' + recordRef: + id: '469E-1071530054' + dataType: invoices + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 140 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journalEntries + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journalEntries?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '1' + postedOn: '2018-09-21T00:00:00' + createdOn: '2018-09-21T00:00:00' + journalLines: + - description: Opening Balance from Bank + netAmount: 170.23 + currency: GBP + accountRef: + id: '61' + name: Dave PP Current + tracking: + recordRefs: [] + - description: '' + netAmount: -170.23 + currency: GBP + accountRef: + id: '53' + name: Retained profit balance forward account + tracking: + recordRefs: [] + modifiedDate: '2023-01-18T11:03:25Z' + sourceModifiedDate: '2018-12-17T14:56:20Z' + - id: '15' + postedOn: '2018-09-21T00:00:00' + createdOn: '2018-09-21T00:00:00' + journalLines: + - description: Payment to Google + netAmount: -1.59 + currency: GBP + accountRef: + id: '61' + name: Dave PP Current + tracking: + recordRefs: [] + - description: Payment to Google + netAmount: 1.59 + currency: GBP + accountRef: + id: '37' + name: Computer equipment accumulated depreciation brought forward + tracking: + recordRefs: [] + modifiedDate: '2023-01-18T11:03:25Z' + sourceModifiedDate: '2018-12-17T14:56:44Z' + recordRef: + id: PUR-15 + dataType: directCosts + pageNumber: 1 + pageSize: 2 + totalResults: 9405 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/journalEntries + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/journalEntries?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '12' + postedOn: '2015-02-23T00:00:00' + createdOn: '2015-02-23T00:00:00' + journalLines: + - description: Opening stock for Guest Book + netAmount: 0 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: 0 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: 250 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: -250 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-12T16:02:02Z' + metadata: + isDeleted: false + - id: '13' + postedOn: '2015-02-23T00:00:00' + createdOn: '2015-02-23T00:00:00' + journalLines: + - description: Opening stock for Name Badges + netAmount: 0 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + - description: Opening stock for Name Badges + netAmount: 0 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Name Badges + netAmount: 7500 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Name Badges + netAmount: -7500 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-12T16:02:04Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 9190 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/journalEntries + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/journalEntries?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '88' + description: Opening Stock + postedOn: '2021-01-01T00:00:00' + createdOn: '2010-04-27T17:16:57' + journalLines: + - description: Opening Stock + netAmount: -40710 + currency: GBP + accountRef: + id: '1001' + name: Stock + - description: Opening Stock + netAmount: 40710 + currency: GBP + accountRef: + id: '5200' + name: Opening Stock + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54' + recordRef: + id: '88' + dataType: journalEntries + metadata: + isDeleted: false + - id: '92' + description: Goods + postedOn: '2021-01-01T00:00:00' + createdOn: '2010-04-27T17:16:57' + journalLines: + - description: Goods/Services - Goods + netAmount: -5875 + currency: GBP + accountRef: + id: '2100' + name: Creditors Control Account + - description: Goods/Services - Goods + netAmount: 5000 + currency: GBP + accountRef: + id: '5000' + name: Materials Purchased + - description: Goods/Services - Goods + netAmount: 875 + currency: GBP + accountRef: + id: '2201' + name: Purchase Tax Control Account + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54' + recordRef: + id: '92' + dataType: bills + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1119 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/journalEntries + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/journalEntries?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: b0489c4b33de11e797950a57719b2edb + postedOn: '2017-05-08T11:08:39' + createdOn: '2017-05-08T11:08:39' + updatedOn: '2017-05-08T11:08:39' + journalLines: + - description: Consulting services + netAmount: 1440 + currency: GBP + accountRef: + id: 9a9931b4267a11e797950a57719b2edb + name: VAT on Sales - Holding Account + - description: Consulting services + netAmount: 7200 + currency: GBP + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + - netAmount: -8640 + currency: GBP + accountRef: + id: 9a991c56267a11e797950a57719b2edb + name: Trade Debtors + modifiedDate: '2022-10-24T15:31:26Z' + sourceModifiedDate: '2017-05-08T11:08:39Z' + - id: c23efa4233de11e797950a57719b2edb + postedOn: '2017-05-08T11:09:09' + createdOn: '2017-05-08T11:09:09' + updatedOn: '2017-05-08T11:09:09' + journalLines: + - netAmount: 1080 + currency: GBP + accountRef: + id: 9a991c56267a11e797950a57719b2edb + name: Trade Debtors + - description: Consulting services + netAmount: -180 + currency: GBP + accountRef: + id: 9a9931b4267a11e797950a57719b2edb + name: VAT on Sales - Holding Account + - description: Consulting services + netAmount: -900 + currency: GBP + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + modifiedDate: '2022-10-24T15:31:26Z' + sourceModifiedDate: '2017-05-08T11:09:09Z' + pageNumber: 1 + pageSize: 2 + totalResults: 24386 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/journalEntries + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/journalEntries?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '262177' + description: 'Invoices - 1100: 2021/04/22 03:44:26:7042 Batch Summary Entry' + postedOn: '2021-04-22T00:00:00' + createdOn: '2021-04-22T10:44:27' + updatedOn: '2021-04-22T10:44:27' + journalRef: + id: '1' + name: Accounts Receivable Journal + journalLines: + - description: '' + netAmount: -100 + currency: GBP + accountRef: + id: '176' + name: Revenue - Services + - description: '' + netAmount: -20 + currency: GBP + accountRef: + id: '306' + name: Sales Tax Payable + - description: '' + netAmount: 120 + currency: GBP + accountRef: + id: '2' + name: Accounts Receivable + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2021-04-22T10:44:27' + metadata: + isDeleted: false + - id: '262179' + description: 'Receipts(Bank-501_CHK) - 1100: April 2021 Batch Summary Entry' + postedOn: '2021-04-30T00:00:00' + createdOn: '2021-04-22T11:01:11' + updatedOn: '2022-04-19T13:38:45' + journalRef: + id: '7' + name: Cash Receipts Journal + journalLines: + - description: '' + netAmount: -120 + currency: GBP + accountRef: + id: '2' + name: Accounts Receivable + - description: '' + netAmount: 120 + currency: GBP + accountRef: + id: '353' + name: Current Account + - description: '' + netAmount: 150 + currency: GBP + accountRef: + id: '353' + name: Current Account + - description: '' + netAmount: -150 + currency: GBP + accountRef: + id: '179' + name: Revenue - Other + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2022-04-19T13:38:45' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 21 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/journalEntries + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/journalEntries?page=2&pageSize=2 + Xero: + value: + results: + - id: 033d79c7-565b-419a-9e1b-33ab58efcf3d + postedOn: '2021-11-19T00:00:00' + createdOn: '2023-02-17T21:07:12' + journalLines: + - description: '' + netAmount: -7267.2 + currency: GBP + accountRef: + id: e0faa299-ca0d-4b0a-9e32-0dfabdf9179a + name: Accounts Payable + - description: Half day training - Microsoft Office + netAmount: 1800 + currency: GBP + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + name: Consulting + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + netAmount: 4000 + currency: GBP + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + - description: Stationery charges + netAmount: 256 + currency: GBP + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + - description: '' + netAmount: 1211.2 + currency: GBP + accountRef: + id: b12f79b9-a082-4b8b-971e-d321292943c7 + name: VAT + modifiedDate: '2023-03-15T20:37:09Z' + sourceModifiedDate: '2023-02-17T21:07:12' + recordRef: + id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + dataType: bills + metadata: + isDeleted: false + - id: 98ac5060-c9ed-4359-bcd5-711e649e7899 + postedOn: '2021-12-20T00:00:00' + createdOn: '2023-02-17T21:07:23' + journalLines: + - description: '' + netAmount: -7267.2 + currency: GBP + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + - description: '' + netAmount: 7267.2 + currency: GBP + accountRef: + id: e0faa299-ca0d-4b0a-9e32-0dfabdf9179a + name: Accounts Payable + modifiedDate: '2023-03-15T20:37:09Z' + sourceModifiedDate: '2023-02-17T21:07:23' + recordRef: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + dataType: billPayments + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 290 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/journalEntries + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/journalEntries?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List journal entries* endpoint returns a list of [journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) for a given company's connection. + + [Journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-journal-entries + x-speakeasy-group: transactions.journal-entries + '/companies/{companyId}/data/journalEntries/{journalEntryId}': + parameters: + - $ref: '#/components/parameters/companyId' + - name: journalEntryId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a journal entry. + get: + tags: + - Transactions + summary: Get journal entry + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingJournalEntry' + examples: + Clear Books: + value: + id: 770c89bb-3d6a-449a-9243-739378b4cd7d + postedOn: '2022-04-19T00:00:00' + createdOn: '2022-04-19T00:00:00' + journalRef: + id: 90bb7784-083b-4bcb-a534-b30756cee65d + name: General Journal + journalLines: + - description: '' + netAmount: 32095.91 + currency: GBP + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + - description: Tax for direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + netAmount: -2917.81 + currency: GBP + accountRef: + id: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + name: VAT + - description: '' + netAmount: -29178.09 + currency: GBP + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + modifiedDate: '2023-04-26T12:38:18Z' + recordRef: + id: c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + dataType: directIncomes + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: START + postedOn: '2018-12-31T00:00:00' + createdOn: '2018-12-31T00:00:00' + journalRef: + id: 4caabc3e-3d64-ed11-8c34-000d3a870cba + name: DEFAULT + journalLines: + - description: Opening Entry + netAmount: -69723.14 + currency: GBP + accountRef: + id: ac1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Retained Earnings + - description: Opening Entry + netAmount: -20000 + currency: GBP + accountRef: + id: aa1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Share Capital + - description: Opening Entry + netAmount: -2329.42 + currency: GBP + accountRef: + id: 8a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Payable + - description: Opening Entry + netAmount: 3499 + currency: GBP + accountRef: + id: 6e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accumulated Depreciation + - description: Opening Entry + netAmount: 5498 + currency: GBP + accountRef: + id: 6c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Equipment + - description: Opening Entry + netAmount: 28547.16 + currency: GBP + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + - description: Opening Entry + netAmount: 31638.4 + currency: GBP + accountRef: + id: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Receivable + - description: Opening Entry + netAmount: 2870 + currency: GBP + accountRef: + id: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Receivable + - description: Opening Entry + netAmount: 20000 + currency: GBP + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + modifiedDate: '2023-03-27T14:21:31Z' + sourceModifiedDate: '2020-07-29T10:56:12Z' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 00002c0a-8061-4ad2-84fa-c879eea880a7 + createdOn: '2022-01-11T14:18:54' + updatedOn: '2022-01-11T14:18:54' + journalRef: + id: 55ff34a3-0857-4202-b7ec-a399cfc26a4e + name: Memoriaal + journalLines: + - description: 1 transactions of type CARD_PAYMENT_FEE_REFUND + netAmount: -6.94 + currency: EUR + accountRef: + id: e0217fbf-8963-4134-80ef-929d5de8612d + name: Kosten 13e maand + tracking: + recordRefs: [] + - description: 1 transactions of type CARD_PAYMENT_FEE_REFUND + netAmount: 6.94 + currency: EUR + accountRef: + id: 0166c96b-adf2-4667-a755-87e67c741f41 + name: Resultaat verkoop activa + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:37:10Z' + sourceModifiedDate: '2022-01-11T14:18:54Z' + Exact (UK): + value: + id: 0008ef00-c5f8-4f97-bce9-5094b2f569dd + createdOn: '2020-07-03T10:51:46' + updatedOn: '2020-07-03T10:51:46' + journalRef: + id: ed5068ff-cb0e-4edd-9777-36ac94a5d6f0 + name: Sales journal + journalLines: + - netAmount: -9.1 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - description: 6 service charges with 0.0% vat + netAmount: -11.21 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 28.0 items with VatPercentage of 0.0 + netAmount: -308.61 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: Gratuity + netAmount: -25.87 + currency: GBP + accountRef: + id: febc52c4-a1ed-4000-b51a-76f9f525445d + name: Salary Control Account + tracking: + recordRefs: [] + - netAmount: -47.14 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - description: 19.0 items with VatPercentage of 20.0 + netAmount: -235.72 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 13.0 items with VatPercentage of 5.0 + netAmount: -182.06 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 1.0 gift cards + netAmount: -1 + currency: GBP + accountRef: + id: febc52c4-a1ed-4000-b51a-76f9f525445d + name: Salary Control Account + tracking: + recordRefs: [] + - netAmount: 820.71 + currency: GBP + accountRef: + id: cf9572e7-8afa-4339-9113-af32a66d9df9 + name: Trade Debtors + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:35:45Z' + sourceModifiedDate: '2020-07-03T10:51:46Z' + recordRef: + id: 0008ef00-c5f8-4f97-bce9-5094b2f569dd + dataType: invoices + FreshBooks: + value: + id: '24389149' + postedOn: '1987-10-01T00:00:00' + createdOn: '1987-10-01T00:00:00' + updatedOn: '1987-10-01T00:00:00' + journalLines: + - description: '' + netAmount: 222.88 + currency: GBP + accountRef: + id: '128611' + name: Accounts Receivable + - description: Creative Writing Editorial + netAmount: -222.88 + currency: GBP + accountRef: + id: '128613' + name: Sales + - description: '' + netAmount: 0 + currency: GBP + accountRef: + id: '128613' + name: Sales + modifiedDate: '2023-03-24T16:07:38Z' + sourceModifiedDate: '1987-10-01T00:00:00' + recordRef: + id: '2596455' + dataType: invoices + metadata: + isDeleted: false + Oracle NetSuite: + value: + id: '112' + postedOn: '2021-03-26T00:00:00' + createdOn: '2021-03-26T10:31:05' + updatedOn: '2021-03-26T10:31:06' + journalLines: + - netAmount: -120 + currency: GBP + accountRef: + id: '825' + name: Codat Europe Bank + tracking: + recordRefs: + - id: location-4 + dataType: trackingCategories + - id: '724' + dataType: suppliers + - netAmount: 120 + currency: GBP + accountRef: + id: '111' + name: Accounts Payable + tracking: + recordRefs: + - id: location-4 + dataType: trackingCategories + - id: '724' + dataType: suppliers + modifiedDate: '2023-01-30T14:49:07Z' + sourceModifiedDate: '2021-03-26T10:31:06' + recordRef: + id: '112' + dataType: billPayments + QuickBooks Desktop: + value: + id: 2453-1071526256 + postedOn: '2022-11-28T00:00:00' + createdOn: '2022-11-28T00:00:00' + journalLines: + - description: '' + netAmount: 431.95 + currency: GBP + accountRef: + id: 40000-933270541 + name: Accounts Receivable + - description: Foundation slab - prep and pouring + netAmount: -167.5 + currency: GBP + accountRef: + id: 190000-933270541 + name: Labor Income + - description: 'CA sales tax, San Domingo County' + netAmount: -18.45 + currency: GBP + accountRef: + id: 100000-933270541 + name: Sales Tax Payable + - description: Rough lumber + netAmount: -48 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Trim lumber + netAmount: -38 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Window + netAmount: -50 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Flooring + netAmount: -50 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Window + netAmount: -60 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + modifiedDate: '2023-04-26T09:11:56Z' + sourceModifiedDate: '2023-12-16T05:04:21' + recordRef: + id: 2453-1071526256 + dataType: invoices + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '1' + postedOn: '2018-09-21T00:00:00' + createdOn: '2018-09-21T00:00:00' + journalLines: + - description: Opening Balance from Bank + netAmount: 170.23 + currency: GBP + accountRef: + id: '61' + name: Dave PP Current + tracking: + recordRefs: [] + - description: '' + netAmount: -170.23 + currency: GBP + accountRef: + id: '53' + name: Retained profit balance forward account + tracking: + recordRefs: [] + modifiedDate: '2023-01-18T11:03:25Z' + sourceModifiedDate: '2018-12-17T14:56:20Z' + QuickBooks Online Sandbox: + value: + id: '12' + postedOn: '2015-02-23T00:00:00' + createdOn: '2015-02-23T00:00:00' + journalLines: + - description: Opening stock for Guest Book + netAmount: 0 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: 0 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: 250 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: -250 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-12T16:02:02Z' + metadata: + isDeleted: false + Sage 50 (UK): + value: + id: '88' + description: Opening Stock + postedOn: '2021-01-01T00:00:00' + createdOn: '2010-04-27T17:16:57' + journalLines: + - description: Opening Stock + netAmount: -40710 + currency: GBP + accountRef: + id: '1001' + name: Stock + - description: Opening Stock + netAmount: 40710 + currency: GBP + accountRef: + id: '5200' + name: Opening Stock + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54' + recordRef: + id: '88' + dataType: journalEntries + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: b0489c4b33de11e797950a57719b2edb + postedOn: '2017-05-08T11:08:39' + createdOn: '2017-05-08T11:08:39' + updatedOn: '2017-05-08T11:08:39' + journalLines: + - description: Consulting services + netAmount: 1440 + currency: GBP + accountRef: + id: 9a9931b4267a11e797950a57719b2edb + name: VAT on Sales - Holding Account + - description: Consulting services + netAmount: 7200 + currency: GBP + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + - netAmount: -8640 + currency: GBP + accountRef: + id: 9a991c56267a11e797950a57719b2edb + name: Trade Debtors + modifiedDate: '2022-10-24T15:31:26Z' + sourceModifiedDate: '2017-05-08T11:08:39Z' + Sage Intacct: + value: + id: '262177' + description: 'Invoices - 1100: 2021/04/22 03:44:26:7042 Batch Summary Entry' + postedOn: '2021-04-22T00:00:00' + createdOn: '2021-04-22T10:44:27' + updatedOn: '2021-04-22T10:44:27' + journalRef: + id: '1' + name: Accounts Receivable Journal + journalLines: + - description: '' + netAmount: -100 + currency: GBP + accountRef: + id: '176' + name: Revenue - Services + - description: '' + netAmount: -20 + currency: GBP + accountRef: + id: '306' + name: Sales Tax Payable + - description: '' + netAmount: 120 + currency: GBP + accountRef: + id: '2' + name: Accounts Receivable + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2021-04-22T10:44:27' + metadata: + isDeleted: false + Xero: + value: + id: 033d79c7-565b-419a-9e1b-33ab58efcf3d + postedOn: '2021-11-19T00:00:00' + createdOn: '2023-02-17T21:07:12' + journalLines: + - description: '' + netAmount: -7267.2 + currency: GBP + accountRef: + id: e0faa299-ca0d-4b0a-9e32-0dfabdf9179a + name: Accounts Payable + - description: Half day training - Microsoft Office + netAmount: 1800 + currency: GBP + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + name: Consulting + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + netAmount: 4000 + currency: GBP + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + - description: Stationery charges + netAmount: 256 + currency: GBP + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + - description: '' + netAmount: 1211.2 + currency: GBP + accountRef: + id: b12f79b9-a082-4b8b-971e-d321292943c7 + name: VAT + modifiedDate: '2023-03-15T20:37:09Z' + sourceModifiedDate: '2023-02-17T21:07:12' + recordRef: + id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + dataType: bills + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get journal entry* endpoint returns a single journal entry for a given journalEntryId. + + [Journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-journal-entry + x-speakeasy-group: transactions.journal-entries + '/companies/{companyId}/data/journals': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Transactions + summary: List journals + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingJournals' + examples: + Clear Books: + value: + results: + - id: 90bb7784-083b-4bcb-a534-b30756cee65d + journalCode: GJ + name: General Journal + type: General Journal + hasChildren: true + createdOn: '2021-12-11T13:04:02' + status: Active + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-07-15T20:19:02' + metadata: + isDeleted: false + - id: 07b94827-c0a5-4cc7-ba58-3f9efec3b4b3 + journalCode: PAY + name: Payroll Journal + type: Payroll Journal + parentId: 90bb7784-083b-4bcb-a534-b30756cee65d + hasChildren: false + createdOn: '2021-12-11T13:04:02' + status: Active + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-07-24T14:17:02' + metadata: + isDeleted: false + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2 + pageNumber: 1 + pageSize: 2 + totalResults: 4 + Dynamics 365 Business Central: + value: + results: + - id: 211317b3-89d1-ea11-bbaa-000d3a2b9185 + journalCode: ASSETS + name: ASSETS + type: Assets + hasChildren: true + status: Active + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2023-02-02T10:26:25Z' + metadata: + isDeleted: false + - id: 9a94ef78-92ec-ec11-82f9-000d3a8746a9 + journalCode: BNKDEPOSIT-BNKD + name: BNKD + type: Bank Deposits + parentId: af7d7e6b-e5c8-ec11-8e7e-000d3a86e04a + hasChildren: false + createdOn: '2022-06-15T10:03:59' + status: Active + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2022-06-15T22:45:30Z' + metadata: + isDeleted: false + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2 + pageNumber: 1 + pageSize: 2 + totalResults: 46 + Exact (Netherlands): + value: + results: + - id: aae31284-e23d-456b-9957-fbf4bcef6c19 + journalCode: '21' + name: '12345678' + type: Bank + hasChildren: false + createdOn: '2019-11-05T14:44:51' + status: Active + modifiedDate: '2022-10-26T13:31:58Z' + sourceModifiedDate: '2020-01-24T11:41:25Z' + - id: 74677165-1bd3-49b4-87d0-32d974674f86 + journalCode: '23' + name: Abraham's Billion Dollar stuff + type: Bank + hasChildren: false + createdOn: '2019-11-22T13:35:57' + status: Active + modifiedDate: '2022-10-26T13:31:58Z' + sourceModifiedDate: '2019-11-22T13:35:57Z' + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2 + pageNumber: 1 + pageSize: 2 + totalResults: 47 + Exact (UK): + value: + results: + - id: 05b9febe-34b3-4836-8277-002294b233a9 + journalCode: '25' + name: annaBankAccount1 + type: Bank + hasChildren: false + createdOn: '2021-04-26T16:44:47' + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2021-04-26T16:44:47Z' + - id: b9c3d6a6-4ce2-4714-9ff6-fb15892300f7 + journalCode: '31' + name: annaBankAccount10 + type: Bank + hasChildren: false + createdOn: '2021-05-18T10:24:18' + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2021-05-18T10:24:18Z' + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2 + pageNumber: 1 + pageSize: 2 + totalResults: 21 + Sage Intacct: + value: + results: + - id: '207' + journalCode: AJPT + name: A Journal Push Test + type: '' + hasChildren: false + createdOn: '2022-01-17T10:44:23' + status: Active + modifiedDate: '2023-04-04T16:31:30Z' + sourceModifiedDate: '2022-01-17T10:44:23' + metadata: + isDeleted: false + - id: '223' + journalCode: AJPT2 + name: A Journal Push Test 2 + type: '' + hasChildren: false + createdOn: '2022-01-18T15:39:07' + status: Active + modifiedDate: '2023-04-04T16:31:30Z' + sourceModifiedDate: '2022-01-18T15:39:07' + metadata: + isDeleted: false + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2 + pageNumber: 1 + pageSize: 2 + totalResults: 1211 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List journals* endpoint returns a list of [journals](https://docs.codat.io/lending-api#/schemas/Journal) for a given company's connection. + + [Journals](https://docs.codat.io/lending-api#/schemas/Journal) are used to record all the financial transactions of a company. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-journals + x-speakeasy-group: transactions.journals + '/companies/{companyId}/data/journals/{journalId}': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Transactions + summary: Get journal + parameters: + - name: journalId + in: path + required: true + schema: + type: string + description: Unique identifier for a journal. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingJournal' + examples: + Clear Books: + value: + id: 90bb7784-083b-4bcb-a534-b30756cee65d + journalCode: GJ + name: General Journal + type: General Journal + hasChildren: true + createdOn: '2021-12-11T13:04:02' + status: Active + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-07-15T20:19:02' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 211317b3-89d1-ea11-bbaa-000d3a2b9185 + journalCode: ASSETS + name: ASSETS + type: Assets + hasChildren: true + status: Active + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2023-02-02T10:26:25Z' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: aae31284-e23d-456b-9957-fbf4bcef6c19 + journalCode: '21' + name: '12345678' + type: Bank + hasChildren: false + createdOn: '2019-11-05T14:44:51' + status: Active + modifiedDate: '2022-10-26T13:31:58Z' + sourceModifiedDate: '2020-01-24T11:41:25Z' + Exact (UK): + value: + id: 05b9febe-34b3-4836-8277-002294b233a9 + journalCode: '25' + name: annaBankAccount1 + type: Bank + hasChildren: false + createdOn: '2021-04-26T16:44:47' + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2021-04-26T16:44:47Z' + Sage Intacct: + value: + id: '207' + journalCode: AJPT + name: A Journal Push Test + type: '' + hasChildren: false + createdOn: '2022-01-17T10:44:23' + status: Active + modifiedDate: '2023-04-04T16:31:30Z' + sourceModifiedDate: '2022-01-17T10:44:23' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get journal* endpoint returns a single journal for a given journalId. + + [Journals](https://docs.codat.io/lending-api#/schemas/Journal) are used to record all the financial transactions of a company. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-journal + x-speakeasy-group: transactions.journals + '/companies/{companyId}/data/payments': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + summary: List payments + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingPayments' + examples: + Clear Books: + value: + results: + - id: 7ba4fc1b-e248-49ba-8bf8-0813d7f203a8 + customerRef: + id: a82042f1-a005-4ca5-bfd3-5bc237123aa5 + companyName: Keara Leffler + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + totalAmount: 3669.52 + currency: GBP + currencyRate: 1 + date: '2022-04-25T13:04:02' + note: Payment against invoice ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + lines: + - amount: 3669.52 + links: + - type: Invoice + id: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + amount: -3669.52 + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-04-25T13:04:02' + reference: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + metadata: + isDeleted: false + - id: 9407d5ee-893a-4547-bd89-bc7b795ee774 + customerRef: + id: d65ac505-072c-49ec-be3c-3cb74228966d + companyName: Jensen Steuber + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + paymentMethodRef: + id: 8db2de81-0db4-46ee-b7f9-c711a7e89a01 + name: Cash payments-IHz + totalAmount: 1772.72 + currency: GBP + currencyRate: 1 + date: '2022-04-25T13:04:02' + note: Payment against invoice 2518ca08-5e2a-4630-8cee-a6bcd1625660 + lines: + - amount: 1772.72 + links: + - type: Invoice + id: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + amount: -1772.72 + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-04-25T13:04:02' + reference: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 200 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/payments?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/payments + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/payments?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: e0299ced-89d1-ea11-bbaa-000d3a2b9185 + customerRef: + id: b61217b3-89d1-ea11-bbaa-000d3a2b9185 + companyName: Trey Researches + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 128.16 + currency: GBP + currencyRate: 1 + date: '2019-01-15T00:00:00' + note: Invoice 102001 + lines: + - amount: 128.16 + links: + - type: Invoice + id: 18c906bf-89d1-ea11-bbaa-000d3a2b9185 + amount: -128.16 + currencyRate: 1 + allocatedOnDate: '2019-01-15T00:00:00' + modifiedDate: '2023-03-27T14:21:27Z' + sourceModifiedDate: '0001-01-01T00:00:00Z' + reference: 'Document No: 103001' + metadata: + isDeleted: false + - id: 042a9ced-89d1-ea11-bbaa-000d3a2b9185 + customerRef: + id: b41217b3-89d1-ea11-bbaa-000d3a2b9185 + companyName: Adatum Corporation + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 600.48 + currency: GBP + currencyRate: 1 + date: '2019-01-16T00:00:00' + note: Invoice 102002 + lines: + - amount: 600.48 + links: + - type: Invoice + id: 1bc906bf-89d1-ea11-bbaa-000d3a2b9185 + amount: -600.48 + currencyRate: 1 + allocatedOnDate: '2019-01-16T00:00:00' + modifiedDate: '2023-03-27T14:21:27Z' + sourceModifiedDate: '0001-01-01T00:00:00Z' + reference: 'Document No: 103002' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 249 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/payments?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/payments + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/payments?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 090f5d9f-d1ce-4a61-985f-d3915618b64a_c3bf08a3-4d51-4859-acbb-5075f9484f87 + customerRef: + id: c3bf08a3-4d51-4859-acbb-5075f9484f87 + companyName: Mr Abe + accountRef: + id: 35717508-0696-4481-a32c-2835f0ed8b4e + name: Test GL account 2 + totalAmount: 229.08 + currency: EUR + currencyRate: 1 + date: '2019-11-26T00:00:00Z' + lines: + - amount: 229.08 + links: + - type: Invoice + id: f010d4df-13ea-45d1-8525-785164df7dd9 + amount: -229.08 + currencyRate: 1 + modifiedDate: '2022-10-26T13:36:13Z' + sourceModifiedDate: '2019-11-26T12:31:46Z' + reference: '19230011' + - id: 1650bb9c-5d9a-40f2-9015-0e251a12f861_c3bf08a3-4d51-4859-acbb-5075f9484f87 + customerRef: + id: c3bf08a3-4d51-4859-acbb-5075f9484f87 + companyName: Mr Abe + accountRef: + id: 35717508-0696-4481-a32c-2835f0ed8b4e + name: Test GL account 2 + totalAmount: 991.56 + currency: EUR + currencyRate: 1 + date: '2019-11-26T00:00:00Z' + lines: + - amount: 991.56 + links: + - type: Invoice + id: 013f05e6-2583-4e6d-8309-a479808cf7bf + amount: -991.56 + currencyRate: 1 + modifiedDate: '2022-10-26T13:36:13Z' + sourceModifiedDate: '2019-11-26T12:31:12Z' + reference: '19230010' + pageNumber: 1 + pageSize: 2 + totalResults: 46 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/payments?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/payments + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/payments?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 14b7d656-07ee-4d70-aafa-61c0030c08ad_7e566728-a7f3-4860-a7f5-381664673287 + customerRef: + id: 7e566728-a7f3-4860-a7f5-381664673287 + companyName: Customer A + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 1 + currency: GBP + currencyRate: 1 + date: '2020-01-02T00:00:00Z' + lines: + - amount: 1 + links: + - type: Invoice + id: 6220ed43-1fec-4e17-a88f-c7ee5b949e76 + amount: -1 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:14Z' + sourceModifiedDate: '2020-01-02T10:08:27Z' + reference: '20200002' + - id: d8b093cf-3d37-405b-9e85-72552226553f_7e566728-a7f3-4860-a7f5-381664673287 + customerRef: + id: 7e566728-a7f3-4860-a7f5-381664673287 + companyName: Customer A + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 1 + currency: GBP + currencyRate: 1 + date: '2020-01-02T00:00:00Z' + lines: + - amount: 1 + links: + - type: Invoice + id: 6220ed43-1fec-4e17-a88f-c7ee5b949e76 + amount: -1 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:14Z' + sourceModifiedDate: '2020-01-02T09:58:15Z' + reference: '20200001' + pageNumber: 1 + pageSize: 2 + totalResults: 5 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/payments?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/payments + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/payments?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '135234099' + customerRef: + id: '6162049' + companyName: Wintershall Holding GmbH + totalAmount: 100 + currency: GBP + date: '2017-11-23T00:00:00' + note: 'CODAT LTD ref: NOV TOPUP OTHER �100.00 - Invoice receipt against 015' + lines: + - amount: 100 + links: + - type: Invoice + id: '21973931' + amount: -100 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:37Z' + metadata: + isDeleted: false + - id: '135258250' + customerRef: + id: '6162230' + companyName: Stronachs LLP + totalAmount: 100 + currency: GBP + date: '2017-11-23T00:00:00' + note: 'CODAT LTD ref: NOV TOPUP OTHER �100.00 - Invoice receipt against 006' + lines: + - amount: 100 + links: + - type: Invoice + id: '21952246' + amount: -100 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:37Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1146 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/payments?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/payments + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/payments?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '765831' + customerRef: + id: '113070' + totalAmount: 1 + currency: GBP + date: '2018-09-11T00:00:00' + note: 'Overpayment: invoice #0000003, some test' + lines: + - amount: 1 + links: + - type: PaymentOnAccount + id: '113070' + amount: -1 + currencyRate: 1 + modifiedDate: '2023-03-24T16:07:24Z' + sourceModifiedDate: '2018-09-11T06:58:46' + metadata: + isDeleted: false + - id: '988600' + customerRef: + id: '380630' + totalAmount: 5 + currency: GBP + date: '2019-01-21T00:00:00' + note: 'Overpayment: invoice #0000007' + lines: + - amount: 5 + links: + - type: PaymentOnAccount + id: '380630' + amount: -5 + currencyRate: 1 + modifiedDate: '2023-03-24T16:07:24Z' + sourceModifiedDate: '2019-01-21T10:23:59' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 239 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/payments?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/payments + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/payments?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '139214921' + customerRef: + id: '85743294' + companyName: Parent customer + totalAmount: 1.2 + currency: GBP + date: '2010-04-07T00:00:00' + note: '' + lines: + - amount: 1.2 + links: + - type: Invoice + id: '137055108' + amount: -1.2 + currencyRate: 1 + modifiedDate: '2022-09-30T10:29:15Z' + - id: '86861497' + customerRef: + id: '69946501' + companyName: Peter Lord + totalAmount: 10 + currency: GBP + date: '2017-05-01T00:00:00' + note: '' + lines: + - amount: 10 + links: + - type: Invoice + id: '85315064' + amount: -10 + currencyRate: 1 + modifiedDate: '2022-09-30T10:29:15Z' + pageNumber: 1 + pageSize: 2 + totalResults: 74 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/payments?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/payments + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/payments?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '8828' + customerRef: + id: '417' + companyName: 10 Breww Ltd + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2021-04-09T00:00:00' + lines: + - amount: 0 + links: + - type: Invoice + id: '8530' + amount: -16 + currencyRate: 1 + - type: CreditNote + id: '8828' + amount: 16 + currencyRate: 1 + modifiedDate: '2022-09-20T08:18:33Z' + sourceModifiedDate: '2022-02-25T10:58:37' + reference: 'Credit Memo #CM28' + - id: '428' + customerRef: + id: '417' + companyName: 10 Breww Ltd + accountRef: + id: '122' + name: Undeposited Funds + totalAmount: 90 + currency: GBP + currencyRate: 1 + date: '2021-04-20T00:00:00' + lines: + - amount: 90 + links: + - type: Invoice + id: '416' + amount: -90 + currencyRate: 1 + - amount: 10 + links: + - type: Invoice + id: '416' + amount: -10 + currencyRate: 1 + - amount: -10 + links: + - type: Other + id: '428' + amount: 10 + currencyRate: 1 + modifiedDate: '2022-09-20T08:18:33Z' + sourceModifiedDate: '2022-04-28T13:36:54' + reference: 'Payment #PYMT01' + pageNumber: 1 + pageSize: 2 + totalResults: 113 + _links: + current: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/payments?page=1&pageSize=2 + self: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/payments + next: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/payments?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 6915-1197775450 + customerRef: + id: 220000-933272658 + companyName: 'Melton, Johnny' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + totalAmount: 14488.64 + currency: GBP + currencyRate: 1 + date: '2023-01-10T00:00:00' + note: Check - 80000-933270541 + lines: + - amount: 14488.64 + links: + - type: Invoice + id: '469E-1071530054' + amount: -14488.64 + currencyRate: 1 + modifiedDate: '2023-04-26T09:08:36Z' + sourceModifiedDate: '2023-12-16T05:06:11' + reference: '19650' + metadata: + isDeleted: false + - id: 6973-1197775625 + customerRef: + id: 420000-1071522044 + companyName: 'Prentice, Adelaide' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + totalAmount: 431.95 + currency: GBP + currencyRate: 1 + date: '2023-01-15T00:00:00' + note: Check - 80000-933270541 + lines: + - amount: 431.95 + links: + - type: Invoice + id: 2453-1071526256 + amount: -431.95 + currencyRate: 1 + modifiedDate: '2023-04-26T09:08:36Z' + sourceModifiedDate: '2023-12-16T05:06:11' + reference: '983409' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 108 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/payments?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/payments + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/payments?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '710' + customerRef: + id: '9' + companyName: Abe + accountRef: + id: '56' + name: Undeposited Funds + totalAmount: 95.2 + currency: GBP + currencyRate: 1 + date: '2018-10-05T00:00:00' + note: Sarah's Test + lines: + - amount: 95.2 + links: + - type: Invoice + id: '688' + amount: -95.2 + currencyRate: 1 + modifiedDate: '2023-01-18T11:03:14Z' + sourceModifiedDate: '2020-08-14T09:59:29Z' + - id: '9298' + customerRef: + id: '9' + companyName: Abe + accountRef: + id: '56' + name: Undeposited Funds + totalAmount: 95.2 + currency: GBP + currencyRate: 1 + date: '2018-10-05T00:00:00' + note: Adeel Test + lines: + - amount: 95.2 + links: + - type: PaymentOnAccount + id: '9' + amount: -95.2 + currencyRate: 1 + modifiedDate: '2023-01-18T11:03:18Z' + sourceModifiedDate: '2022-06-20T13:51:36Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3723 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/payments?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/payments + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/payments?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '25' + customerRef: + id: '55' + companyName: Oxon Insurance - Holiday Party + accountRef: + id: '81' + name: Current + totalAmount: 10800 + currency: GBP + currencyRate: 1 + date: '2016-02-12T00:00:00' + note: '' + lines: + - amount: 10800 + links: + - type: PaymentOnAccount + id: '55' + amount: -10800 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:50Z' + sourceModifiedDate: '2022-02-03T12:09:35Z' + metadata: + isDeleted: false + - id: '31' + customerRef: + id: '59' + companyName: Ecker Holiday event + accountRef: + id: '81' + name: Current + totalAmount: 15615 + currency: GBP + currencyRate: 1 + date: '2016-02-12T00:00:00' + note: '' + lines: + - amount: 15615 + links: + - type: Invoice + id: '30' + amount: -15615 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:50Z' + sourceModifiedDate: '2016-09-12T16:50:17Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 813 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/payments?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/payments + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/payments?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '29684' + customerRef: + id: STE001 + companyName: Stevenson & Smith + totalAmount: 500 + currency: GBP + currencyRate: 1 + date: '2019-01-30T00:00:00Z' + note: Payment on Account + lines: + - amount: 12.5 + links: + - type: Invoice + id: '29676' + amount: -12.5 + currencyRate: 1 + - amount: 487.5 + links: + - type: Invoice + id: '29851' + amount: -487.5 + currencyRate: 1 + modifiedDate: '2022-10-14T09:36:05Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: '5897532' + - id: '29681' + customerRef: + id: MAC001 + companyName: Macolm Hall Associates + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2019-12-31T00:00:00Z' + note: Opening Balance + lines: + - amount: 0 + links: + - type: Invoice + id: '29745' + amount: 0.05 + currencyRate: 1 + - type: CreditNote + id: '29681' + amount: -0.05 + currencyRate: 1 + modifiedDate: '2022-10-14T09:36:05Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: O/BAL + pageNumber: 1 + pageSize: 2 + totalResults: 83 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/payments?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/payments + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/payments?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '53' + customerRef: + id: STE001 + companyName: Stevenson & Smith + accountRef: + id: '1200' + name: Bank Current Account + totalAmount: 500 + currency: GBP + currencyRate: 1 + date: '2021-01-30T00:00:00' + note: 'Sales receipt on account 53 linked to sales invoice tx-3, sales invoice inv-31.' + lines: + - amount: 12.5 + links: + - type: Invoice + id: TX-3 + amount: -12.5 + currencyRate: 1 + - amount: 245.34 + links: + - type: Invoice + id: INV-31 + amount: -245.34 + currencyRate: 1 + - amount: 126.9 + links: + - type: Invoice + id: INV-31 + amount: -126.9 + currencyRate: 1 + - amount: 115.26 + links: + - type: Invoice + id: INV-31 + amount: -115.26 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:39Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + - id: '8' + customerRef: + id: MAC001 + companyName: Macolm Hall Associates + accountRef: + id: '' + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2021-12-31T00:00:00' + note: Sales credit tx-8 linked to sales invoice inv-10. + lines: + - amount: 0 + links: + - type: Invoice + id: INV-10 + amount: -0.05 + currencyRate: 1 + - type: CreditNote + id: TX-8 + amount: 0.05 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:39Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 53 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/payments?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/payments + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/payments?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: d39f7a5733de11e797950a57719b2edb + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + totalAmount: -1080 + currency: GBP + currencyRate: 1 + date: '2017-05-08T00:00:00' + note: Customer refund using credit/debit card + lines: + - amount: -1080 + links: + - type: CreditNote + id: c1a0176c33de11e797950a57719b2edb + amount: 1080 + currencyRate: 1 + modifiedDate: '2022-10-24T14:55:39Z' + sourceModifiedDate: '2017-05-08T11:09:38Z' + - id: 03a5fdc8baa643fb97587033b0c4590b + customerRef: + id: 3cc3148bbd8111e8bad90617b3da4b8a + companyName: John's Test Customer + accountRef: + id: 2572c8766afc11e8aaa5027d54329956 + name: Tide Current + totalAmount: 100 + currency: GBP + currencyRate: 1 + date: '2017-11-23T00:00:00' + note: Customer receipt using credit/debit card + lines: + - amount: 100 + links: + - type: Invoice + id: ede1e735bd8111e8bad90617b3da4b8a + amount: -100 + currencyRate: 1 + modifiedDate: '2022-10-24T14:55:39Z' + sourceModifiedDate: '2019-01-17T14:14:55Z' + pageNumber: 1 + pageSize: 2 + totalResults: 2321 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/payments?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/payments + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/payments?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '2918' + customerRef: + id: '12' + companyName: MK Manufacturing + accountRef: + id: '353' + name: Current Account + paymentMethodRef: + id: '1' + name: Printed Check + totalAmount: 120 + currency: GBP + date: '2021-04-22T00:00:00' + note: '' + lines: + - amount: 120 + links: + - type: Invoice + id: '2916' + amount: -120 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:02Z' + sourceModifiedDate: '2021-04-22T11:01:11Z' + metadata: + isDeleted: false + - id: '6105' + customerRef: + id: '531' + companyName: Shoprite + accountRef: + id: '353' + name: Current Account + paymentMethodRef: + id: '6' + name: Cash + totalAmount: 150 + currency: GBP + date: '2022-04-19T00:00:00' + note: '' + lines: + - amount: 150 + links: + - type: PaymentOnAccount + id: '531' + amount: -150 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:02Z' + sourceModifiedDate: '2022-04-19T13:38:45Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/payments?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/payments + Xero: + value: + results: + - id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + customerRef: + id: afd4093b-c655-4847-8ee2-10a4f2c3eae3 + companyName: Maddox Publishing Group + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 4200 + currency: GBP + currencyRate: 1 + date: '2022-02-17T00:00:00' + lines: + - amount: 4200 + links: + - type: Invoice + id: 321bfed3-2da2-4969-9358-4de97821181b + amount: -4200 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:08Z' + sourceModifiedDate: '2021-01-02T22:50:58' + metadata: + isDeleted: false + - id: 8c481b70-b5d7-4de4-a7f7-9e161be2c472 + customerRef: + id: a871a956-05b5-4e2a-9419-7aeb478ca647 + companyName: Ridgeway University + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 500 + currency: GBP + currencyRate: 1 + date: '2022-02-17T00:00:00' + lines: + - amount: 500 + links: + - type: Invoice + id: 4b6d0c8f-10fa-42cd-a6e5-53b175e90005 + amount: -500 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:08Z' + sourceModifiedDate: '2021-01-02T22:51:43' + reference: '' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 30 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/payments?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/payments + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/payments?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000070175' + customerRef: + id: '104957000000037097' + companyName: Test Company + accountRef: + id: '104957000000060010' + name: Abdi Test + totalAmount: 9001 + currency: GBP + currencyRate: 1 + date: '2020-02-06T00:00:00' + note: Cheque deposit + lines: + - amount: 9001 + links: + - type: Invoice + id: '104957000000038052' + amount: -9001 + currencyRate: 1 + modifiedDate: '2022-10-03T08:41:17Z' + reference: '4' + - id: '104957000000067014' + customerRef: + id: '104957000000037097' + companyName: Test Company + accountRef: + id: '104957000000060010' + name: Abdi Test + totalAmount: 9001 + currency: GBP + currencyRate: 1 + date: '2020-02-14T00:00:00' + note: '' + lines: + - amount: 9001 + links: + - type: Invoice + id: '104957000000038106' + amount: -9001 + currencyRate: 1 + modifiedDate: '2022-10-03T08:41:17Z' + reference: '1' + pageNumber: 1 + pageSize: 2 + totalResults: 33 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/payments?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/payments + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/payments?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List payments* endpoint returns a list of [payments](https://docs.codat.io/lending-api#/schemas/Payment) for a given company's connection. + + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-payments + x-speakeasy-group: accounts-receivable.payments + '/companies/{companyId}/data/payments/{paymentId}': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/paymentId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingPayment' + examples: + Clear Books: + value: + id: 7ba4fc1b-e248-49ba-8bf8-0813d7f203a8 + customerRef: + id: a82042f1-a005-4ca5-bfd3-5bc237123aa5 + companyName: Keara Leffler + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + totalAmount: 3669.52 + currency: GBP + currencyRate: 1 + date: '2022-04-25T13:04:02' + note: Payment against invoice ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + lines: + - amount: 3669.52 + links: + - type: Invoice + id: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + amount: -3669.52 + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-04-25T13:04:02' + reference: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: e0299ced-89d1-ea11-bbaa-000d3a2b9185 + customerRef: + id: b61217b3-89d1-ea11-bbaa-000d3a2b9185 + companyName: Trey Researches + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 128.16 + currency: GBP + currencyRate: 1 + date: '2019-01-15T00:00:00' + note: Invoice 102001 + lines: + - amount: 128.16 + links: + - type: Invoice + id: 18c906bf-89d1-ea11-bbaa-000d3a2b9185 + amount: -128.16 + currencyRate: 1 + allocatedOnDate: '2019-01-15T00:00:00' + modifiedDate: '2023-03-27T14:21:27Z' + sourceModifiedDate: '0001-01-01T00:00:00Z' + reference: 'Document No: 103001' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 090f5d9f-d1ce-4a61-985f-d3915618b64a_c3bf08a3-4d51-4859-acbb-5075f9484f87 + customerRef: + id: c3bf08a3-4d51-4859-acbb-5075f9484f87 + companyName: Mr Abe + accountRef: + id: 35717508-0696-4481-a32c-2835f0ed8b4e + name: Test GL account 2 + totalAmount: 229.08 + currency: EUR + currencyRate: 1 + date: '2019-11-26T00:00:00Z' + lines: + - amount: 229.08 + links: + - type: Invoice + id: f010d4df-13ea-45d1-8525-785164df7dd9 + amount: -229.08 + currencyRate: 1 + modifiedDate: '2022-10-26T13:36:13Z' + sourceModifiedDate: '2019-11-26T12:31:46Z' + reference: '19230011' + Exact (UK): + value: + id: 14b7d656-07ee-4d70-aafa-61c0030c08ad_7e566728-a7f3-4860-a7f5-381664673287 + customerRef: + id: 7e566728-a7f3-4860-a7f5-381664673287 + companyName: Customer A + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 1 + currency: GBP + currencyRate: 1 + date: '2020-01-02T00:00:00Z' + lines: + - amount: 1 + links: + - type: Invoice + id: 6220ed43-1fec-4e17-a88f-c7ee5b949e76 + amount: -1 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:14Z' + sourceModifiedDate: '2020-01-02T10:08:27Z' + reference: '20200002' + FreeAgent: + value: + id: '135234099' + customerRef: + id: '6162049' + companyName: Wintershall Holding GmbH + totalAmount: 100 + currency: GBP + date: '2017-11-23T00:00:00' + note: 'CODAT LTD ref: NOV TOPUP OTHER �100.00 - Invoice receipt against 015' + lines: + - amount: 100 + links: + - type: Invoice + id: '21973931' + amount: -100 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:37Z' + metadata: + isDeleted: false + FreshBooks: + value: + id: '765831' + customerRef: + id: '113070' + totalAmount: 1 + currency: GBP + date: '2018-09-11T00:00:00' + note: 'Overpayment: invoice #0000003, some test' + lines: + - amount: 1 + links: + - type: PaymentOnAccount + id: '113070' + amount: -1 + currencyRate: 1 + modifiedDate: '2023-03-24T16:07:24Z' + sourceModifiedDate: '2018-09-11T06:58:46' + metadata: + isDeleted: false + KashFlow: + value: + id: '139214921' + customerRef: + id: '85743294' + companyName: Parent customer + totalAmount: 1.2 + currency: GBP + date: '2010-04-07T00:00:00' + note: '' + lines: + - amount: 1.2 + links: + - type: Invoice + id: '137055108' + amount: -1.2 + currencyRate: 1 + modifiedDate: '2022-09-30T10:29:15Z' + Oracle NetSuite: + value: + id: '8828' + customerRef: + id: '417' + companyName: 10 Breww Ltd + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2021-04-09T00:00:00' + lines: + - amount: 0 + links: + - type: Invoice + id: '8530' + amount: -16 + currencyRate: 1 + - type: CreditNote + id: '8828' + amount: 16 + currencyRate: 1 + modifiedDate: '2022-09-20T08:18:33Z' + sourceModifiedDate: '2022-02-25T10:58:37' + reference: 'Credit Memo #CM28' + QuickBooks Desktop: + value: + id: 6915-1197775450 + customerRef: + id: 220000-933272658 + companyName: 'Melton, Johnny' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + totalAmount: 14488.64 + currency: GBP + currencyRate: 1 + date: '2023-01-10T00:00:00' + note: Check - 80000-933270541 + lines: + - amount: 14488.64 + links: + - type: Invoice + id: '469E-1071530054' + amount: -14488.64 + currencyRate: 1 + modifiedDate: '2023-04-26T09:08:36Z' + sourceModifiedDate: '2023-12-16T05:06:11' + reference: '19650' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '710' + customerRef: + id: '9' + companyName: Abe + accountRef: + id: '56' + name: Undeposited Funds + totalAmount: 95.2 + currency: GBP + currencyRate: 1 + date: '2018-10-05T00:00:00' + note: Sarah's Test + lines: + - amount: 95.2 + links: + - type: Invoice + id: '688' + amount: -95.2 + currencyRate: 1 + modifiedDate: '2023-01-18T11:03:14Z' + sourceModifiedDate: '2020-08-14T09:59:29Z' + QuickBooks Online Sandbox: + value: + id: '25' + customerRef: + id: '55' + companyName: Oxon Insurance - Holiday Party + accountRef: + id: '81' + name: Current + totalAmount: 10800 + currency: GBP + currencyRate: 1 + date: '2016-02-12T00:00:00' + note: '' + lines: + - amount: 10800 + links: + - type: PaymentOnAccount + id: '55' + amount: -10800 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:50Z' + sourceModifiedDate: '2022-02-03T12:09:35Z' + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '29684' + customerRef: + id: STE001 + companyName: Stevenson & Smith + totalAmount: 500 + currency: GBP + currencyRate: 1 + date: '2019-01-30T00:00:00Z' + note: Payment on Account + lines: + - amount: 12.5 + links: + - type: Invoice + id: '29676' + amount: -12.5 + currencyRate: 1 + - amount: 487.5 + links: + - type: Invoice + id: '29851' + amount: -487.5 + currencyRate: 1 + modifiedDate: '2022-10-14T09:36:05Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: '5897532' + Sage 50 (UK): + value: + id: '53' + customerRef: + id: STE001 + companyName: Stevenson & Smith + accountRef: + id: '1200' + name: Bank Current Account + totalAmount: 500 + currency: GBP + currencyRate: 1 + date: '2021-01-30T00:00:00' + note: 'Sales receipt on account 53 linked to sales invoice tx-3, sales invoice inv-31.' + lines: + - amount: 12.5 + links: + - type: Invoice + id: TX-3 + amount: -12.5 + currencyRate: 1 + - amount: 245.34 + links: + - type: Invoice + id: INV-31 + amount: -245.34 + currencyRate: 1 + - amount: 126.9 + links: + - type: Invoice + id: INV-31 + amount: -126.9 + currencyRate: 1 + - amount: 115.26 + links: + - type: Invoice + id: INV-31 + amount: -115.26 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:39Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: d39f7a5733de11e797950a57719b2edb + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + totalAmount: -1080 + currency: GBP + currencyRate: 1 + date: '2017-05-08T00:00:00' + note: Customer refund using credit/debit card + lines: + - amount: -1080 + links: + - type: CreditNote + id: c1a0176c33de11e797950a57719b2edb + amount: 1080 + currencyRate: 1 + modifiedDate: '2022-10-24T14:55:39Z' + sourceModifiedDate: '2017-05-08T11:09:38Z' + Sage Intacct: + value: + id: '2918' + customerRef: + id: '12' + companyName: MK Manufacturing + accountRef: + id: '353' + name: Current Account + paymentMethodRef: + id: '1' + name: Printed Check + totalAmount: 120 + currency: GBP + date: '2021-04-22T00:00:00' + note: '' + lines: + - amount: 120 + links: + - type: Invoice + id: '2916' + amount: -120 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:02Z' + sourceModifiedDate: '2021-04-22T11:01:11Z' + metadata: + isDeleted: false + Xero: + value: + id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + customerRef: + id: afd4093b-c655-4847-8ee2-10a4f2c3eae3 + companyName: Maddox Publishing Group + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 4200 + currency: GBP + currencyRate: 1 + date: '2022-02-17T00:00:00' + lines: + - amount: 4200 + links: + - type: Invoice + id: 321bfed3-2da2-4969-9358-4de97821181b + amount: -4200 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:08Z' + sourceModifiedDate: '2021-01-02T22:50:58' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000070175' + customerRef: + id: '104957000000037097' + companyName: Test Company + accountRef: + id: '104957000000060010' + name: Abdi Test + totalAmount: 9001 + currency: GBP + currencyRate: 1 + date: '2020-02-06T00:00:00' + note: Cheque deposit + lines: + - amount: 9001 + links: + - type: Invoice + id: '104957000000038052' + amount: -9001 + currencyRate: 1 + modifiedDate: '2022-10-03T08:41:17Z' + reference: '4' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get payment + description: | + The *Get payment* endpoint returns a single payment for a given paymentId. + + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-payment + x-speakeasy-group: accounts-receivable.payments + '/companies/{companyId}/data/suppliers': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + summary: List suppliers + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingSuppliers' + examples: + Clear Books: + value: + results: + - id: owQ2Gqgj9f + supplierName: Abshire - Kshlerin + contactName: Faye Hansen + emailAddress: hello@Abshire-Kshlerin.info + phone: 01338 858162 + addresses: + - type: Delivery + line1: Suite 431 + line2: 289 Giles Lake + city: Cesarmouth + region: Northern Ireland + country: United Kingdom + postalCode: BG40 9GP + registrationNumber: VYL1XZXR + taxNumber: '1396267523.0914588' + status: Active + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '1660-11-28T23:18:00' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: FyUkHbZxhn + supplierName: Arjun Kuvalis + contactName: Werner Langworth + emailAddress: Arjun34@hotmail.com + phone: 0116 796 3163 + addresses: + - type: Delivery + line1: Suite 214 + line2: 8439 Lueilwitz Passage + city: Fernandohaven + region: Northern Ireland + country: United Kingdom + postalCode: JG04 7PV + - type: Delivery + line1: Suite 096 + line2: 864 Halie Course + city: Juliochester + region: England + country: United Kingdom + postalCode: DZ8 4BF + - type: Delivery + line1: Suite 001 + line2: 416 Stokes Fords + city: Naderborough + region: Wales + country: United Kingdom + postalCode: XG25 0XX + registrationNumber: NI7JEJVM + taxNumber: '7505220209.583549' + status: Active + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '0177-04-27T11:56:00' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 100 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/suppliers?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/suppliers + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/suppliers?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 78623f13-931e-eb11-bbf8-0022481b3585 + supplierName: '' + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:12Z' + sourceModifiedDate: '2020-11-04T11:44:22Z' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: be49ec62-6754-ed11-946f-0022481b67d1 + supplierName: '' + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:12Z' + sourceModifiedDate: '2022-10-25T13:17:36Z' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 31 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/suppliers + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/suppliers?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 3150917c-1d92-4d77-9018-31b5c4758ca9 + supplierName: Abe + contactName: Kelly's Contact Name + emailAddress: sales@kellysupplies.com + phone: 07999 999999 + addresses: + - type: Billing + line1: Unit 51 + city: Bakersfield + region: California + country: US + postalCode: '933081' + registrationNumber: '8409314368' + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2022-07-15T12:01:15Z' + defaultCurrency: EUR + - id: 00014c12-2616-481a-a2e8-31bdf2497775 + supplierName: Ann's test supplier 2 + contactName: Ann's contact name + emailAddress: anna@anna888888.com + phone: '55555555' + addresses: + - type: Billing + line1: line1 + line2: line2 + city: city + region: region + country: RU + postalCode: postal + registrationNumber: '55566677788899944455' + taxNumber: RU4444444 + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2021-06-09T12:04:08Z' + defaultCurrency: USD + pageNumber: 1 + pageSize: 2 + totalResults: 73 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/suppliers?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/suppliers + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/suppliers?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 0185fea2-0298-445b-909a-0db685118a9e + supplierName: a + addresses: + - type: Billing + country: GB + status: Active + modifiedDate: '2022-10-26T13:33:13Z' + sourceModifiedDate: '2017-08-02T10:58:54Z' + defaultCurrency: GBP + - id: 64ae712f-4155-48bb-9fce-98232c51d979 + supplierName: aa + addresses: + - type: Billing + country: GB + status: Active + modifiedDate: '2022-10-26T13:33:13Z' + sourceModifiedDate: '2020-05-01T14:05:46Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 118 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '11526230' + supplierName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Active + modifiedDate: '2023-04-25T14:19:08Z' + sourceModifiedDate: '2023-04-17T06:02:46' + metadata: + isDeleted: false + - id: '9677150' + supplierName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Active + modifiedDate: '2023-04-25T14:19:08Z' + sourceModifiedDate: '2023-04-24T06:19:23' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 159 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: api vendor + supplierName: api vendor + addresses: [] + status: Active + modifiedDate: '2023-03-24T16:07:25Z' + metadata: + isDeleted: false + - id: DUndsRykrmy8kFsc+FvYk29YkJze4zSjGecoF4YcUEhVU7auJ5JkQA0VjXptZ7XQ+D4n6WoxFIkaGY2V/t4flA== + supplierName: 'Chekko Test merchant 100 - Test Very long name: ORIG CO NAME:AMERICAN EXPRESS ORIG ID:9493560001 DESC DATE:220307 CO ENTRY DESCR:ACH PMT SEC:CCD TRACE#:021000023255482 EED:220307 IND ID:A4670 IND NAME:Rick Sanchez' + addresses: [] + status: Active + modifiedDate: '2023-03-24T16:07:25Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '6202387' + supplierName: Dell + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + taxNumber: '' + status: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '2017-05-09T00:00:00' + - id: '9338173' + supplierName: Home + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + taxNumber: '' + status: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '1990-01-01T00:00:00' + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/suppliers?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/suppliers + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/suppliers?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '779' + supplierName: Test Vendor + contactName: Test Vendor + emailAddress: '' + phone: '' + addresses: [] + status: Active + modifiedDate: '2023-01-30T14:47:02Z' + sourceModifiedDate: '2022-02-04T14:24:43' + defaultCurrency: GBP + - id: '726' + supplierName: Vendor -.A + contactName: Vendor -.A + emailAddress: '' + phone: '' + addresses: [] + status: Active + modifiedDate: '2023-01-30T14:47:02Z' + sourceModifiedDate: '2021-03-26T09:53:15' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/suppliers + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/suppliers?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: A60000-1197760912 + supplierName: A Cheung Limited + contactName: Angela Cheung + emailAddress: AC@CheungLimited.com + phone: 510 555 5723 + addresses: + - type: Billing + line1: 'A Cheung Limited, Angela Cheung' + line2: 3818 Bear Rd. West + city: Berkeley + region: CA + postalCode: '94688' + status: Active + modifiedDate: '2023-04-26T09:09:03Z' + sourceModifiedDate: '2023-12-16T05:06:44' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: A40000-1197774038 + supplierName: Bank of Anycity + contactName: Lisa D. Holzhauser + emailAddress: lisah@samplename.com + phone: 415-555-9135 + addresses: + - type: Billing + line1: 'Bank of Anycity, Lisa Holzhauser' + line2: 1935 Main Street + city: Middlefield + region: CA + postalCode: '94482' + status: Active + modifiedDate: '2023-04-26T09:09:03Z' + sourceModifiedDate: '2023-12-16T05:06:44' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 54 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/suppliers?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/suppliers + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/suppliers?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '41' + supplierName: AI Support + contactName: AI Support + addresses: + - type: Billing + line1: test + region: string + country: Djibouti + status: Active + modifiedDate: '2023-01-18T11:02:36Z' + sourceModifiedDate: '2022-12-07T10:48:18Z' + defaultCurrency: GBP + - id: '42' + supplierName: AI Support 2 + contactName: AI Support 2 + addresses: + - type: Billing + line1: test + region: string + country: DJ + status: Active + modifiedDate: '2023-01-18T11:02:36Z' + sourceModifiedDate: '2021-08-31T08:45:02Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 23 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '129' + supplierName: Ally Johnson + contactName: Miss Smith + phone: 0728 38474 + addresses: + - type: Billing + line1: 100 London Road + line2: Angel + city: London + region: Greater London + country: England + postalCode: EC1M + status: Active + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-13T01:51:08Z' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: '88' + supplierName: Andrew Haberbosch + addresses: [] + status: Active + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2022-07-06T15:55:28Z' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '776' + supplierName: Aaren + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Unknown + line1: '' + line2: '' + city: '' + region: '' + country: Great Britain + postalCode: '' + taxNumber: '' + status: Archived + modifiedDate: '2022-10-14T09:35:58Z' + defaultCurrency: GBP + metadata: + isDeleted: true + - id: '914' + supplierName: Aaren + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Unknown + line1: '' + line2: '' + city: '' + region: '' + country: Great Britain + postalCode: '' + taxNumber: '' + status: Archived + modifiedDate: '2022-10-14T09:35:58Z' + defaultCurrency: GBP + metadata: + isDeleted: true + pageNumber: 1 + pageSize: 2 + totalResults: 943 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: CON001 + supplierName: Concept Stationery Supplies + contactName: Mark Ramsay + emailAddress: newbusinessadvice@sage.com + phone: 0191 643 4343 + addresses: + - type: Delivery + line1: 66 New Street + line2: Ridgeway + city: Newcastle Upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + - type: Unknown + line1: 66 New Street + line2: Ridgeway + city: Newcastle upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + taxNumber: GB988 3453 23 + status: Active + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: MCN001 + supplierName: McNally Computer Supplies + contactName: Stuart Lynn + emailAddress: newbusinessadvice@sage.com + phone: 0191 415 3434 + addresses: + - type: Delivery + line1: Station Lane Ind Est + line2: Birtley + city: Chester le Street + region: County Durham + country: GB + postalCode: DH1 3RG + - type: Unknown + line1: Station Lane Ind Est + line2: Birtley + city: Chester le Street + region: County Durham + country: GB + postalCode: DH1 3RG + taxNumber: GB455 2385 34 + status: Active + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-12-05T13:37:26Z' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 15 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/suppliers?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/suppliers + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/suppliers?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 65179671e9ef424caff8b9006cd111c8 + supplierName: 5555 Abdul's Test Name + contactName: Main Contact + addresses: + - type: Billing + country: United Kingdom (GB) + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2020-02-25T17:23:33Z' + defaultCurrency: GBP + - id: cf7f44d693904944a6a7cf3de0887964 + supplierName: Abdi Supplier + contactName: Abdi + emailAddress: abdisupplier@company.com + addresses: + - type: Billing + line1: 1 Place House + city: London + country: United Kingdom (GB) + postalCode: WC1X 1AH + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2020-02-13T10:38:19Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '3' + supplierName: ADP + contactName: 'Jones, William' + phone: 214-760-9491 + addresses: + - type: Unknown + line1: 208 S Akard St + line2: '' + city: Dallas + region: TX + country: United States + postalCode: '75265' + registrationNumber: '' + taxNumber: 85-3678274 + status: Active + modifiedDate: '2023-04-04T16:32:20Z' + sourceModifiedDate: '2023-02-16T09:48:27' + defaultCurrency: USD + metadata: + isDeleted: false + - id: '29' + supplierName: Advisor Printing + contactName: 'Roach, Nathan' + phone: 130-202-4796 + addresses: + - type: Unknown + line1: 5 Carey Hill + line2: '' + city: Drayton Valley + region: Alberta + country: Canada + postalCode: G8V + registrationNumber: '' + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:20Z' + sourceModifiedDate: '2022-06-15T11:38:29' + defaultCurrency: CAD + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 77 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/suppliers?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/suppliers + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/suppliers?page=2&pageSize=2 + Wave: + value: + results: + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0Nzk0 + supplierName: Computer Shop + contactName: '' + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-11-16T18:15:24Z' + sourceModifiedDate: '2020-04-07T13:28:02Z' + defaultCurrency: GBP + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0NzQx + supplierName: Flour Mill + contactName: '' + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-11-16T18:15:24Z' + sourceModifiedDate: '2020-04-07T13:12:40Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 9 + _links: + current: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers?page=1&pageSize=2 + self: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers + next: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers?page=2&pageSize=2 + Xero: + value: + results: + - id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + supplierName: 24 Locks + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + - id: bab779bc-c5fb-42cb-a888-953e8309711c + supplierName: 7-Eleven + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 48 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000001494001' + supplierName: Acme Corporation + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-09-16T13:09:56' + defaultCurrency: GBP + - id: '104957000000648001' + supplierName: Cool company + contactName: Dre + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-06-10T09:07:16' + defaultCurrency: CAD + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List suppliers* endpoint returns a list of [suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) for a given company's connection. + + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-suppliers + x-speakeasy-group: accounts-payable.suppliers + '/companies/{companyId}/data/suppliers/{supplierId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/accountingSupplierId' + get: + tags: + - Accounts payable + summary: Get supplier + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingSupplier' + examples: + Clear Books: + value: + id: owQ2Gqgj9f + supplierName: Abshire - Kshlerin + contactName: Faye Hansen + emailAddress: hello@Abshire-Kshlerin.info + phone: 01338 858162 + addresses: + - type: Delivery + line1: Suite 431 + line2: 289 Giles Lake + city: Cesarmouth + region: Northern Ireland + country: United Kingdom + postalCode: BG40 9GP + registrationNumber: VYL1XZXR + taxNumber: '1396267523.0914588' + status: Active + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '1660-11-28T23:18:00' + defaultCurrency: GBP + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 78623f13-931e-eb11-bbf8-0022481b3585 + supplierName: '' + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:12Z' + sourceModifiedDate: '2020-11-04T11:44:22Z' + defaultCurrency: GBP + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 3150917c-1d92-4d77-9018-31b5c4758ca9 + supplierName: Abe + contactName: Kelly's Contact Name + emailAddress: sales@kellysupplies.com + phone: 07999 999999 + addresses: + - type: Billing + line1: Unit 51 + city: Bakersfield + region: California + country: US + postalCode: '933081' + registrationNumber: '8409314368' + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2022-07-15T12:01:15Z' + defaultCurrency: EUR + Exact (UK): + value: + id: 0185fea2-0298-445b-909a-0db685118a9e + supplierName: a + addresses: + - type: Billing + country: GB + status: Active + modifiedDate: '2022-10-26T13:33:13Z' + sourceModifiedDate: '2017-08-02T10:58:54Z' + defaultCurrency: GBP + FreeAgent: + value: + id: '11526230' + supplierName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Active + modifiedDate: '2023-04-25T14:19:08Z' + sourceModifiedDate: '2023-04-17T06:02:46' + metadata: + isDeleted: false + FreshBooks: + value: + id: api vendor + supplierName: api vendor + addresses: [] + status: Active + modifiedDate: '2023-03-24T16:07:25Z' + metadata: + isDeleted: false + KashFlow: + value: + id: '6202387' + supplierName: Dell + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + taxNumber: '' + status: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '2017-05-09T00:00:00' + Oracle NetSuite: + value: + id: '779' + supplierName: Test Vendor + contactName: Test Vendor + emailAddress: '' + phone: '' + addresses: [] + status: Active + modifiedDate: '2023-01-30T14:47:02Z' + sourceModifiedDate: '2022-02-04T14:24:43' + defaultCurrency: GBP + QuickBooks Desktop: + value: + id: A60000-1197760912 + supplierName: A Cheung Limited + contactName: Angela Cheung + emailAddress: AC@CheungLimited.com + phone: 510 555 5723 + addresses: + - type: Billing + line1: 'A Cheung Limited, Angela Cheung' + line2: 3818 Bear Rd. West + city: Berkeley + region: CA + postalCode: '94688' + status: Active + modifiedDate: '2023-04-26T09:09:03Z' + sourceModifiedDate: '2023-12-16T05:06:44' + defaultCurrency: GBP + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '41' + supplierName: AI Support + contactName: AI Support + addresses: + - type: Billing + line1: test + region: string + country: Djibouti + status: Active + modifiedDate: '2023-01-18T11:02:36Z' + sourceModifiedDate: '2022-12-07T10:48:18Z' + defaultCurrency: GBP + QuickBooks Online Sandbox: + value: + id: '129' + supplierName: Ally Johnson + contactName: Miss Smith + phone: 0728 38474 + addresses: + - type: Billing + line1: 100 London Road + line2: Angel + city: London + region: Greater London + country: England + postalCode: EC1M + status: Active + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-13T01:51:08Z' + defaultCurrency: GBP + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '776' + supplierName: Aaren + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Unknown + line1: '' + line2: '' + city: '' + region: '' + country: Great Britain + postalCode: '' + taxNumber: '' + status: Archived + modifiedDate: '2022-10-14T09:35:58Z' + defaultCurrency: GBP + metadata: + isDeleted: true + Sage 50 (UK): + value: + id: CON001 + supplierName: Concept Stationery Supplies + contactName: Mark Ramsay + emailAddress: newbusinessadvice@sage.com + phone: 0191 643 4343 + addresses: + - type: Delivery + line1: 66 New Street + line2: Ridgeway + city: Newcastle Upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + - type: Unknown + line1: 66 New Street + line2: Ridgeway + city: Newcastle upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + taxNumber: GB988 3453 23 + status: Active + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + defaultCurrency: GBP + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: 65179671e9ef424caff8b9006cd111c8 + supplierName: 5555 Abdul's Test Name + contactName: Main Contact + addresses: + - type: Billing + country: United Kingdom (GB) + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2020-02-25T17:23:33Z' + defaultCurrency: GBP + Sage Intacct: + value: + id: '3' + supplierName: ADP + contactName: 'Jones, William' + phone: 214-760-9491 + addresses: + - type: Unknown + line1: 208 S Akard St + line2: '' + city: Dallas + region: TX + country: United States + postalCode: '75265' + registrationNumber: '' + taxNumber: 85-3678274 + status: Active + modifiedDate: '2023-04-04T16:32:20Z' + sourceModifiedDate: '2023-02-16T09:48:27' + defaultCurrency: USD + metadata: + isDeleted: false + Wave: + value: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0Nzk0 + supplierName: Computer Shop + contactName: '' + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-11-16T18:15:24Z' + sourceModifiedDate: '2020-04-07T13:28:02Z' + defaultCurrency: GBP + Xero: + value: + id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + supplierName: 24 Locks + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000001494001' + supplierName: Acme Corporation + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-09-16T13:09:56' + defaultCurrency: GBP + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get supplier* endpoint returns a single supplier for a given supplierId. + + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-supplier + x-speakeasy-group: accounts-payable.suppliers + '/companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingSupplierId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: List supplier attachments + description: | + The *List supplier attachments* endpoint returns a list of attachments available to download for given `supplierId`. + + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + operationId: list-accounting-supplier-attachments + x-speakeasy-group: accounts-payable.suppliers + '/companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingSupplierId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get supplier attachment + description: | + The *Get supplier attachment* endpoint returns a specific attachment for a given `supplierId` and `attachmentId`. + + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + operationId: get-accounting-supplier-attachment + x-speakeasy-group: accounts-payable.suppliers + '/companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingSupplierId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Download supplier attachment + description: | + The *Download supplier attachment* endpoint downloads a specific attachment for a given `supplierId` and `attachmentId`. + + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + operationId: download-accounting-supplier-attachment + x-speakeasy-group: accounts-payable.suppliers + '/companies/{companyId}/connections/{connectionId}/data/transfers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Transactions + summary: List transfers + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingTransfers' + examples: + Clear Books: + value: + results: + - id: 0bd2f801-6f02-44d6-a2ab-5431553d16f9 + description: depositing 16531.08 into Current Account + contactRef: + id: e4baf949-cb1d-4341-8452-200a93baa3fa + dataType: customers + date: '2022-04-25T07:20:00' + from: + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + dataType: bankAccounts + currency: GBP + amount: 16531.08 + status: Unknown + to: + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + dataType: bankAccounts + currency: GBP + amount: 16531.08 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: + - id: fc253cca-0dfe-46e8-b75f-c7fb3db760b2 + dataType: directIncomes + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2022-04-25T07:20:00' + metadata: + isDeleted: false + - id: 78373000-29e1-4ef4-a2e6-9b573ed656e4 + description: depositing 188.33 into Current Account + contactRef: + id: 51f03576-f6b0-40d5-9fba-81a490411c03 + dataType: customers + date: '2022-04-25T07:20:00' + from: + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + dataType: bankAccounts + currency: GBP + amount: 188.33 + status: Unknown + to: + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + dataType: bankAccounts + currency: GBP + amount: 188.33 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: + - id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + dataType: directIncomes + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2022-04-25T07:20:00' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 357 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/transfers?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/transfers + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/transfers?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: G00001 + date: '2020-11-26T00:00:00' + from: + accountRef: + id: cf1417b3-89d1-ea11-bbaa-000d3a2b9185 + dataType: bankAccounts + currency: GBP + amount: 20 + status: Unknown + to: + accountRef: + id: ce1417b3-89d1-ea11-bbaa-000d3a2b9185 + dataType: bankAccounts + currency: GBP + amount: 20 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-03-27T14:21:26' + sourceModifiedDate: '2020-11-26T12:16:44Z' + metadata: + isDeleted: false + - id: TST-001 + date: '2022-10-25T00:00:00' + from: + accountRef: + id: 8277672c-b8e6-ec11-82f8-0022481a77f0 + dataType: bankAccounts + currency: USD + amount: 3.6 + status: Unknown + to: + accountRef: + id: 8982e7d8-cb19-eb11-bbf9-0022481ad2f4 + dataType: bankAccounts + currency: GBP + amount: 2.34 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-03-27T14:21:26' + sourceModifiedDate: '2022-10-25T15:47:48Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 10 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/transfers?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/transfers + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/transfers?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '307335275' + description: Transfer from Savings Account to Freeagent Test12 + date: '2018-06-14T00:00:00' + from: + accountRef: + id: '532100' + dataType: bankAccounts + currency: GBP + amount: 0.69 + status: Unknown + to: + accountRef: + id: '708504' + dataType: bankAccounts + currency: GBP + amount: 0.69 + status: Unknown + trackingCategoryRefs: + - id: '761' + depositedRecordRefs: [] + modifiedDate: '2023-04-25T14:21:36' + sourceModifiedDate: '2022-03-23T15:55:58Z' + metadata: + isDeleted: false + - id: '308682395' + description: Transfer from Business Current Account to Nic Test11 + date: '2019-12-23T00:00:00' + from: + accountRef: + id: '469976' + dataType: bankAccounts + currency: GBP + amount: 250 + status: Unknown + to: + accountRef: + id: '691393' + dataType: bankAccounts + currency: GBP + amount: 250 + status: Unknown + trackingCategoryRefs: + - id: '761' + depositedRecordRefs: [] + modifiedDate: '2023-04-25T14:21:36' + sourceModifiedDate: '2022-03-31T16:09:27Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 99 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/transfers?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/transfers + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/transfers?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: 2-1 + contactRef: + id: '417' + dataType: customers + date: '2021-03-10T00:00:00' + from: + accountRef: + id: '122' + dataType: bankAccounts + currency: GBP + amount: 90 + status: Unknown + to: + accountRef: + id: '513' + dataType: bankAccounts + currency: GBP + amount: 90 + status: Unknown + trackingCategoryRefs: + - id: location-1 + depositedRecordRefs: + - id: '428' + dataType: payments + modifiedDate: '2022-09-20T08:16:26' + sourceModifiedDate: '2022-04-28T13:36:47' + - id: 2-11822 + contactRef: + id: '417' + dataType: customers + date: '2022-04-28T00:00:00' + from: + accountRef: + id: '513' + dataType: bankAccounts + currency: GBP + amount: 1200 + status: Unknown + to: + accountRef: + id: '122' + dataType: bankAccounts + currency: GBP + amount: 1200 + status: Unknown + trackingCategoryRefs: + - id: location-1 + depositedRecordRefs: + - id: '7526' + dataType: payments + modifiedDate: '2022-09-20T08:16:26' + sourceModifiedDate: '2022-04-28T14:14:33' + pageNumber: 1 + pageSize: 2 + totalResults: 47 + _links: + current: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/connections/5f07dcfb-23c0-49e6-895c-4498ea728ff3/data/transfers?page=1&pageSize=2 + self: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/connections/5f07dcfb-23c0-49e6-895c-4498ea728ff3/data/transfers + next: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/connections/5f07dcfb-23c0-49e6-895c-4498ea728ff3/data/transfers?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 4B1-933288922 + description: Funds Transfer + date: '2024-10-14T00:00:00' + from: + accountRef: + id: 30000-933270541 + dataType: bankAccounts + currency: GBP + amount: 15000 + status: Unknown + to: + accountRef: + id: 20000-933270541 + dataType: bankAccounts + currency: GBP + amount: 15000 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:13:45' + sourceModifiedDate: '2023-12-16T05:03:58' + metadata: + isDeleted: false + - id: C2A-933780606 + description: Funds Transfer + date: '2024-11-25T00:00:00' + from: + accountRef: + id: 20000-933270541 + dataType: bankAccounts + currency: GBP + amount: 42300 + status: Unknown + to: + accountRef: + id: 30000-933270541 + dataType: bankAccounts + currency: GBP + amount: 42300 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:13:45' + sourceModifiedDate: '2023-12-16T05:04:07' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/transfers?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/transfers + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/transfers?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '646' + date: '2020-08-21T00:00:00' + from: + accountRef: + id: '102' + dataType: bankAccounts + currency: GBP + amount: 73.41 + status: Unknown + to: + accountRef: + id: '108' + dataType: bankAccounts + currency: GBP + amount: 73.41 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:36:33' + sourceModifiedDate: '2020-08-26T11:41:20Z' + metadata: + isDeleted: false + - id: '678' + date: '2020-08-22T00:00:00' + from: + accountRef: + id: '124' + dataType: bankAccounts + currency: GBP + amount: 66.66 + status: Unknown + to: + accountRef: + id: '109' + dataType: bankAccounts + currency: GBP + amount: 66.66 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:36:33' + sourceModifiedDate: '2020-08-29T00:01:20Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 442 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/transfers?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/transfers + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/transfers?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '1881' + date: '2020-08-29T00:00:00' + from: + accountRef: + id: '60' + dataType: bankAccounts + currency: GBP + amount: 86.19 + status: Unknown + to: + accountRef: + id: '61' + dataType: bankAccounts + currency: GBP + amount: 86.19 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-01-18T11:03:00' + sourceModifiedDate: '2020-09-03T11:19:54Z' + - id: '1885' + date: '2020-09-02T00:00:00' + from: + accountRef: + id: '60' + dataType: bankAccounts + currency: GBP + amount: 45.73 + status: Unknown + to: + accountRef: + id: '61' + dataType: bankAccounts + currency: GBP + amount: 45.73 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-01-18T11:03:00' + sourceModifiedDate: '2020-09-03T11:23:44Z' + pageNumber: 1 + pageSize: 2 + totalResults: 18 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/transfers?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/transfers + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/transfers?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 434bce57215a11e8b45c025132dab352 + description: Some cheque + date: '2018-03-06T00:00:00' + from: + accountRef: + id: 9a3f0ed6267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 1000 + status: Unknown + to: + accountRef: + id: 9a2c3770267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 1000 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2022-10-24T14:54:11' + sourceModifiedDate: '2018-03-06T16:20:19Z' + - id: 73d909a4215a11e8b45c025132dab352 + description: Some cash + date: '2018-03-06T00:00:00' + from: + accountRef: + id: 9a3f0ed6267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 465 + status: Unknown + to: + accountRef: + id: 9a2c3770267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 465 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2022-10-24T14:54:11' + sourceModifiedDate: '2018-03-06T16:21:40Z' + pageNumber: 1 + pageSize: 2 + totalResults: 646 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/transfers?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/transfers + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/transfers?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '4844' + description: Description + date: '2022-03-10T00:00:00' + from: + accountRef: + id: 'CHECKINGACCOUNT:12' + dataType: bankAccounts + currency: ZAR + amount: 418.27 + status: Unknown + to: + accountRef: + id: 'CHECKINGACCOUNT:9' + dataType: bankAccounts + currency: CAD + amount: 35.45 + status: Unknown + trackingCategoryRefs: + - id: LOCATION-10 + name: South Africa + depositedRecordRefs: [] + modifiedDate: '2023-02-23T14:18:48' + sourceModifiedDate: '2022-03-10T12:38:23' + metadata: + isDeleted: false + - id: '18828' + description: From bank account '700_CHK' to bank account 'Test Savings Account' + date: '2022-10-05T00:00:00' + from: + accountRef: + id: 'CHECKINGACCOUNT:12' + dataType: bankAccounts + currency: ZAR + amount: 4040.62 + status: Unknown + to: + accountRef: + id: 'SAVINGSACCOUNT:17' + dataType: bankAccounts + currency: GBP + amount: 200 + status: Unknown + trackingCategoryRefs: + - id: LOCATION-10 + name: South Africa + depositedRecordRefs: [] + modifiedDate: '2023-02-23T14:18:48' + sourceModifiedDate: '2022-10-05T15:28:15' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/connections/d891700f-d906-4e57-998a-0cf03d2a05d3/data/transfers?page=1&pageSize=2 + self: + href: /companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/connections/d891700f-d906-4e57-998a-0cf03d2a05d3/data/transfers + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List transfers* endpoint returns a list of [transfers](https://docs.codat.io/lending-api#/schemas/Transfer) for a given company's connection. + + [Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + operationId: list-accounting-transfers + x-speakeasy-group: transactions.transfers + '/companies/{companyId}/connections/{connectionId}/data/transfers/{transferId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: transferId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a transfer. + get: + tags: + - Transactions + summary: Get transfer + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingTransfer' + examples: + Clear Books: + value: + id: 0bd2f801-6f02-44d6-a2ab-5431553d16f9 + description: depositing 16531.08 into Current Account + contactRef: + id: e4baf949-cb1d-4341-8452-200a93baa3fa + dataType: customers + date: '2022-04-25T07:20:00' + from: + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + dataType: bankAccounts + currency: GBP + amount: 16531.08 + status: Unknown + to: + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + dataType: bankAccounts + currency: GBP + amount: 16531.08 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: + - id: fc253cca-0dfe-46e8-b75f-c7fb3db760b2 + dataType: directIncomes + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2022-04-25T07:20:00' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: G00001 + date: '2020-11-26T00:00:00' + from: + accountRef: + id: cf1417b3-89d1-ea11-bbaa-000d3a2b9185 + dataType: bankAccounts + currency: GBP + amount: 20 + status: Unknown + to: + accountRef: + id: ce1417b3-89d1-ea11-bbaa-000d3a2b9185 + dataType: bankAccounts + currency: GBP + amount: 20 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-03-27T14:21:26' + sourceModifiedDate: '2020-11-26T12:16:44Z' + metadata: + isDeleted: false + FreeAgent: + value: + id: '307335275' + description: Transfer from Savings Account to Freeagent Test12 + date: '2018-06-14T00:00:00' + from: + accountRef: + id: '532100' + dataType: bankAccounts + currency: GBP + amount: 0.69 + status: Unknown + to: + accountRef: + id: '708504' + dataType: bankAccounts + currency: GBP + amount: 0.69 + status: Unknown + trackingCategoryRefs: + - id: '761' + depositedRecordRefs: [] + modifiedDate: '2023-04-25T14:21:36' + sourceModifiedDate: '2022-03-23T15:55:58Z' + metadata: + isDeleted: false + Oracle NetSuite: + value: + id: 2-1 + contactRef: + id: '417' + dataType: customers + date: '2021-03-10T00:00:00' + from: + accountRef: + id: '122' + dataType: bankAccounts + currency: GBP + amount: 90 + status: Unknown + to: + accountRef: + id: '513' + dataType: bankAccounts + currency: GBP + amount: 90 + status: Unknown + trackingCategoryRefs: + - id: location-1 + depositedRecordRefs: + - id: '428' + dataType: payments + modifiedDate: '2022-09-20T08:16:26' + sourceModifiedDate: '2022-04-28T13:36:47' + QuickBooks Desktop: + value: + id: 4B1-933288922 + description: Funds Transfer + date: '2024-10-14T00:00:00' + from: + accountRef: + id: 30000-933270541 + dataType: bankAccounts + currency: GBP + amount: 15000 + status: Unknown + to: + accountRef: + id: 20000-933270541 + dataType: bankAccounts + currency: GBP + amount: 15000 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:13:45' + sourceModifiedDate: '2023-12-16T05:03:58' + metadata: + isDeleted: false + QuickBooks Online Sandbox: + value: + id: '646' + date: '2020-08-21T00:00:00' + from: + accountRef: + id: '102' + dataType: bankAccounts + currency: GBP + amount: 73.41 + status: Unknown + to: + accountRef: + id: '108' + dataType: bankAccounts + currency: GBP + amount: 73.41 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:36:33' + sourceModifiedDate: '2020-08-26T11:41:20Z' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '1881' + date: '2020-08-29T00:00:00' + from: + accountRef: + id: '60' + dataType: bankAccounts + currency: GBP + amount: 86.19 + status: Unknown + to: + accountRef: + id: '61' + dataType: bankAccounts + currency: GBP + amount: 86.19 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-01-18T11:03:00' + sourceModifiedDate: '2020-09-03T11:19:54Z' + Sage Business Cloud Accounting: + value: + id: 434bce57215a11e8b45c025132dab352 + description: Some cheque + date: '2018-03-06T00:00:00' + from: + accountRef: + id: 9a3f0ed6267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 1000 + status: Unknown + to: + accountRef: + id: 9a2c3770267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 1000 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2022-10-24T14:54:11' + sourceModifiedDate: '2018-03-06T16:20:19Z' + Sage Intacct: + value: + id: '4844' + description: Description + date: '2022-03-10T00:00:00' + from: + accountRef: + id: 'CHECKINGACCOUNT:12' + dataType: bankAccounts + currency: ZAR + amount: 418.27 + status: Unknown + to: + accountRef: + id: 'CHECKINGACCOUNT:9' + dataType: bankAccounts + currency: CAD + amount: 35.45 + status: Unknown + trackingCategoryRefs: + - id: LOCATION-10 + name: South Africa + depositedRecordRefs: [] + modifiedDate: '2023-02-23T14:18:48' + sourceModifiedDate: '2022-03-10T12:38:23' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get transfer* endpoint returns a single transfer for a given transferId. + + [Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-transfer + x-speakeasy-group: transactions.transfers + '/companies/{companyId}/connections/{connectionId}/data/bankAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + x-internal: true + tags: + - Accounting bank data + summary: List bank accounts + operationId: list-accounting-bank-accounts + x-speakeasy-group: accounting-bank-data.accounts + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBankAccounts' + examples: + Dynamics 365 Business Central: + value: + results: + - id: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + accountName: '55' + accountType: Unknown + nominalCode: '10500' + sortCode: '' + accountNumber: '' + iBan: '' + currency: GBP + balance: -352.03 + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2023-02-07T00:00:00' + overdraftLimit: 0 + metadata: + isDeleted: false + - id: 47020f80-60e6-ec11-82f8-0022481a77f0 + accountName: '555' + accountType: Unknown + nominalCode: '40300' + sortCode: '' + accountNumber: '' + iBan: '' + currency: PLN + balance: 661.79 + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2022-06-07T00:00:00' + overdraftLimit: 0 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 28 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '738783' + accountName: \w3fw + accountType: Debit + sortCode: '236972' + accountNumber: A06268209 + currency: GBP + balance: -10484.65 + availableBalance: -10484.65 + modifiedDate: '2023-04-25T14:19:12Z' + metadata: + isDeleted: false + - id: '738778' + accountName: 2e2bna45hy\ + accountType: Debit + sortCode: '236972' + accountNumber: D01825250 + currency: GBP + balance: -114.4 + availableBalance: -114.4 + modifiedDate: '2023-04-25T14:19:12Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 82 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '765768' + accountName: 16th Account + accountType: Unknown + nominalCode: '70700' + currency: GBP + balance: 326 + availableBalance: 326 + modifiedDate: '2022-09-30T10:29:16Z' + - id: '765766' + accountName: 1a1a + accountType: Unknown + nominalCode: '70600' + currency: GBP + balance: 0 + availableBalance: 0 + modifiedDate: '2022-09-30T10:29:16Z' + pageNumber: 1 + pageSize: 2 + totalResults: 56 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '825' + accountName: Codat Europe Bank + accountType: Debit + nominalCode: '111111122222111' + currency: GBP + balance: 558.22 + modifiedDate: '2023-05-02T13:24:36Z' + sourceModifiedDate: '2022-07-15T11:34:02' + metadata: + isDeleted: false + - id: '826' + accountName: Codat Europe Bank USD + accountType: Debit + nominalCode: '1133221133' + currency: USD + modifiedDate: '2023-05-02T13:24:36Z' + sourceModifiedDate: '2021-03-26T10:31:40' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/connections/79f8313e-210a-4dc8-b69f-ba7e5004dda7/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/connections/79f8313e-210a-4dc8-b69f-ba7e5004dda7/data/bankAccounts + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/connections/79f8313e-210a-4dc8-b69f-ba7e5004dda7/data/bankAccounts?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 20000-933270541 + accountName: Checking + accountType: Unknown + nominalCode: '10100' + currency: GBP + balance: 46954.1 + availableBalance: 46954.1 + modifiedDate: '2023-04-26T09:12:37Z' + sourceModifiedDate: '2023-12-16T05:06:45' + metadata: + isDeleted: false + - id: 550001-1071509830 + accountName: Petty Cash + accountType: Unknown + nominalCode: '10400' + currency: GBP + balance: 500 + availableBalance: 500 + modifiedDate: '2023-04-26T09:12:37Z' + sourceModifiedDate: '2023-12-16T05:06:45' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '164' + accountName: '00' + accountType: Debit + nominalCode: '123567' + currency: GBP + balance: 0 + availableBalance: 0 + modifiedDate: '2023-04-26T09:35:57Z' + sourceModifiedDate: '2022-07-20T14:11:28Z' + metadata: + isDeleted: false + - id: '163' + accountName: '11' + accountType: Debit + currency: GBP + balance: 0 + availableBalance: 0 + modifiedDate: '2023-04-26T09:35:57Z' + sourceModifiedDate: '2022-07-20T14:11:28Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 57 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/bankAccounts + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/bankAccounts?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '202' + accountName: \aa + accountType: Debit + currency: GBP + balance: 123 + availableBalance: 123 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2022-11-11T14:15:13Z' + - id: '193' + accountName: 1 year ago + accountType: Debit + currency: GBP + balance: 5300.02 + availableBalance: 5300.02 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2023-01-18T06:05:12Z' + pageNumber: 1 + pageSize: 2 + totalResults: 140 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/bankAccounts + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/bankAccounts?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '1200' + accountName: Bank Current Account + accountType: Unknown + nominalCode: '1200' + sortCode: 23-34-34 + accountNumber: '003234234' + iBan: '' + currency: GBP + balance: -20091.04 + availableBalance: -20091.04 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:25:48' + overdraftLimit: 120000 + institution: Lloyds Bank PLC + metadata: + isDeleted: false + - id: '1210' + accountName: Bank Deposit Account + accountType: Unknown + nominalCode: '1210' + sortCode: 45-45-45 + accountNumber: 9/00474345 + iBan: '' + currency: GBP + balance: 3510 + availableBalance: 3510 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:25:48' + overdraftLimit: 0 + institution: Halifax Building Society + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 154d05abe9f24c4babe0f6a741dec1b9 + accountName: Abdi Internet Bank + accountType: Unknown + nominalCode: '1560' + sortCode: '010101' + accountNumber: '11111' + currency: GBP + balance: 49.61 + availableBalance: 49.61 + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-27T10:53:26Z' + - id: 565ce07212bc492c8c2d04f43f9f67e3 + accountName: Abdi Live Test + accountType: Unknown + nominalCode: '147852' + sortCode: '123456' + accountNumber: '1234567' + currency: GBP + balance: -225830.75 + availableBalance: -225830.75 + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-28T14:00:20Z' + pageNumber: 1 + pageSize: 2 + totalResults: 45 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: 'CREDITCARD:55' + accountName: CoT Credit Card + accountType: Credit + nominalCode: '10021' + currency: GBP + modifiedDate: '2023-04-04T16:31:46Z' + sourceModifiedDate: '2023-03-27T14:11:48' + metadata: + isDeleted: false + - id: 'CREDITCARD:58' + accountName: Cot Credit Card 2 + accountType: Credit + nominalCode: '11112' + currency: GBP + modifiedDate: '2023-04-04T16:31:46Z' + sourceModifiedDate: '2023-03-27T14:15:11' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 14 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts?page=2&pageSize=2 + Xero: + value: + results: + - id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + accountName: Business Bank Account + accountType: Debit + sortCode: '990404' + accountNumber: '987654321' + currency: GBP + balance: 6681.79 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-03-15T20:35:07' + metadata: + isDeleted: false + - id: a8d6fb1a-8c5d-4683-90ce-bf9d28fc62ba + accountName: Business Savings Account + accountType: Debit + sortCode: '890303' + accountNumber: '876543210' + currency: GBP + balance: 0 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-03-15T20:36:06' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts + Zoho Books: + value: + results: + - id: '104957000000060010' + accountName: Abdi Test + accountType: Unknown + sortCode: '112233' + accountNumber: xxxx5678 + currency: GBP + balance: 69858.44 + modifiedDate: '2022-10-03T08:40:38Z' + institution: Test Bank + - id: '104957000000065002' + accountName: Abdi Test 2 + accountType: Unknown + sortCode: '' + accountNumber: '' + currency: AED + balance: 98.03 + modifiedDate: '2022-10-03T08:40:38Z' + institution: '' + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List bank accounts* endpoint returns a list of [bank accounts](https://docs.codat.io/lending-api#/schemas/BankAccount) for a given company's connection. + + [Bank accounts](https://docs.codat.io/lending-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/lending-api#/operations/refresh-company-data). + + '/companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingAccountId' + get: + x-internal: true + tags: + - Accounting bank data + summary: Get bank account + operationId: get-accounting-bank-account + x-speakeasy-group: accounting-bank-data.accounts + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBankAccount' + examples: + Dynamics 365 Business Central: + value: + id: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + accountName: '55' + accountType: Unknown + nominalCode: '10500' + sortCode: '' + accountNumber: '' + iBan: '' + currency: GBP + balance: -352.03 + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2023-02-07T00:00:00' + overdraftLimit: 0 + metadata: + isDeleted: false + FreeAgent: + value: + id: '738783' + accountName: \w3fw + accountType: Debit + sortCode: '236972' + accountNumber: A06268209 + currency: GBP + balance: -10484.65 + availableBalance: -10484.65 + modifiedDate: '2023-04-25T14:19:12Z' + metadata: + isDeleted: false + KashFlow: + value: + id: '765768' + accountName: 16th Account + accountType: Unknown + nominalCode: '70700' + currency: GBP + balance: 326 + availableBalance: 326 + modifiedDate: '2022-09-30T10:29:16Z' + QuickBooks Desktop: + value: + id: 20000-933270541 + accountName: Checking + accountType: Unknown + nominalCode: '10100' + currency: GBP + balance: 46954.1 + availableBalance: 46954.1 + modifiedDate: '2023-04-26T09:12:37Z' + sourceModifiedDate: '2023-12-16T05:06:45' + metadata: + isDeleted: false + Sage 50 (UK): + value: + id: '1200' + accountName: Bank Current Account + accountType: Unknown + nominalCode: '1200' + sortCode: 23-34-34 + accountNumber: '003234234' + iBan: '' + currency: GBP + balance: -20091.04 + availableBalance: -20091.04 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:25:48' + overdraftLimit: 120000 + institution: Lloyds Bank PLC + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: 154d05abe9f24c4babe0f6a741dec1b9 + accountName: Abdi Internet Bank + accountType: Unknown + nominalCode: '1560' + sortCode: '010101' + accountNumber: '11111' + currency: GBP + balance: 49.61 + availableBalance: 49.61 + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-27T10:53:26Z' + Xero: + value: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + accountName: Business Bank Account + accountType: Debit + sortCode: '990404' + accountNumber: '987654321' + currency: GBP + balance: 6681.79 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-03-15T20:35:07' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000060010' + accountName: Abdi Test + accountType: Unknown + sortCode: '112233' + accountNumber: xxxx5678 + currency: GBP + balance: 69858.44 + modifiedDate: '2022-10-03T08:40:38Z' + institution: Test Bank + Oracle NetSuite: + value: + id: '825' + accountName: Codat Europe Bank + accountType: Debit + nominalCode: '111111122222111' + currency: GBP + balance: 558.22 + modifiedDate: '2023-05-02T13:24:36Z' + sourceModifiedDate: '2022-07-15T11:34:02' + metadata: + isDeleted: false + QuickBooks Online Sandbox: + value: + id: '164' + accountName: '00' + accountType: Debit + nominalCode: '123567' + currency: GBP + balance: 0 + availableBalance: 0 + modifiedDate: '2023-04-26T09:35:57Z' + sourceModifiedDate: '2022-07-20T14:11:28Z' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '202' + accountName: \aa + accountType: Debit + currency: GBP + balance: 123 + availableBalance: 123 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2022-11-11T14:15:13Z' + Sage Intacct: + value: + id: 'CREDITCARD:55' + accountName: CoT Credit Card + accountType: Credit + nominalCode: '10021' + currency: GBP + modifiedDate: '2023-04-04T16:31:46Z' + sourceModifiedDate: '2023-03-27T14:11:48' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get bank account* endpoint returns a single account for a given accountId. + + [Bank accounts](https://docs.codat.io/lending-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/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId}/bankTransactions': + get: + x-internal: true + tags: + - Accounting bank data + summary: List bank account transactions + description: | + The *List account bank transactions* endpoint returns a list of [bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) for a given company's connection. + + [Bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: list-accounting-bank-account-transactions + x-speakeasy-name-override: list-transactions + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingAccountId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBankTransactions' + examples: + Dynamics 365 Business Central: + value: + results: + - id: 07c891b4-f67a-ed11-9989-0022481ae525 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2022-11-17T00:00:00' + description: Share Capital + reconciled: false + amount: 1 + balance: 1 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 5ced3895-f77a-ed11-9989-0022481b6241 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2022-11-17T00:00:00' + description: Share Capital + reconciled: false + amount: 1 + balance: 2 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: cd12966b-8871-ed11-8c34-6045bd0c6935 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2022-12-02T00:00:00' + description: '' + reconciled: false + amount: -19 + balance: -17 + transactionType: Other + modifiedDate: '2023-03-27T14:21:19Z' + - id: b13392b6-95a0-ed11-9a88-6045bdd16279 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: '' + reconciled: false + amount: -30 + balance: -72 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: b3696a16-1fa2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: 'Income, Services' + reconciled: false + amount: -10 + balance: -122 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: b73392b6-95a0-ed11-9a88-6045bdd16279 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: Child + reconciled: false + amount: -40 + balance: -112 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: befdd569-22a2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: Child Child + reconciled: false + amount: -13 + balance: -160 + transactionType: Other + modifiedDate: '2023-03-27T14:21:19Z' + - id: cb71c33a-22a2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: 'Income, Services' + reconciled: false + amount: -25 + balance: -147 + transactionType: Other + modifiedDate: '2023-03-27T14:21:19Z' + - id: e7ec12c9-94a0-ed11-9a88-6045bdd16279 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: Child Child + reconciled: false + amount: -10 + balance: -27 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: fef7a026-95a0-ed11-9a88-6045bdd16279 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: '' + reconciled: false + amount: -15 + balance: -42 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 20869cb1-39a2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-01T00:00:00' + description: Accounts Payable + reconciled: false + amount: -14 + balance: -184 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 8c298754-20a2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-01T00:00:00' + description: '' + reconciled: false + amount: -10 + balance: -170 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 935d5578-3ca2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-01T00:00:00' + description: '' + reconciled: false + amount: -17 + balance: -201 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 935f4303-e3a2-ed11-9a88-002248010b7e + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-01T00:00:00' + description: '' + reconciled: false + amount: -17 + balance: -239 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: d8ceb342-dba2-ed11-9a88-002248010b7e + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-01T00:00:00' + description: '' + reconciled: false + amount: -21 + balance: -222 + transactionType: Other + modifiedDate: '2023-03-27T14:21:19Z' + - id: 15719c0c-22a6-ed11-9a88-002248010b7e + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: -20 + balance: -292.69 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 213d027d-b1a3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: -9.35 + balance: -265.19 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 273d027d-b1a3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: Account no cat Balance Sheet + reconciled: false + amount: -7.5 + balance: -272.69 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 978c4a27-e0a2-ed11-9a88-002248010b7e + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: 2.16 + balance: -236.84 + transactionType: Other + modifiedDate: '2023-03-27T14:21:19Z' + - id: a80f63ae-b0a3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: -7.01 + balance: -262.85 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: ad0f63ae-b0a3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: Account no cat Balance Sheet + reconciled: false + amount: 7.01 + balance: -255.84 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: b5de7b74-afa3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: -4.91 + balance: -260.75 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: bbde7b74-afa3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: 4.91 + balance: -255.84 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: f9540bf4-e5a2-ed11-9a88-000d3ad5d945 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: -19 + balance: -255.84 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: feca50d8-22a6-ed11-9a88-002248010b7e + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-06T00:00:00' + description: '' + reconciled: false + amount: -20 + balance: -312.69 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 4777d7ec-cfa6-ed11-9a88-000d3a7fb2e5 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-07T00:00:00' + description: '' + reconciled: false + amount: -2.34 + balance: -315.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 38b632de-7aac-ed11-9a88-002248410639 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-09T00:00:00' + description: Invalid VAT Posting Setup + reconciled: false + amount: -10 + balance: -315.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: ffc0b740-68a8-ed11-9a88-6045bdd12fc1 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-09T00:00:00' + description: '' + reconciled: false + amount: 10 + balance: -305.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 95f27455-7cac-ed11-9a88-002248410639 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-14T00:00:00' + description: '' + reconciled: false + amount: -10 + balance: -325.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 0d6b1378-acae-ed11-9a88-6045bdd16279 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-16T00:00:00' + description: Bank Account Line + reconciled: false + amount: -12 + balance: -337.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 978da9f7-baae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: Bank + reconciled: false + amount: 6 + balance: -342.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: dd34e6eb-b6ae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: G/L + reconciled: false + amount: -1 + balance: -338.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: e234e6eb-b6ae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: Customer + reconciled: false + amount: 2 + balance: -336.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: e734e6eb-b6ae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: Vendor + reconciled: false + amount: -3 + balance: -339.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: ed34e6eb-b6ae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: Bank + reconciled: false + amount: -4 + balance: -343.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: f234e6eb-b6ae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: Employee + reconciled: false + amount: -5 + balance: -348.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 39de1293-d3b1-ed11-9a88-6045bd0f94d6 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-21T00:00:00' + description: '' + reconciled: false + amount: -10 + balance: -352.03 + transactionType: Credit + modifiedDate: '2023-03-27T14:21:19Z' + pageNumber: 1 + pageSize: 100 + totalResults: 37 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts/c9a41bc7-6e5b-ed11-8c34-0022481b8b5b/bankTransactions + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts/c9a41bc7-6e5b-ed11-8c34-0022481b8b5b/bankTransactions + FreeAgent: + value: + results: + - id: '261197890' + accountId: '738783' + clearedOnDate: '2020-10-28T00:00:00' + description: Invoice receipt against 1762 + reconciled: true + amount: 111 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2020-10-28T16:27:10Z' + - id: '290878530' + accountId: '738783' + clearedOnDate: '2021-04-23T00:00:00' + description: Invoice receipt against 1980 + reconciled: true + amount: 10 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2021-04-27T04:55:42Z' + - id: '290825614' + accountId: '738783' + clearedOnDate: '2021-04-26T00:00:00' + description: Invoice receipt against 1976 + reconciled: true + amount: 10 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2021-04-26T14:05:15Z' + - id: '290878531' + accountId: '738783' + clearedOnDate: '2021-04-26T00:00:00' + description: Invoice receipt against 1981 + reconciled: true + amount: 20 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2021-04-27T04:55:44Z' + - id: '291227300' + accountId: '738783' + clearedOnDate: '2021-04-28T00:00:00' + description: Invoice receipt against 2002 + reconciled: true + amount: 20 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2021-04-28T13:43:56Z' + - id: '291242296' + accountId: '738783' + clearedOnDate: '2021-04-28T00:00:00' + description: Invoice receipt against 2012 + reconciled: true + amount: 40 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2021-04-28T16:14:16Z' + - id: '346437532' + accountId: '738783' + clearedOnDate: '2022-03-21T00:00:00' + description: Invoice receipt against 2304 + reconciled: true + amount: 1 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2022-03-21T14:59:40Z' + - id: '346444438' + accountId: '738783' + clearedOnDate: '2022-03-21T00:00:00' + description: Invoice receipt against 2304 + reconciled: true + amount: 1 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2022-03-21T15:37:54Z' + - id: '346444989' + accountId: '738783' + clearedOnDate: '2022-03-21T00:00:00' + description: Invoice receipt against 2304 + reconciled: true + amount: 1 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2022-03-21T15:41:22Z' + - id: '346457774' + accountId: '738783' + clearedOnDate: '2022-03-21T00:00:00' + description: Credit Note refund against 2313 + reconciled: true + amount: -1 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2022-03-21T17:07:50Z' + - id: '346458196' + accountId: '738783' + clearedOnDate: '2022-03-21T00:00:00' + description: Invoice receipt against 2311 + reconciled: true + amount: 1 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2022-03-21T17:14:15Z' + - id: '414441841' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'MCDONALDS - ROYSTON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -12.78 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441842' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'HERMES PARCELNET LTD T/A - 08445437147 - Card Ending: 2327//OTHER/' + reconciled: false + amount: -7.98 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441845' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'TRAVELODGE GB0000 - THAME - Card Ending: 4999//OTHER/' + reconciled: false + amount: -648.63 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441847' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'TRAVELODGE GB0000 - THAME - Card Ending: 4999//OTHER/' + reconciled: false + amount: -324.31 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441849' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'RUGBY, PRET A MANGER - RUGBY - Card Ending: 9271//OTHER/' + reconciled: false + amount: -11.45 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441851' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'Just Eat - London - Card Ending: 9271//OTHER/' + reconciled: false + amount: -22.52 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441852' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'CN TAR TAROM SA-MOBILP - ORAS OTOPENI - Card Ending: 4999//OTHER/' + reconciled: false + amount: -340.13 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441854' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'MOTO RUGBY SERVICES - RUGBY - Card Ending: 9271//OTHER/' + reconciled: false + amount: -126.12 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441855' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'POMANDA.COM - 138 HOLBORN, - Card Ending: 2327//OTHER/' + reconciled: false + amount: -9.99 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441856' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'RYANAIR 224BEZ3YM - LONDON - Card Ending: 4999//OTHER/' + reconciled: false + amount: -267.97 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441857' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'TESCO STORES 5956 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -9.35 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441859' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'SPOTIFY - LONDON - Card Ending: 4999//OTHER/' + reconciled: false + amount: -16.99 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441860' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'Revive My Device - London - Card Ending: 5913//OTHER/' + reconciled: false + amount: -149 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441861' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'DELIVEROO - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -39.36 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441862' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'UPS LTD - FELTHAM - Card Ending: 2327//OTHER/' + reconciled: false + amount: -2.4 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441863' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'Amazon.co.uk*1N0N04VK4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -17.76 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441864' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'TESCO STORES 5956 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -10.65 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441865' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'GATHER & GATHER 3401 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -16.75 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441866' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'GATHER & GATHER 3401 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -4.55 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441867' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'TRAVELODGE GB0937 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -10.75 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441868' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'DELIVEROO - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -34.2 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441869' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/' + reconciled: false + amount: -2.8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441870' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'SIDS DIY - LONDON E1 - Card Ending: 9271//OTHER/' + reconciled: false + amount: -5.99 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441871' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'RESOLUTION GB LTD - WHITCHURCH - Card Ending: 2327//OTHER/' + reconciled: false + amount: -368.72 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441872' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'GATHER & GATHER 3401 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -6.15 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441874' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'HERMES PARCELNET LTD T/A - 08445437147 - Card Ending: 2327//OTHER/' + reconciled: false + amount: -5.34 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441875' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'Refund: SCREWFIX DIR LTD - WHITECHAP1983 - Card Ending: 9271//OTHER/' + reconciled: false + amount: 6.8 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441876' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'Refund: SCREWFIX DIR LTD - WHITECHAP1983 - Card Ending: 9271//OTHER/' + reconciled: false + amount: 12.49 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441877' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'SCREWFIX DIR LTD - WHITECHAP1983 - Card Ending: 9271//OTHER/' + reconciled: false + amount: -6.5 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441878' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'SCREWFIX DIR LTD - WHITECHAP1983 - Card Ending: 9271//OTHER/' + reconciled: false + amount: -27.15 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441879' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'GOODMANS FIELD - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441880' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'GOODMANS FIELD - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -25.7 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441881' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'CREAMLINE DAIRIES ONLINE - MANCHESTER - Card Ending: 2327//OTHER/' + reconciled: false + amount: -50 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441883' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'AIRBNB * HMYDEXRY4N - 203-318-1111 - Card Ending: 5913//OTHER/' + reconciled: false + amount: -388.24 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441884' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'UPS LTD - FELTHAM - Card Ending: 2327//OTHER/' + reconciled: false + amount: -9.35 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441886' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 9271//OTHER/' + reconciled: false + amount: -11.9 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441889' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 9271//OTHER/' + reconciled: false + amount: -6.84 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441891' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'WELCOME BREAK - NEWPORT PAGNE - Card Ending: 9271//OTHER/' + reconciled: false + amount: -102.23 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441892' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'SUBWAY 63582 London Gatew - Mill Hill, Lo - Card Ending: 9271//OTHER/' + reconciled: false + amount: -15.38 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441893' + accountId: '738783' + clearedOnDate: '2022-12-26T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -40.65 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441894' + accountId: '738783' + clearedOnDate: '2022-12-26T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -2 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441895' + accountId: '738783' + clearedOnDate: '2022-12-26T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -34.06 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441897' + accountId: '738783' + clearedOnDate: '2022-12-26T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -2 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441901' + accountId: '738783' + clearedOnDate: '2022-12-28T00:00:00' + description: 'Tesla - West Drayton - Card Ending: 1332//OTHER/' + reconciled: false + amount: -9.99 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441904' + accountId: '738783' + clearedOnDate: '2022-12-28T00:00:00' + description: 'Box Deansgate - Manchester - Card Ending: 0614//OTHER/' + reconciled: false + amount: -20.65 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441906' + accountId: '738783' + clearedOnDate: '2022-12-28T00:00:00' + description: 'MANCHESTER UNITED KIOSK - MANCHESTER - Card Ending: 0614//OTHER/' + reconciled: false + amount: -26.5 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441908' + accountId: '738783' + clearedOnDate: '2022-12-29T00:00:00' + description: 'TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/' + reconciled: false + amount: -2.8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441909' + accountId: '738783' + clearedOnDate: '2022-12-31T00:00:00' + description: 'TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/' + reconciled: false + amount: -1.65 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441910' + accountId: '738783' + clearedOnDate: '2023-01-01T00:00:00' + description: 'UBER* TRIP - LONDON - Card Ending: 1332//OTHER/' + reconciled: false + amount: -2 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441911' + accountId: '738783' + clearedOnDate: '2023-01-01T00:00:00' + description: 'UBER* TRIP - LONDON - Card Ending: 1332//OTHER/' + reconciled: false + amount: -11.95 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441912' + accountId: '738783' + clearedOnDate: '2023-01-02T00:00:00' + description: 'UBER* TRIP - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -13.68 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441913' + accountId: '738783' + clearedOnDate: '2023-01-02T00:00:00' + description: 'WWW.KASHFLOW.COM - DATCHET - Card Ending: 1332//OTHER/' + reconciled: false + amount: -22.8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441914' + accountId: '738783' + clearedOnDate: '2023-01-02T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -9.14 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441915' + accountId: '738783' + clearedOnDate: '2023-01-02T00:00:00' + description: 'GOOGLE*GSUITE ISOMI.CO - DUBLIN 2 - Card Ending: 1332//OTHER/' + reconciled: false + amount: -216.2 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441916' + accountId: '738783' + clearedOnDate: '2023-01-03T00:00:00' + description: 'Refund: AMZ*quickpickdeals - amazon.co.uk - Card Ending: 4999//OTHER/' + reconciled: false + amount: 10.97 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441917' + accountId: '738783' + clearedOnDate: '2023-01-04T00:00:00' + description: Finance Charge//OTHER/ + reconciled: false + amount: -0.41 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441918' + accountId: '738783' + clearedOnDate: '2023-01-04T00:00:00' + description: 'WWW.KASHFLOW.COM - DATCHET - Card Ending: 1332//OTHER/' + reconciled: false + amount: -22.8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441919' + accountId: '738783' + clearedOnDate: '2023-01-04T00:00:00' + description: 'ACCU.CO.UK - HUDDERSFIELD - Card Ending: 2327//OTHER/' + reconciled: false + amount: -86.34 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441920' + accountId: '738783' + clearedOnDate: '2023-01-04T00:00:00' + description: 'ASDA GROCERIES ONLINE - INTERNET - Card Ending: 2327//OTHER/' + reconciled: false + amount: -6.5 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441922' + accountId: '738783' + clearedOnDate: '2023-01-04T00:00:00' + description: 'AMAZON PRIME*164AU3UZ4 AM - AMZN.CO.UK/PM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -96 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441924' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*162DC7II4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -44.62 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441926' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'trainline - +443332022222 - Card Ending: 5913//OTHER/' + reconciled: false + amount: -65.46 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441931' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'VITAL PARTS LTD - MAIDSTONE - Card Ending: 2327//OTHER/' + reconciled: false + amount: -124.35 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441934' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*168E49IU4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -2.52 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441935' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'ASDA GROCERIES ONLINE - INTERNET - Card Ending: 2327//OTHER/' + reconciled: false + amount: -108.16 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441936' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Refund: ASDA GROCERIES ONLINE - INTERNET - Card Ending: 2327//OTHER/' + reconciled: false + amount: 22.96 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441937' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*1H31B0CO4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -20.52 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441939' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*1H4GR4CH4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -13.69 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441941' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*162V47WY4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -16.83 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441945' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*160J00WI4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -17.68 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441946' + accountId: '738783' + clearedOnDate: '2023-01-06T00:00:00' + description: 'Amazon.co.uk*1692Y9YY4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -29.74 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441947' + accountId: '738783' + clearedOnDate: '2023-01-06T00:00:00' + description: 'Amazon.co.uk*166I62Y14 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -29.74 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441948' + accountId: '738783' + clearedOnDate: '2023-01-06T00:00:00' + description: 'GMELIUS GROWTH - MEYRIN - Card Ending: 5913//OTHER/' + reconciled: false + amount: -121.3 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441949' + accountId: '738783' + clearedOnDate: '2023-01-07T00:00:00' + description: 'ACCU.CO.UK - HUDDERSFIELD - Card Ending: 2327//OTHER/' + reconciled: false + amount: -116.34 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441950' + accountId: '738783' + clearedOnDate: '2023-01-07T00:00:00' + description: 'AMZNMktplace - amazon.co.uk - Card Ending: 2327//OTHER/' + reconciled: false + amount: -66.79 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441951' + accountId: '738783' + clearedOnDate: '2023-01-07T00:00:00' + description: 'TOOLSTATION UK - NORTHAMPTON - Card Ending: 2327//OTHER/' + reconciled: false + amount: -77.88 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441952' + accountId: '738783' + clearedOnDate: '2023-01-07T00:00:00' + description: 'SHELL CHESTER - CHESTER - Card Ending: 9271//OTHER/' + reconciled: false + amount: -112.24 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441953' + accountId: '738783' + clearedOnDate: '2023-01-08T00:00:00' + description: 'BRITISH A 1252150515112 - LONDON - Card Ending: 4999//OTHER/' + reconciled: false + amount: -450.85 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441954' + accountId: '738783' + clearedOnDate: '2023-01-08T00:00:00' + description: 'BRITISH A 1254217966962 - LONDON - Card Ending: 4999//OTHER/' + reconciled: false + amount: -65 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441955' + accountId: '738783' + clearedOnDate: '2023-01-08T00:00:00' + description: 'TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/' + reconciled: false + amount: -3.3 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441956' + accountId: '738783' + clearedOnDate: '2023-01-09T00:00:00' + description: 'Amazon.co.uk*1H97Y6TL4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -17.45 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441957' + accountId: '738783' + clearedOnDate: '2023-01-09T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -15.03 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441959' + accountId: '738783' + clearedOnDate: '2023-01-09T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -16.43 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441960' + accountId: '738783' + clearedOnDate: '2023-01-09T00:00:00' + description: Payment made (BACS)//OTHER/ + reconciled: false + amount: 5000 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441961' + accountId: '738783' + clearedOnDate: '2023-01-10T00:00:00' + description: 'AMZNMktplace - amazon.co.uk - Card Ending: 2327//OTHER/' + reconciled: false + amount: -32.57 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:38Z' + - id: '414441962' + accountId: '738783' + clearedOnDate: '2023-01-10T00:00:00' + description: 'TESCO STORES - LONDON - Card Ending: 5913//OTHER/' + reconciled: false + amount: -3.9 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:38Z' + - id: '414441963' + accountId: '738783' + clearedOnDate: '2023-01-10T00:00:00' + description: 'VICTORIA INN - PECKHAM - Card Ending: 5913//OTHER/' + reconciled: false + amount: -15.5 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:38Z' + - id: '414441965' + accountId: '738783' + clearedOnDate: '2023-01-10T00:00:00' + description: 'TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/' + reconciled: false + amount: -7.7 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:38Z' + - id: '414441967' + accountId: '738783' + clearedOnDate: '2023-01-10T00:00:00' + description: 'PRET A MANGER - 326 - Card Ending: 5913//OTHER/' + reconciled: false + amount: -13.8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:38Z' + pageNumber: 1 + pageSize: 100 + totalResults: 153 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts/738783/bankTransactions + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts/738783/bankTransactions + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts/738783/bankTransactions?page=2&pageSize=100 + KashFlow: + value: + results: + - id: '765768:137014109' + accountId: '765768' + clearedOnDate: '2020-04-28T00:00:00' + description: FIRST Transaction + reconciled: false + amount: 100 + transactionType: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + - id: '765768:137014143' + accountId: '765768' + clearedOnDate: '2020-04-28T00:00:00' + description: SECOND Transaction + reconciled: false + amount: 120 + transactionType: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + - id: '765768:93269803' + accountId: '765768' + clearedOnDate: '2020-04-28T00:00:00' + description: 'KF00021:' + reconciled: false + amount: -5 + transactionType: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + - id: '765768:141203309' + accountId: '765768' + clearedOnDate: '2020-06-18T00:00:00' + description: 'INV #33: Customer overpayment' + reconciled: false + amount: 110 + transactionType: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + - id: '765768:144653342' + accountId: '765768' + clearedOnDate: '2020-10-23T00:00:00' + description: '' + reconciled: false + amount: 1 + transactionType: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + pageNumber: 1 + pageSize: 100 + totalResults: 5 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts/765768/bankTransactions + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts/765768/bankTransactions + QuickBooks Desktop: + value: + results: + - id: D7B-933784104 + accountId: 20000-933270541 + clearedOnDate: '2022-12-01T00:00:00' + description: '' + reconciled: false + amount: -1200 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:10' + - id: DFA-933785132 + accountId: 20000-933270541 + clearedOnDate: '2022-12-05T00:00:00' + description: '' + reconciled: false + amount: -35 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:11' + - id: E2E-933785785 + accountId: 20000-933270541 + clearedOnDate: '2022-12-10T00:00:00' + description: '' + reconciled: false + amount: -197.59 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:11' + - id: 536B-1197755199 + accountId: 20000-933270541 + clearedOnDate: '2022-12-20T00:00:00' + description: '' + reconciled: false + amount: -2100 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:47' + - id: 5C18-1197711471-to + accountId: 20000-933270541 + clearedOnDate: '2022-12-31T00:00:00' + description: Opening Balance - Bank Balance - Checking Account + reconciled: false + amount: 27874.62 + transactionType: Other + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:06' + - id: 3A09-1071529982 + accountId: 20000-933270541 + clearedOnDate: '2023-01-11T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:58' + - id: 95C6-1197729008 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: 941 Deposit for December 2005 Payyroll + reconciled: false + amount: -3495.82 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:19' + - id: 95CA-1197729081 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: FUTA Payment - 4 Qrt 2005 + reconciled: false + amount: -100 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:19' + - id: 95D0-1197729222 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: State Unemployment and Disability - 4th Quarter 2005 + reconciled: false + amount: -208.09 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:19' + - id: 95D4-1197729376 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: Worker's Compensation - 4th Quarter 2005 + reconciled: false + amount: -1214.31 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:19' + - id: 9C06-1181931827 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: Deposit + reconciled: false + amount: 1228.18 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:23' + - id: 9E3A-1182063799 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: '' + reconciled: false + amount: -308.34 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: A293-1197953458 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: '' + reconciled: false + amount: -12362.89 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2AB-1197953786 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: '' + reconciled: false + amount: -9521 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A33E-1197955762 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: ABCD 11-234567 + reconciled: false + amount: -3146.88 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 6992-1197775718 + accountId: 20000-933270541 + clearedOnDate: '2023-01-17T00:00:00' + description: Deposit + reconciled: false + amount: 15281.67 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:11' + - id: 3E5D-1071498699 + accountId: 20000-933270541 + clearedOnDate: '2023-01-21T00:00:00' + description: 786-35 + reconciled: false + amount: -712.56 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:09' + - id: 699D-1197775731 + accountId: 20000-933270541 + clearedOnDate: '2023-01-25T00:00:00' + description: Deposit + reconciled: false + amount: 31474.25 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:11' + - id: 53D-933354764 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:00' + - id: 9E3D-1182131998 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: '' + reconciled: false + amount: -205 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9E42-1182131999 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: '' + reconciled: false + amount: -532 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9E47-1182131999 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: '' + reconciled: false + amount: -623 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9E4C-1182131999 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: '' + reconciled: false + amount: -13759 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9ED6-1182133365 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: Fuel + reconciled: false + amount: -138 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F2D-1197948760 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: Monthly Vehicle Repairs and Maintenance + reconciled: false + amount: -218 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F96-1197949640 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -123.67 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: A2CD-1197955250 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: Pmt# 1 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: F29-933787474 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:13' + - id: 698D-1197775698 + accountId: 20000-933270541 + clearedOnDate: '2023-02-02T00:00:00' + description: Deposit + reconciled: false + amount: 1040 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:11' + - id: 69A8-1197775740 + accountId: 20000-933270541 + clearedOnDate: '2023-02-09T00:00:00' + description: Deposit + reconciled: false + amount: 271.53 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:11' + - id: 3A10-1071529997 + accountId: 20000-933270541 + clearedOnDate: '2023-02-11T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:58' + - id: A0BD-1197950967 + accountId: 20000-933270541 + clearedOnDate: '2023-02-15T00:00:00' + description: '' + reconciled: false + amount: -268.39 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2AF-1197953842 + accountId: 20000-933270541 + clearedOnDate: '2023-02-15T00:00:00' + description: '' + reconciled: false + amount: -4050.98 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A343-1197955826 + accountId: 20000-933270541 + clearedOnDate: '2023-02-15T00:00:00' + description: ABCD 11-234567 + reconciled: false + amount: -1466.32 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 9C0B-1181931843 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Deposit + reconciled: false + amount: 25471.56 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:23' + - id: 9E63-1182132109 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: For Vetter Basement Remodel + reconciled: false + amount: -2050 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9ED9-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Fuel + reconciled: false + amount: -142 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F33-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -222 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F99-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -125.89 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FBD-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A052-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A081-1197950831 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2D1-1197955271 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Pmt# 2 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 3A17-1071530007 + accountId: 20000-933270541 + clearedOnDate: '2023-03-11T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:58' + - id: 9C38-1182054225 + accountId: 20000-933270541 + clearedOnDate: '2023-03-13T00:00:00' + description: '' + reconciled: false + amount: -7500 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:24' + - id: A296-1197953484 + accountId: 20000-933270541 + clearedOnDate: '2023-03-15T00:00:00' + description: '' + reconciled: false + amount: -1600 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A346-1197955854 + accountId: 20000-933270541 + clearedOnDate: '2023-03-15T00:00:00' + description: ABCD 11-234567 + reconciled: false + amount: -83.6 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 9C10-1181931855 + accountId: 20000-933270541 + clearedOnDate: '2023-03-20T00:00:00' + description: Deposit + reconciled: false + amount: 6278.8 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:23' + - id: 9E72-1182132247 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: '' + reconciled: false + amount: -435 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9EDC-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Fuel + reconciled: false + amount: -127 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F36-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -232 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F7B-1197949443 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Payment - Quarterly Office Maintenance Contract + reconciled: false + amount: -450 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F9C-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -389.2 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FC0-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A056-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A084-1197950832 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2D5-1197955280 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Pmt# 3 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 3A1E-1071530019 + accountId: 20000-933270541 + clearedOnDate: '2023-04-12T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:58' + - id: 4271-1071523732 + accountId: 20000-933270541 + clearedOnDate: '2023-04-17T00:00:00' + description: '' + reconciled: false + amount: -714 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:32' + - id: 3E98-1071499056 + accountId: 20000-933270541 + clearedOnDate: '2023-04-19T00:00:00' + description: 786-35 + reconciled: false + amount: -712.56 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:11' + - id: 9C68-1182054440 + accountId: 20000-933270541 + clearedOnDate: '2023-04-20T00:00:00' + description: Deposit + reconciled: false + amount: 16500 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:24' + - id: 9EDF-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Fuel + reconciled: false + amount: -162 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F39-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -192 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F9F-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -120.93 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FC3-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A05A-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A087-1197950832 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2D9-1197955286 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Pmt# 4 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 9C86-1182054823 + accountId: 20000-933270541 + clearedOnDate: '2023-05-01T00:00:00' + description: '' + reconciled: false + amount: -7500 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:24' + - id: 3A25-1071530029 + accountId: 20000-933270541 + clearedOnDate: '2023-05-13T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:59' + - id: A0C0-1197950991 + accountId: 20000-933270541 + clearedOnDate: '2023-05-15T00:00:00' + description: '' + reconciled: false + amount: -950.23 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A299-1197953515 + accountId: 20000-933270541 + clearedOnDate: '2023-05-15T00:00:00' + description: '' + reconciled: false + amount: -1400 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A349-1197955899 + accountId: 20000-933270541 + clearedOnDate: '2023-05-15T00:00:00' + description: ABCD 11-234567 + reconciled: false + amount: -318.02 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 9CB8-1182055085 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Deposit + reconciled: false + amount: 16500 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:25' + - id: 9EE2-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Fuel + reconciled: false + amount: -143 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F3C-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -232 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FA2-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -128.03 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FC6-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A05E-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A08A-1197950832 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2DD-1197955294 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Pmt# 5 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 9CBD-1182055262 + accountId: 20000-933270541 + clearedOnDate: '2023-06-06T00:00:00' + description: '' + reconciled: false + amount: -5275 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:25' + - id: 3A2C-1071530042 + accountId: 20000-933270541 + clearedOnDate: '2023-06-10T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:59' + - id: 5356-1197761596 + accountId: 20000-933270541 + clearedOnDate: '2023-06-16T00:00:00' + description: '' + reconciled: false + amount: -1786 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:46' + - id: 9EE5-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Fuel + reconciled: false + amount: -157 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F3F-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -186 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F7E-1197949458 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Payment - Quarterly Office Maintenance Contract + reconciled: false + amount: -450 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FA5-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -135.02 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FC9-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A062-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A08D-1197950832 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2E1-1197955306 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Pmt# 6 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 3A33-1071530066 + accountId: 20000-933270541 + clearedOnDate: '2023-07-11T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:59' + - id: 3E67-1071498733 + accountId: 20000-933270541 + clearedOnDate: '2023-07-19T00:00:00' + description: 786-35 + reconciled: false + amount: -712.56 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:09' + - id: A0C3-1197951027 + accountId: 20000-933270541 + clearedOnDate: '2023-07-23T00:00:00' + description: '' + reconciled: false + amount: -239.29 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: 9EE8-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-07-31T00:00:00' + description: Fuel + reconciled: false + amount: -126 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F42-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-07-31T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -126 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FA8-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-07-31T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -128.03 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FCC-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-07-31T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A066-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-07-31T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + pageNumber: 1 + pageSize: 100 + totalResults: 495 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts/20000-933270541/bankTransactions + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts/20000-933270541/bankTransactions + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts/20000-933270541/bankTransactions?page=2&pageSize=100 + Sage 50 (UK): + value: + results: + - id: '73' + accountId: '1200' + clearedOnDate: '2021-01-29T00:00:00' + description: DD/STO + reconciled: false + amount: -162 + balance: -10164.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '52' + accountId: '1200' + clearedOnDate: '2021-01-30T00:00:00' + description: '568953' + reconciled: false + amount: -1497.58 + balance: -10302.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '53' + accountId: '1200' + clearedOnDate: '2021-01-30T00:00:00' + description: '5897532' + reconciled: false + amount: 500 + balance: -9802.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '54' + accountId: '1200' + clearedOnDate: '2021-01-30T00:00:00' + description: TRANS + reconciled: false + amount: -250 + balance: -10052.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '58' + accountId: '1200' + clearedOnDate: '2021-01-30T00:00:00' + description: VOID + reconciled: false + amount: 50 + balance: -10002.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '50' + accountId: '1200' + clearedOnDate: '2021-01-31T00:00:00' + description: TRANS + reconciled: false + amount: -500 + balance: -8804.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '85' + accountId: '1200' + clearedOnDate: '2021-01-31T00:00:00' + description: '6565689' + reconciled: false + amount: -1800 + balance: -11964.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '97' + accountId: '1200' + clearedOnDate: '2021-01-31T00:00:00' + description: Salary + reconciled: false + amount: -5932.29 + balance: -17896.83 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1183' + accountId: '1200' + clearedOnDate: '2021-09-01T00:00:00' + description: DD/STO + reconciled: false + amount: -162 + balance: 11299.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1184' + accountId: '1200' + clearedOnDate: '2021-09-15T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 10099.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1185' + accountId: '1200' + clearedOnDate: '2021-09-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 9949.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1186' + accountId: '1200' + clearedOnDate: '2021-09-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 9944.36 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1187' + accountId: '1200' + clearedOnDate: '2021-10-13T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 8744.36 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1188' + accountId: '1200' + clearedOnDate: '2021-10-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 8594.36 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1189' + accountId: '1200' + clearedOnDate: '2021-10-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 8588.81 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1190' + accountId: '1200' + clearedOnDate: '2021-11-10T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 7388.81 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1191' + accountId: '1200' + clearedOnDate: '2021-11-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 7238.81 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1192' + accountId: '1200' + clearedOnDate: '2021-11-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 7233.26 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1193' + accountId: '1200' + clearedOnDate: '2021-12-08T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 6033.26 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1194' + accountId: '1200' + clearedOnDate: '2021-12-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 5883.26 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1195' + accountId: '1200' + clearedOnDate: '2021-12-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 5877.71 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '24' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: O/Bal + reconciled: true + amount: -6511.96 + balance: -6511.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '26' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '56956' + reconciled: false + amount: 55 + balance: -6456.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '27' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '656678' + reconciled: false + amount: -150 + balance: -6606.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '28' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '656679' + reconciled: false + amount: -352 + balance: -6958.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '29' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '656680' + reconciled: false + amount: -550 + balance: -7508.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '30' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '656681' + reconciled: false + amount: -250 + balance: -7758.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '31' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '656869' + reconciled: false + amount: -546 + balance: -8304.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1196' + accountId: '1200' + clearedOnDate: '2022-01-01T00:00:00' + description: DD/STO + reconciled: false + amount: -162 + balance: 5715.71 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1197' + accountId: '1200' + clearedOnDate: '2022-01-05T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 4515.71 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1198' + accountId: '1200' + clearedOnDate: '2022-01-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 4365.71 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1199' + accountId: '1200' + clearedOnDate: '2022-01-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 4360.16 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '255' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: (BACS) + reconciled: false + amount: -370.71 + balance: -18267.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '256' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100001' + reconciled: false + amount: -256.36 + balance: -18523.9 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '257' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100002' + reconciled: false + amount: -25.5 + balance: -18549.4 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '258' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100003' + reconciled: false + amount: -1977.58 + balance: -20526.98 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '259' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100004' + reconciled: false + amount: -599.03 + balance: -21126.01 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '260' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100005' + reconciled: false + amount: -7141.98 + balance: -28267.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '261' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100006' + reconciled: false + amount: -150.96 + balance: -28418.95 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '262' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100007' + reconciled: false + amount: -63 + balance: -28481.95 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '263' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100008' + reconciled: false + amount: -35.01 + balance: -28516.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '264' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100009' + reconciled: false + amount: -1659.34 + balance: -30176.3 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '265' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '4353454' + reconciled: false + amount: 1432.17 + balance: -28744.13 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '266' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 2684.26 + balance: -26059.87 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '267' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 1204.57 + balance: -24855.3 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '268' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 1140.78 + balance: -23714.52 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '269' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 4372 + balance: -19342.52 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '270' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 1946.18 + balance: -17396.34 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '271' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 11123.33 + balance: -6273.01 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1200' + accountId: '1200' + clearedOnDate: '2022-02-02T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 3160.16 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '300' + accountId: '1200' + clearedOnDate: '2022-02-03T00:00:00' + description: TRANS + reconciled: false + amount: -500 + balance: -16588.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1201' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 3010.16 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1202' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 3004.61 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '276' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Credit + reconciled: false + amount: -500 + balance: -6773.01 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '279' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: '' + reconciled: false + amount: -58.75 + balance: -6831.76 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '280' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: TRANS + reconciled: false + amount: -1400 + balance: -8231.76 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '282' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: TRANS + reconciled: false + amount: -12600 + balance: -20831.76 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '286' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: TRANS + reconciled: false + amount: 6500 + balance: -14331.76 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '287' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: PAYE + reconciled: false + amount: -1256.33 + balance: -15588.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '288' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Deposit + reconciled: false + amount: -500 + balance: -16088.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '314' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: DD/STO + reconciled: false + amount: -162 + balance: -16750.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '315' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: -17950.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '325' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Loan + reconciled: false + amount: -150 + balance: -18100.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '326' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Loan + reconciled: false + amount: -5.55 + balance: -18105.64 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '328' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Returned + reconciled: false + amount: 103.4 + balance: -18002.24 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '331' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Salary + reconciled: false + amount: -5932.29 + balance: -23934.53 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '523' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: '' + reconciled: false + amount: 6556.33 + balance: -17378.2 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '525' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: '' + reconciled: false + amount: 3350.33 + balance: -14027.87 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '526' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: (BACS) + reconciled: false + amount: -435.14 + balance: -14463.01 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '529' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: '12324' + reconciled: false + amount: -8561.48 + balance: -23024.49 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '532' + accountId: '1200' + clearedOnDate: '2022-03-01T00:00:00' + description: VOID + reconciled: false + amount: 352.5 + balance: -22671.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '534' + accountId: '1200' + clearedOnDate: '2022-03-01T00:00:00' + description: SED + reconciled: false + amount: 55 + balance: -22616.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1203' + accountId: '1200' + clearedOnDate: '2022-03-02T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 1804.61 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '821' + accountId: '1200' + clearedOnDate: '2022-03-10T00:00:00' + description: '' + reconciled: false + amount: 1908.89 + balance: -14370.08 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '820' + accountId: '1200' + clearedOnDate: '2022-03-20T00:00:00' + description: '776' + reconciled: false + amount: 9057.34 + balance: -16278.97 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '606' + accountId: '1200' + clearedOnDate: '2022-03-24T00:00:00' + description: Deposit + reconciled: false + amount: -150 + balance: -22370.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '607' + accountId: '1200' + clearedOnDate: '2022-03-25T00:00:00' + description: '44555' + reconciled: false + amount: 100 + balance: -22270.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '823' + accountId: '1200' + clearedOnDate: '2022-03-25T00:00:00' + description: '' + reconciled: false + amount: 1770.15 + balance: -12229.5 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '578' + accountId: '1200' + clearedOnDate: '2022-03-27T00:00:00' + description: '456' + reconciled: false + amount: -15 + balance: -22084.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '608' + accountId: '1200' + clearedOnDate: '2022-03-27T00:00:00' + description: CREDIT + reconciled: false + amount: -100 + balance: -22370.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '824' + accountId: '1200' + clearedOnDate: '2022-03-27T00:00:00' + description: '' + reconciled: false + amount: 1025.86 + balance: -11203.64 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1204' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 1654.61 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1205' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 1649.06 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '546' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -162 + balance: -22778.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '547' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: -23978.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '548' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: -24128.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '549' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: -24134.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '555' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: VOID + reconciled: false + amount: 50 + balance: -24084.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '560' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: REFUND + reconciled: false + amount: 64.63 + balance: -24019.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '562' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: TRANS + reconciled: false + amount: 2000 + balance: -22019.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '563' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: TRANS + reconciled: false + amount: -50 + balance: -22069.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '584' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: CREDIT + reconciled: false + amount: -70.31 + balance: -22155.22 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '589' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: VOID + reconciled: false + amount: 30 + balance: -22125.22 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '596' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: REFUND + reconciled: false + amount: 35.01 + balance: -22090.21 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '597' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: PAYE + reconciled: false + amount: -2070.23 + balance: -24160.44 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '598' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: NI + reconciled: false + amount: -1003.49 + balance: -25163.93 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '604' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: TRANS + reconciled: false + amount: 3000 + balance: -22163.93 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '605' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: '225' + reconciled: false + amount: -56.16 + balance: -22220.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '612' + accountId: '1200' + clearedOnDate: '2022-03-29T00:00:00' + description: NI + reconciled: false + amount: -1003.49 + balance: -29305.87 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '614' + accountId: '1200' + clearedOnDate: '2022-03-29T00:00:00' + description: Sales + reconciled: false + amount: 179.2 + balance: -29126.67 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + pageNumber: 1 + pageSize: 100 + totalResults: 179 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts/1200/bankTransactions + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts/1200/bankTransactions + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts/1200/bankTransactions?page=2&pageSize=100 + Sage Business Cloud Accounting: + value: + results: + - id: 26b727ca84734e3c8e245011bd04dbf1 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-02-05T00:00:00' + description: string Supplier Payment + reconciled: false + amount: -5 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-02-07T11:35:39Z' + - id: 508f3fd4403e45cb903b362a4ae55344 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-02-05T00:00:00' + description: string Supplier Payment + reconciled: false + amount: -3.86 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-02-10T10:51:43Z' + - id: 52e58431005e44328af44116e0433230 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-02-05T00:00:00' + description: string Supplier Payment + reconciled: false + amount: -3.85 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-02-07T14:36:01Z' + - id: f3255e4b79c5427ba5b963d0e26cecfc + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-02-05T00:00:00' + description: string Supplier Payment + reconciled: false + amount: -3.86 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-02-07T14:19:24Z' + - id: a00e1ce357cc4064b9cce8abe1b15110 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-04-21T00:00:00' + description: Cash Deposit Bank Transfer + reconciled: false + amount: 1000 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-04-21T21:03:25Z' + - id: a7d26740129945c3a76209020fbb7fd1 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-11-25T00:00:00' + description: Bank Transfer + reconciled: false + amount: -40 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-11-25T19:35:03Z' + - id: 829f45112347471cbf99b0d9afe08113 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-07-02T00:00:00' + description: Made from codat api Customer Receipt + reconciled: false + amount: 10 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-07-02T13:14:57Z' + - id: 786f769ae88a4fa898e25e2cbff43be3 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-07-20T00:00:00' + description: Supplier payment AD Supplier Payment + reconciled: false + amount: -2400 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-07-22T14:12:38Z' + - id: abb5995867c546c2b32097d515dcef2a + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-07-21T00:00:00' + description: Payment Customer Receipt + reconciled: false + amount: 12 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-07-21T14:09:59Z' + - id: 943f3bd6eacc4071807d89895fe03ef4 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-08-17T00:00:00' + description: Ref5565 Other Receipt + reconciled: false + amount: 50 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-08-17T11:58:37Z' + - id: 039e6bb20b6e44d690601e4dd04a5b21 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-09-22T00:00:00' + description: Note 1 Customer Receipt + reconciled: false + amount: 1080 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-09-22T14:22:57Z' + - id: 1a62f54358e74ba4a71dd733f2b08ba4 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-09-27T00:00:00' + description: Note 2 Customer Receipt + reconciled: false + amount: 1080 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-09-27T14:04:05Z' + - id: a79ebcf0710d415baad6b588eb28307b + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-12-01T00:00:00' + description: Payment Customer Receipt + reconciled: false + amount: 33 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-12-01T13:03:00Z' + - id: 4b691b78b6cd43c9a64d75aeb29e4d11 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-07-19T00:00:00' + description: Bank Transfer + reconciled: false + amount: -10 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2022-07-19T08:51:52Z' + - id: 7b1f2f55f39042838d5f7226aa92386f + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-07-19T00:00:00' + description: Bank Transfer + reconciled: false + amount: -1415 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2022-07-19T13:15:26Z' + - id: 87eca750292b4cfea216e13bb22923c6 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-07-19T00:00:00' + description: Bank Transfer + reconciled: false + amount: -10 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2022-07-19T13:01:47Z' + - id: a48474f83d214637a700e76e24446086 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-07-19T00:00:00' + description: Bank Transfer + reconciled: false + amount: -10 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2022-07-19T13:10:42Z' + - id: cc1fc960e05c40c1968314efe1175b9f + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-09-14T00:00:00' + description: string Customer Receipt + reconciled: false + amount: 69 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:15Z' + sourceModifiedDate: '2022-09-14T16:20:09Z' + - id: e600eb7549b74d96bdca18b9cc60f39d + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-09-14T00:00:00' + description: Customer Receipt + reconciled: false + amount: 60 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:15Z' + sourceModifiedDate: '2022-09-14T16:12:03Z' + pageNumber: 1 + pageSize: 100 + totalResults: 19 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts/154d05abe9f24c4babe0f6a741dec1b9/bankTransactions + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts/154d05abe9f24c4babe0f6a741dec1b9/bankTransactions + Xero: + value: + results: + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2021-12-20T00:00:00' + description: DD + counterparty: DIISR + reconciled: true + amount: -7267.2 + balance: -3136.22 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-02-17T00:00:00' + description: DD + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -5703.42 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-02-17T00:00:00' + description: INV0010 + counterparty: MADDOX PUBLISHING GP + reconciled: true + amount: 4200 + balance: -6203.42 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-02-17T00:00:00' + description: DD + counterparty: DIISR + reconciled: true + amount: -7267.2 + balance: -10403.42 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-02-19T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -95.5 + balance: -5798.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-03-19T00:00:00' + description: DD + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -5298.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-03-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -97 + balance: -5395.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-04-19T00:00:00' + description: INV-0003 + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -4895.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-04-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -92 + balance: -4987.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-05-21T00:00:00' + description: INV-0004 + counterparty: Ridgeway University + reconciled: true + amount: 1000 + balance: -3987.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-05-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -89 + balance: -4076.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-06-19T00:00:00' + description: INV-005 + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -3576.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-06-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -91 + balance: -3667.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-07-20T00:00:00' + description: INV-006 + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -3167.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-07-22T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -96.25 + balance: -3264.17 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-08-19T00:00:00' + description: INV-007 + counterparty: Ridgeway University + reconciled: true + amount: 1500 + balance: -1764.17 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-08-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -100.6 + balance: -1864.77 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-09-19T00:00:00' + description: INV-008 + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -1364.77 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-09-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -105.75 + balance: -1470.52 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-10-19T00:00:00' + description: INV-009 + counterparty: Ridgeway University + reconciled: true + amount: 1200 + balance: -270.52 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-10-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -106.5 + balance: -377.02 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-20T00:00:00' + description: INV-0010 + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: 122.98 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -119.08 + balance: 3.9 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-22T00:00:00' + description: Monthly a/c fee + counterparty: Ridgeway Banking Corporation + reconciled: true + amount: -15 + balance: -11.1 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: FP089876 + counterparty: FastPay + reconciled: true + amount: -3126.17 + balance: -1591.58 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: Subs DD + counterparty: Xero + reconciled: true + amount: -56.35 + balance: -89.16 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: '0015' + counterparty: Rex Media Group + reconciled: true + amount: 541.25 + balance: 1534.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: INV-0014 + counterparty: Port & Philip Freight + reconciled: true + amount: 541.25 + balance: 993.34 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: '' + counterparty: Office Supplies Company + reconciled: true + amount: -21.71 + balance: -32.81 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: INV-0013 + counterparty: Young Brothers + reconciled: true + amount: 541.25 + balance: 452.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-24T00:00:00' + description: INV0012 + counterparty: Hamilton Smith + reconciled: true + amount: 541.25 + balance: -1050.33 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-01T00:00:00' + description: '' + counterparty: Woolworths Oaktown + reconciled: true + amount: -65.2 + balance: -1115.53 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-02T00:00:00' + description: '' + counterparty: Berry Brew Cafe + reconciled: true + amount: -15.6 + balance: -1131.13 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-09T00:00:00' + description: AR-0019 + counterparty: Bank West + reconciled: true + amount: 1500 + balance: 368.87 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-11T00:00:00' + description: CHQ 6543-000409 + counterparty: Melrose Parking Services + reconciled: true + amount: -148.5 + balance: 220.37 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-16T00:00:00' + description: '' + counterparty: Espresso 31 Ltd + reconciled: true + amount: -16 + balance: 204.37 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-19T00:00:00' + description: '' + counterparty: Brunswick Flower Suppliers T/A Brunswick Petals + reconciled: true + amount: -50 + balance: 154.37 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-20T00:00:00' + description: AR-0011 + counterparty: Ridgeway University + reconciled: true + amount: 2500 + balance: 2583.57 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-20T00:00:00' + description: '' + counterparty: Mobil + reconciled: true + amount: -70.8 + balance: 83.57 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-23T00:00:00' + description: '' + counterparty: PC Complete + reconciled: true + amount: -1463.88 + balance: 1449.49 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-23T00:00:00' + description: AR-0018 + counterparty: City Agency + reconciled: true + amount: 329.8 + balance: 2913.37 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-23T00:00:00' + description: Bank Fee + counterparty: Ridgeway Banking Corporation + reconciled: true + amount: -15 + balance: 1434.49 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-23T00:00:00' + description: '' + counterparty: Truxton Property Management + reconciled: true + amount: -1181.25 + balance: 253.24 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-29T00:00:00' + description: FP101897 + counterparty: FastPay + reconciled: false + amount: -1223.91 + balance: -970.67 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-19T00:00:00' + description: '' + counterparty: Net Connect + reconciled: true + amount: -98.32 + balance: -1177.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-19T00:00:00' + description: '' + counterparty: Power Direct + reconciled: true + amount: -108.6 + balance: -1079.27 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-19T00:00:00' + description: AR-0020 + counterparty: Ridgeway University + reconciled: true + amount: 6187.5 + balance: 5009.91 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-20T00:00:00' + description: '' + counterparty: Truxton Property Management + reconciled: true + amount: -1181.25 + balance: 3828.66 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-20T00:00:00' + description: '' + counterparty: Swantston Security + reconciled: true + amount: -59.54 + balance: 3769.12 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-21T00:00:00' + description: '' + counterparty: Xero + reconciled: true + amount: -56.35 + balance: 3712.77 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-22T00:00:00' + description: INV0022 + counterparty: Petrie McLoud + reconciled: true + amount: 1407.25 + balance: 5120.02 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-23T00:00:00' + description: '0024' + counterparty: Boom FM + reconciled: true + amount: 1000 + balance: 6120.02 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-24T00:00:00' + description: CHQ 6543-000410 + counterparty: Melrose Parking + reconciled: true + amount: -148.5 + balance: 5971.52 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-25T00:00:00' + description: 0027-Part + counterparty: DIISR + reconciled: true + amount: 579.37 + balance: 6550.89 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-26T00:00:00' + description: Inv 0029 + counterparty: Hamilton Smith + reconciled: true + amount: 541.25 + balance: 7092.14 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-26T00:00:00' + description: INV0032 + counterparty: Rex Media Group + reconciled: true + amount: 541.25 + balance: 8715.89 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-26T00:00:00' + description: '0030' + counterparty: Young Brothers Transport + reconciled: true + amount: 541.25 + balance: 7633.39 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-26T00:00:00' + description: INV-0031 + counterparty: Port & Philip Freight Limited + reconciled: true + amount: 541.25 + balance: 8174.64 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-27T00:00:00' + description: Eft + counterparty: Woolworths Oaktown + reconciled: true + amount: -34.1 + balance: 8681.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-28T00:00:00' + description: 033-Full + counterparty: DIISR + reconciled: true + amount: 250 + balance: 8931.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-30T00:00:00' + description: Eft + counterparty: Office Supplies Company + reconciled: true + amount: -49.2 + balance: 8882.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-31T00:00:00' + description: '' + counterparty: Berry Brew + reconciled: true + amount: -22 + balance: 8860.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-01T00:00:00' + description: CHQ 6543-000411 + counterparty: 24 Locks + reconciled: true + amount: -69.5 + balance: 8791.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-02T00:00:00' + description: 08-4123 + counterparty: Hoyt Productions Ltd + reconciled: true + amount: -5953.75 + balance: 2837.34 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-03T00:00:00' + description: '' + counterparty: Carlton Functions + reconciled: true + amount: -1500 + balance: 1337.34 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-06T00:00:00' + description: Exps + counterparty: O.Greenville + reconciled: true + amount: -29.5 + balance: 1307.84 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-07T00:00:00' + description: Rent + counterparty: Truxton Property Management + reconciled: false + amount: -1181.25 + balance: 6314.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-07T00:00:00' + description: INV-0035 + counterparty: Ridgeway University + reconciled: false + amount: 6187.5 + balance: 7495.34 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-08T00:00:00' + description: 0017-Part + counterparty: City Limousines + reconciled: false + amount: 100 + balance: 1914.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-08T00:00:00' + description: DEPOSIT ADV + counterparty: Jakaranda Maple Systems + reconciled: false + amount: 2000 + balance: 3914.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-08T00:00:00' + description: 0195 0210 + counterparty: SMART Agency + reconciled: false + amount: -4500 + balance: 1814.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-09T00:00:00' + description: Eft + counterparty: Cooper Street Bakery + reconciled: false + amount: -15.75 + balance: 3898.34 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-10T00:00:00' + description: '' + counterparty: 7-Eleven + reconciled: false + amount: -15.5 + balance: 3882.84 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-11T00:00:00' + description: '' + counterparty: Swanston Security + reconciled: false + amount: -59.55 + balance: 3811.39 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-11T00:00:00' + description: '' + counterparty: Cooper Street Bakery + reconciled: false + amount: -11.9 + balance: 3870.94 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-12T00:00:00' + description: '' + counterparty: Whitcoulls + reconciled: false + amount: -29.8 + balance: 4769.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-12T00:00:00' + description: '' + counterparty: e-Bank Dep + reconciled: false + amount: 1000 + balance: 4811.39 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-12T00:00:00' + description: '' + counterparty: Central City Parking + reconciled: false + amount: -12 + balance: 4799.39 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-13T00:00:00' + description: '' + counterparty: Central City Parking + reconciled: false + amount: -12 + balance: 4757.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-13T00:00:00' + description: Sub 092201 + counterparty: Wilson Online Periodicals + reconciled: false + amount: -49.9 + balance: 4588.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-13T00:00:00' + description: Reg 8018922 + counterparty: ACL Conferences + reconciled: false + amount: -85 + balance: 4672.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-13T00:00:00' + description: '' + counterparty: New World + reconciled: false + amount: -34.6 + balance: 4637.99 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-14T00:00:00' + description: Sublet RM2031 + counterparty: Majestic Contracting + reconciled: false + amount: 450 + balance: 6526.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-14T00:00:00' + description: '' + counterparty: Central City Parking + reconciled: false + amount: -12 + balance: 4576.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-14T00:00:00' + description: '' + counterparty: e-Bank Dep + reconciled: false + amount: 1500 + balance: 6076.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-15T00:00:00' + description: '' + counterparty: Central City Parking + reconciled: false + amount: -12 + balance: 6499.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-15T00:00:00' + description: CR 092201 + counterparty: Wilson Online Periodicals + reconciled: false + amount: 35 + balance: 6534.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-15T00:00:00' + description: '' + counterparty: Parkside Kiosk + reconciled: false + amount: -14.3 + balance: 6511.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-16T00:00:00' + description: '' + counterparty: e-Bank Dep + reconciled: false + amount: 200 + balance: 6712.29 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-16T00:00:00' + description: '' + counterparty: Parkside Kiosk + reconciled: false + amount: -10.5 + balance: 6512.29 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-16T00:00:00' + description: Fee + counterparty: Ridgeway Banking Corporation + reconciled: false + amount: -15 + balance: 6697.29 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-16T00:00:00' + description: '' + counterparty: 7-Eleven + reconciled: false + amount: -15.5 + balance: 6681.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-16T00:00:00' + description: '' + counterparty: Central City Parking + reconciled: false + amount: -12 + balance: 6522.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + pageNumber: 1 + pageSize: 100 + totalResults: 93 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts/bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4/bankTransactions + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts/bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4/bankTransactions + Zoho Books: + value: + results: + - id: 104957000000060010-104957000000070175 + accountId: '104957000000060010' + clearedOnDate: '2020-02-06T00:00:00' + description: '' + reconciled: false + amount: 9001 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000060014 + accountId: '104957000000060010' + clearedOnDate: '2020-02-12T00:00:00' + description: '' + reconciled: false + amount: 10000 + transactionType: Dep + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000067014 + accountId: '104957000000060010' + clearedOnDate: '2020-02-14T00:00:00' + description: '' + reconciled: false + amount: 9001 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000070035 + accountId: '104957000000060010' + clearedOnDate: '2020-02-17T00:00:00' + description: '' + reconciled: false + amount: 11980 + transactionType: Debit + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000070055 + accountId: '104957000000060010' + clearedOnDate: '2020-02-17T00:00:00' + description: '' + reconciled: false + amount: -20 + transactionType: Payment + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000070097 + accountId: '104957000000060010' + clearedOnDate: '2020-02-17T00:00:00' + description: '' + reconciled: false + amount: 10789.21 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000097011 + accountId: '104957000000060010' + clearedOnDate: '2020-02-26T00:00:00' + description: '' + reconciled: false + amount: 10000 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000099013 + accountId: '104957000000060010' + clearedOnDate: '2020-02-27T00:00:00' + description: '' + reconciled: false + amount: -72 + transactionType: Payment + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000099053 + accountId: '104957000000060010' + clearedOnDate: '2020-02-27T00:00:00' + description: '' + reconciled: false + amount: 10 + transactionType: Debit + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000137017 + accountId: '104957000000060010' + clearedOnDate: '2020-05-19T00:00:00' + description: '' + reconciled: false + amount: 9000 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000336002 + accountId: '104957000000060010' + clearedOnDate: '2020-12-01T00:00:00' + description: '' + reconciled: false + amount: -20 + transactionType: Xfer + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000336020 + accountId: '104957000000060010' + clearedOnDate: '2020-12-01T00:00:00' + description: '' + reconciled: false + amount: 1.79 + transactionType: Xfer + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001706009 + accountId: '104957000000060010' + clearedOnDate: '2021-04-12T00:00:00' + description: '' + reconciled: false + amount: 200 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001469026 + accountId: '104957000000060010' + clearedOnDate: '2022-05-12T00:00:00' + description: '' + reconciled: false + amount: -50 + transactionType: Credit + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001480001 + accountId: '104957000000060010' + clearedOnDate: '2022-05-13T00:00:00' + description: '' + reconciled: false + amount: 18.98 + transactionType: Debit + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001480045 + accountId: '104957000000060010' + clearedOnDate: '2022-05-13T00:00:00' + description: '' + reconciled: false + amount: -20 + transactionType: Credit + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001633002 + accountId: '104957000000060010' + clearedOnDate: '2022-07-27T00:00:00' + description: '' + reconciled: false + amount: 26 + transactionType: Other + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001652007 + accountId: '104957000000060010' + clearedOnDate: '2022-08-08T00:00:00' + description: '' + reconciled: false + amount: 11.75 + transactionType: Other + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001689069 + accountId: '104957000000060010' + clearedOnDate: '2022-08-24T00:00:00' + description: '' + reconciled: false + amount: -2.89 + transactionType: Payment + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001689125 + accountId: '104957000000060010' + clearedOnDate: '2022-08-25T00:00:00' + description: '' + reconciled: false + amount: 3.6 + transactionType: Debit + modifiedDate: '2022-10-03T08:40:40Z' + pageNumber: 1 + pageSize: 100 + totalResults: 20 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts/104957000000060010/bankTransactions + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts/104957000000060010/bankTransactions + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/agedDebtor/available': + parameters: + - $ref: '#/components/parameters/companyId' + get: + x-internal: true + tags: + - Accounts receivable + summary: Aged debtors report available + description: Indicates whether the aged debtors report is available for the company. + operationId: is-aged-debtors-report-available + responses: + '200': + description: OK + content: + application/json: + schema: + type: boolean + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + x-speakeasy-name-override: is-aged-debtors-available + x-speakeasy-group: accounts-receivable.reports + '/companies/{companyId}/reports/agedDebtor': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingReportDate' + - $ref: '#/components/parameters/accountingNumberOfPeriods' + - $ref: '#/components/parameters/accountingPeriodLengthDays' + summary: Aged debtors report + description: Returns aged debtors report for company that shows the total outstanding balance due from customers to the business over time. + operationId: get-accounting-aged-debtors-report + x-speakeasy-name-override: get-aged-debtors + x-speakeasy-group: accounts-receivable.reports + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAgedDebtorReport' + examples: + Clear Books: + value: + generated: '2023-05-02T16:05:21.4959955Z' + reportDate: '2023-05-02T16:05:21.4459444Z' + data: + - customerId: c8180244-74ac-40cf-a5df-6d83661c44d7 + customerName: Arjun Kuvalis + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3367.71 + details: + - name: CreditNotes + amount: -3367.71 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 6d162ee4-47b4-46c6-a2e6-aa9edd0fe6b0 + customerName: 'Breitenberg, Emard and Schiller' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -4299.26 + details: + - name: Invoices + amount: 0 + - name: CreditNotes + amount: -4299.26 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 981d56a7-cf63-4ed2-b8db-2eba2c0aeb5a + customerName: Collins - Anderson + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -14959.84 + details: + - name: CreditNotes + amount: -14959.84 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 773.94 + details: + - name: Invoices + amount: 773.94 + - customerId: d3739e0f-5a70-465b-9dfe-deb8efac0cd3 + customerName: Damien Schneider + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2817.59 + details: + - name: CreditNotes + amount: -2817.59 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 10652b76-2a9a-43ba-a892-fb4f369fe1ef + customerName: Franco Labadie + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1541.52 + details: + - name: CreditNotes + amount: -1541.52 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 03b7f9fd-40e0-4c71-9f93-58e867233bcb + customerName: Harvey Predovic + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -14312.59 + details: + - name: CreditNotes + amount: -14312.59 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 158.76 + details: + - name: Invoices + amount: 158.76 + - customerId: bbea9634-7a60-4c3f-97cd-70e481ec2cce + customerName: Jenkins Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -32818.36 + details: + - name: CreditNotes + amount: -32818.36 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 431.71 + details: + - name: Invoices + amount: 431.71 + - customerId: d65ac505-072c-49ec-be3c-3cb74228966d + customerName: Jensen Steuber + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -9766.18 + details: + - name: Invoices + amount: 0 + - name: CreditNotes + amount: -9766.18 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1273.16 + details: + - name: Invoices + amount: 1273.16 + - customerId: a82042f1-a005-4ca5-bfd3-5bc237123aa5 + customerName: Keara Leffler + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2595.66 + details: + - name: CreditNotes + amount: -2595.66 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1397.98 + details: + - name: Invoices + amount: 1397.98 + - customerId: f67eab14-12f1-432f-af73-81ebf6ec8ddc + customerName: Neoma Kreiger + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3047.62 + details: + - name: CreditNotes + amount: -3047.62 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 2d6a5c2d-80dc-4aac-8909-ddfb3cb24437 + customerName: Newton Zieme + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -225.44 + details: + - name: CreditNotes + amount: -225.44 + - name: Invoices + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 976a2402-0908-46d9-9121-a93005d29c01 + customerName: Norbert Tillman + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -537.61 + details: + - name: CreditNotes + amount: -537.61 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 453ddfc0-49ce-4f66-a815-dae734be885c + customerName: Ralph Wilderman + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2538.49 + details: + - name: CreditNotes + amount: -2538.49 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 51f03576-f6b0-40d5-9fba-81a490411c03 + customerName: Raul Johns + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -4403.5 + details: + - name: CreditNotes + amount: -4403.5 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3477.81 + details: + - name: Invoices + amount: 3477.81 + - customerId: 84539fde-118f-48ed-978d-0aa50c7ec223 + customerName: Rodger Feest + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1456.66 + details: + - name: CreditNotes + amount: -1456.66 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7366.21 + details: + - name: Invoices + amount: 7366.21 + - customerId: dc75136b-b504-49c5-be35-04e1d2771e1e + customerName: Vincenzo Wolff + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -80.97 + details: + - name: CreditNotes + amount: -80.97 + - name: Invoices + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + Dynamics 365 Business Central: + value: + generated: '2023-05-02T16:05:20.8918448Z' + reportDate: '2023-05-02T16:05:20.8411594Z' + data: + - customerId: 8ddfa6bf-0c60-eb11-89fa-00224800af18 + customerName: Abdi Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -80 + details: + - name: CreditNotes + amount: -80 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -257.28 + details: + - name: Payments + amount: -300 + - name: Invoices + amount: 42.72 + - customerId: b41217b3-89d1-ea11-bbaa-000d3a2b9185 + customerName: Adatum Corporation + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1558.56 + details: + - name: CreditNotes + amount: -1558.56 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 33200.76 + details: + - name: Invoices + amount: 34782.32 + - name: Payments + amount: -1581.56 + - currency: HKD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 8554.46 + details: + - name: Invoices + amount: 8554.46 + - customerId: ba1217b3-89d1-ea11-bbaa-000d3a2b9185 + customerName: Alpine Ski House + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7503.08 + details: + - name: Invoices + amount: 7503.08 + - customerId: f5860a8e-4b5a-eb11-89fa-00224800af18 + customerName: CustomerQA + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 349.68 + details: + - name: Invoices + amount: 349.68 + - customerId: feef29a2-1d59-ed11-8c36-002248c5e6c0 + customerName: DP Test Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 332.2 + details: + - name: Invoices + amount: 427.2 + - name: Payments + amount: -95 + - customerId: 264d74d4-3218-ed11-90eb-000d3a873415 + customerName: Eliana + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -779.28 + details: + - name: CreditNotes + amount: -779.28 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1905 + details: + - name: Invoices + amount: 1905 + - customerId: 99faf6fb-5209-eb11-bbf6-0022481ad2e8 + customerName: QA Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4923.48 + details: + - name: Invoices + amount: 4923.48 + - customerId: bc1217b3-89d1-ea11-bbaa-000d3a2b9185 + customerName: Relecloud + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10559.04 + details: + - name: Invoices + amount: 10559.04 + - customerId: b81217b3-89d1-ea11-bbaa-000d3a2b9185 + customerName: School of Fine Art + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 33438.88 + details: + - name: Invoices + amount: 34811.2 + - name: Payments + amount: -1372.32 + - customerId: dc3f4f1b-3c54-ed11-9470-002248c5e18c + customerName: Test no payment terms + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Invoices + amount: 10 + - customerId: 9e55a119-064e-ed11-946f-0022481b84d7 + customerName: Test Push + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 126 + details: + - name: Invoices + amount: 126 + - customerId: b30ca600-074e-ed11-946f-0022481b84d7 + customerName: Test Push + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 116 + details: + - name: Invoices + amount: 116 + - customerId: b61217b3-89d1-ea11-bbaa-000d3a2b9185 + customerName: Trey Researches + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -24 + details: + - name: CreditNotes + amount: -24 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2663.38 + details: + - name: Payments + amount: 10 + - name: Invoices + amount: 2653.38 + - customerId: d93ceb37-b805-ec11-86bc-0022481a45c2 + customerName: Vegan Bakeshop + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -18.67 + details: + - name: Payments + amount: -18.67 + FreshBooks: + value: + generated: '2023-05-02T16:05:20.6173310Z' + reportDate: '2023-05-02T16:05:20.5039554Z' + data: + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -1 + details: + - name: Payments + amount: -1 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -5 + details: + - name: Payments + amount: -5 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -500 + details: + - name: Payments + amount: -500 + - name: Invoices + amount: 0 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -100 + details: + - name: Payments + amount: -100 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -49 + details: + - name: Payments + amount: -49 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: Payments + amount: -10 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 100 + details: + - name: Invoices + amount: 100 + - customerId: '602174' + customerName: ab1 + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 222.71 + details: + - name: Invoices + amount: 222.71 + - currency: AED + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -5 + details: + - name: Payments + amount: -5 + - customerId: '511657' + customerName: Bob's Stationary + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -2060.2 + details: + - name: Payments + amount: -2083.83 + - name: Invoices + amount: 23.63 + - customerId: '581145' + customerName: CanadaCo + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -132.15 + details: + - name: Payments + amount: -160.9 + - name: Invoices + amount: 28.75 + - currency: CNY + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2.88 + details: + - name: Invoices + amount: 2.88 + - customerId: '578409' + customerName: company1 + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -1031.45 + details: + - name: Invoices + amount: 144 + - name: Payments + amount: -1175.45 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -100.29 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -100.29 + - customerId: '669531' + customerName: P + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 24.98 + details: + - name: Invoices + amount: 24.98 + - customerId: '515655' + customerName: Parent company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -2898.25 + details: + - name: Payments + amount: -2898.25 + - name: Invoices + amount: 0 + - customerId: '511669' + customerName: Pens International + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 516.3 + details: + - name: Payments + amount: 0 + - name: Invoices + amount: 516.3 + - customerId: '582461' + customerName: QA Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -76 + details: + - name: Invoices + amount: 20 + - name: Payments + amount: -96 + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -1.15 + details: + - name: Payments + amount: -1.15 + - customerId: '511661' + customerName: Sarah's Office Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -10 + - customerId: '572047' + customerName: SRS Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 141.25 + details: + - name: Invoices + amount: 141.25 + - customerId: '536295' + customerName: Test company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -144.46 + details: + - name: Invoices + amount: 7.64 + - name: Payments + amount: -152.1 + - customerId: '512927' + customerName: Wood Turnerss + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 48442.07 + details: + - name: Invoices + amount: 51089.28 + - name: Payments + amount: -2647.21 + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -10 + - currency: CAD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 192.28 + details: + - name: Invoices + amount: 1186.28 + - name: Payments + amount: -994 + KashFlow: + value: + generated: '2023-05-02T16:05:20.3727270Z' + reportDate: '2023-05-02T16:05:20.3123550Z' + data: + - customerId: '88459410' + customerName: Diogo Sousa + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 482.57 + details: + - name: Invoices + amount: 482.57 + - customerId: '86810130' + customerName: Maria Gomez + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -216 + details: + - name: Invoices + amount: -216 + - customerId: '86832299' + customerName: Mr French Person + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5 + details: + - name: Invoices + amount: 5 + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5 + details: + - name: Invoices + amount: 5 + - customerId: '69946501' + customerName: Peter Lord + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3 + details: + - name: Invoices + amount: 3 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -46 + details: + - name: CreditNotes + amount: -46 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 55661.49 + details: + - name: Invoices + amount: 55911.49 + - name: Payments + amount: -250 + - customerId: '88353693' + customerName: Test Customer updated + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4771.03 + details: + - name: Invoices + amount: 4771.03 + - customerId: '69952389' + customerName: Things Limited + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -42.42 + details: + - name: CreditNotes + amount: -42.42 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6385 + details: + - name: Invoices + amount: 6385 + MYOB AccountRight and Essentials: + value: + generated: '2023-05-02T16:05:21.0942911Z' + reportDate: '2023-05-02T16:05:20.8602315Z' + data: [] + Oracle NetSuite: + value: + generated: '2023-05-02T16:05:20.0339587Z' + reportDate: '2023-05-02T16:05:19.8669114Z' + data: [] + QuickBooks Desktop: + value: + generated: '2023-05-02T16:05:19.9204890Z' + reportDate: '2023-05-02T16:05:19.8723073Z' + data: + - customerId: 1F0000-933272658 + customerName: 'Jacobsen, Doug' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 7991.52 + details: + - name: Invoices + amount: 7991.52 + - name: Payments + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: 6F0000-1071510646 + customerName: 'Morgenthaler, Jenny' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -271.53 + details: + - name: Payments + amount: -271.53 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + QuickBooks Online: + value: + generated: '2023-05-02T16:05:21.0640297Z' + reportDate: '2023-05-02T16:05:20.9965545Z' + data: + - customerId: '67' + customerName: Abercrombie International Group + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -837.11 + details: + - name: CreditNotes + amount: -837.11 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 55512.84 + details: + - name: Invoices + amount: 55578.69 + - name: Payments + amount: -65.85 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Payments + amount: 10 + - customerId: '4' + customerName: Cathy's Consulting Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -905.8 + details: + - name: Invoices + amount: 314.2 + - name: Payments + amount: -1220 + - customerId: '20' + customerName: Chadha's Consultants + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -75 + details: + - name: Payments + amount: -75 + - customerId: '7' + customerName: Clement's Cleaners + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 24 + details: + - name: Invoices + amount: 24 + - customerId: '301' + customerName: Codat Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -650.27 + details: + - name: Invoices + amount: 15 + - name: CreditNotes + amount: -469.52 + - name: Payments + amount: -195.75 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 266.49 + details: + - name: Invoices + amount: 210.01 + - name: Payments + amount: 56.48 + - customerId: '305' + customerName: Codat Customer (USD) + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: + - name: Payments + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 121.5 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: 121.5 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Payments + amount: 10 + - customerId: '136' + customerName: Customer Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 13.37 + details: + - name: Payments + amount: 13.37 + - customerId: '218' + customerName: Diego Trantow + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 11.65 + details: + - name: Payments + amount: 11.65 + - customerId: '8' + customerName: Ecker Designs + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2273 + details: + - name: Invoices + amount: 2273 + - customerId: '59' + customerName: Ecker Holiday event + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3206779 + details: + - name: Invoices + amount: 3206779 + - customerId: '13' + customerName: Himateja Madala + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -100 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -100 + - customerId: '11' + customerName: Ho Engineering Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Invoices + amount: 10 + - customerId: '114' + customerName: huw default not included + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 116.4 + details: + - name: Invoices + amount: 116.4 + - customerId: '117' + customerName: Huw's Test Push customer2 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -521.4 + details: + - name: CreditNotes + amount: -521.4 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1120.6 + details: + - name: Invoices + amount: 1232.2 + - name: Payments + amount: -111.6 + - customerId: '306' + customerName: J Codat + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 32.1 + details: + - name: Invoices + amount: 176.1 + - name: Payments + amount: -144 + - customerId: '15' + customerName: Jen Zaccarella + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4800 + details: + - name: Invoices + amount: 4800 + - customerId: '307' + customerName: Jo Codat 2 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 112.6 + details: + - name: Invoices + amount: 143.96 + - name: Payments + amount: 58.14 + - name: CreditNotes + amount: -89.5 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: '119' + customerName: John Smith 1 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 160 + details: + - name: Invoices + amount: 160 + - customerId: '16' + customerName: Jordan Burgess + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1098 + details: + - name: CreditNotes + amount: -1098 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -60 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -60 + - customerId: '83' + customerName: Kay's Bake Shop + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 8508.37 + details: + - name: Invoices + amount: 8717.33 + - name: Payments + amount: -208.96 + - customerId: '1' + customerName: Ko International Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3586.2 + details: + - name: CreditNotes + amount: -3586.2 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 11291.4 + details: + - name: Invoices + amount: 11474.05 + - name: Payments + amount: -182.65 + - customerId: '91' + customerName: Mr Huw Test + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2311.27 + details: + - name: CreditNotes + amount: -2311.27 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2292.91 + details: + - name: Invoices + amount: 2290.91 + - name: Payments + amount: 2 + - customerId: '55' + customerName: Oxon Insurance - Holiday Party + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10800 + details: + - name: Payments + amount: -10800 + - customerId: '70' + customerName: Project X + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 50 + details: + - name: Invoices + amount: 50 + - customerId: '281' + customerName: Renee O'Connell + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12.75 + details: + - name: Payments + amount: 12.75 + - customerId: '118' + customerName: RSP + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 100 + details: + - name: Payments + amount: 100 + - customerId: '76' + customerName: TestPushCustomer5 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1320 + details: + - name: Invoices + amount: 1320 + - customerId: '77' + customerName: TestPushCustomer6 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1848 + details: + - name: Invoices + amount: 1848 + - customerId: '79' + customerName: TestPushCustomer7 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -25 + details: + - name: Payments + amount: -25 + - customerId: '84' + customerName: Vegan Cake Shop + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -86.4 + details: + - name: CreditNotes + amount: -116.4 + - name: Payments + amount: 30 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -206460.15 + details: + - name: Invoices + amount: 5145.29 + - name: Payments + amount: -211605.44 + - customerId: '60' + customerName: Whitehead - Employee celebration + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1100 + details: + - name: CreditNotes + amount: -1100 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: '5' + customerName: Whitehead and Sons + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 754.4 + details: + - name: Invoices + amount: 754.4 + - customerId: '3' + customerName: Yeung's Architects + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -600 + details: + - name: CreditNotes + amount: -600 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 20035.25 + details: + - name: Invoices + amount: 20604.49 + - name: Payments + amount: -569.24 + Sage 200cloud: + value: + generated: '2023-05-02T16:05:20.5553019Z' + reportDate: '2023-05-02T16:05:20.4958267Z' + data: + - customerId: A1D001 + customerName: A1 Design Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -378 + details: + - name: CreditNotes + amount: -378 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4504.07 + details: + - name: Invoices + amount: 4505.07 + - name: Payments + amount: -1 + - customerId: A1D002 + customerName: A2 Design Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -66 + details: + - name: CreditNotes + amount: -66 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 540 + details: + - name: Invoices + amount: 540 + - customerId: A1D003 + customerName: A2 Design Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -24.71 + details: + - name: CreditNotes + amount: -24.71 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 16606.32 + details: + - name: Invoices + amount: 16606.32 + - customerId: ABS001 + customerName: ABS Garages Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -177.14 + details: + - name: CreditNotes + amount: -177.14 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4345.3 + details: + - name: Invoices + amount: 4845.3 + - name: Payments + amount: -500 + - customerId: USA1 + customerName: American Sales + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 100 + details: + - name: Invoices + amount: 100 + - customerId: BBS001 + customerName: Bobs Building Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -103.16 + details: + - name: CreditNotes + amount: -103.16 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4284.77 + details: + - name: Invoices + amount: 4309.77 + - name: Payments + amount: -25 + - customerId: BRO001 + customerName: Bronson Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 786.48 + details: + - name: Invoices + amount: 852 + - name: Payments + amount: -65.52 + - customerId: BUS001 + customerName: Business Exhibitions + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2274.62 + details: + - name: Invoices + amount: 2374.62 + - name: Payments + amount: -100 + - customerId: CASH001 + customerName: Cash and Credit Card Sales + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 324.5 + details: + - name: Invoices + amount: 324.5 + - customerId: COM001 + customerName: Compton Packaging + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4571.04 + details: + - name: Invoices + amount: 4571.04 + - customerId: CGS001 + customerName: County Golf Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2028.03 + details: + - name: Invoices + amount: 2028.03 + - customerId: STU001 + customerName: Edward Stuart + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2341.25 + details: + - name: Invoices + amount: 2341.25 + - customerId: FGL001 + customerName: F G Landscape & Design + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 11260.26 + details: + - name: Invoices + amount: 11260.26 + - customerId: BRI001 + customerName: Fred Briant + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 536.67 + details: + - name: Invoices + amount: 656.67 + - name: Payments + amount: -120 + - customerId: GRA001 + customerName: Graham Electonics + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4149.09 + details: + - name: Invoices + amount: 4149.09 + - customerId: HAU001 + customerName: Hausser GMBH + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2082.96 + details: + - name: Invoices + amount: 2082.96 + - customerId: JSS001 + customerName: John Smith Studios + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1228.34 + details: + - name: Invoices + amount: 1228.34 + - customerId: KIN001 + customerName: Kinghorn & French + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9254.03 + details: + - name: Invoices + amount: 9254.03 + - customerId: MAC001 + customerName: Macolm Hall Associates + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6927.26 + details: + - name: Invoices + amount: 6927.26 + - customerId: 1A2B3C + customerName: Maria Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 69.12 + details: + - name: Invoices + amount: 69.12 + - customerId: MIB001 + customerName: Mikes Insurance Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3597.16 + details: + - name: Invoices + amount: 3597.16 + - customerId: MIL001 + customerName: Mile Road Health Centre + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5644.12 + details: + - name: Invoices + amount: 6644.12 + - name: Payments + amount: -1000 + - customerId: MOR001 + customerName: Morley Solicitors + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 392.67 + details: + - name: Invoices + amount: 1767.67 + - name: Payments + amount: -1375 + - customerId: PAT001 + customerName: Patterson & Graham Garages + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 915.24 + details: + - name: Invoices + amount: 915.24 + - customerId: YOU001 + customerName: Peter Young + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -168 + details: + - name: CreditNotes + amount: -168 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2106.84 + details: + - name: Invoices + amount: 2106.84 + - customerId: PIC001 + customerName: Picture Frame Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 546.12 + details: + - name: Invoices + amount: 1413.9 + - name: Payments + amount: -867.78 + - customerId: RSP001 + customerName: Richard Sanderson-Pope + agedCurrencyOutstanding: + - currency: JPY + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -29210 + details: + - name: CreditNotes + amount: -29210 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 623907.28 + details: + - name: Invoices + amount: 624053.94 + - name: Payments + amount: -146.66 + - customerId: ROB001 + customerName: Robertson Joinery + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4550.2 + details: + - name: Invoices + amount: 4550.2 + - customerId: SDE001 + customerName: S D Enterprises + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 15339.68 + details: + - name: Invoices + amount: 15339.68 + - customerId: STE001 + customerName: Stevenson & Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1562.75 + details: + - name: Invoices + amount: 1562.75 + - customerId: SWA001 + customerName: Swan Leisure Centre + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -16.68 + details: + - name: CreditNotes + amount: -16.68 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1615.51 + details: + - name: Invoices + amount: 1615.51 + - customerId: '0001' + customerName: Test Customer01 + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -366.71 + details: + - name: CreditNotes + amount: -366.71 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 900.22 + details: + - name: Invoices + amount: 913.38 + - name: Payments + amount: -13.16 + - customerId: TESTSUPP + customerName: Test supplier for testing purposes 1234567891234567891234567 + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 149.61 + details: + - name: Invoices + amount: 149.61 + - customerId: SHO001 + customerName: The Show Lodge + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7148.07 + details: + - name: Invoices + amount: 7148.07 + - customerId: VID001 + customerName: The Video Rental Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2041.66 + details: + - name: Invoices + amount: 2041.66 + Sage 50 (UK): + value: + generated: '2023-05-02T16:05:19.8072734Z' + reportDate: '2023-05-02T16:05:19.7472225Z' + data: + - customerId: A1D001 + customerName: A1 Design Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -5.37 + details: + - name: Invoices + amount: -5.37 + - customerId: ABS001 + customerName: ABS Garages Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2454.97 + details: + - name: Invoices + amount: 2454.97 + - customerId: BBS001 + customerName: Bobs Building Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4309.77 + details: + - name: Invoices + amount: 4309.77 + - customerId: BUS001 + customerName: Business Exhibitions + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2066.61 + details: + - name: Invoices + amount: 2166.61 + - name: Payments + amount: -100 + - customerId: CASH001 + customerName: Cash and Credit Card Sales + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -0.01 + details: + - name: Invoices + amount: -0.01 + - customerId: COM001 + customerName: Compton Packaging + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2749.02 + details: + - name: Invoices + amount: 2749.02 + - customerId: CGS001 + customerName: County Golf Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2028.03 + details: + - name: Invoices + amount: 2028.03 + - customerId: STU001 + customerName: Edward Stuart + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2341.25 + details: + - name: Invoices + amount: 2341.25 + - customerId: FGL001 + customerName: F G Landscape & Design + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 11256.18 + details: + - name: Invoices + amount: 11256.18 + - customerId: GRA001 + customerName: Graham Electonics + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4149.08 + details: + - name: Invoices + amount: 4149.08 + - customerId: HAU001 + customerName: Hausser GMBH + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1965.96 + details: + - name: Invoices + amount: 1965.96 + - customerId: JSS001 + customerName: John Smith Studios + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 977.09 + details: + - name: Invoices + amount: 977.09 + - customerId: KIN001 + customerName: Kinghorn & French + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7398.33 + details: + - name: Invoices + amount: 7398.33 + - customerId: MAC001 + customerName: Macolm Hall Associates + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6916.46 + details: + - name: Invoices + amount: 6916.46 + - customerId: MIB001 + customerName: Mikes Insurance Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3525.26 + details: + - name: Invoices + amount: 3525.26 + - customerId: MIL001 + customerName: Mile Road Health Centre + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2307.84 + details: + - name: Invoices + amount: 3307.84 + - name: Payments + amount: -1000 + - customerId: MOR001 + customerName: Morley Solicitors + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 370.27 + details: + - name: Invoices + amount: 1745.27 + - name: Payments + amount: -1375 + - customerId: PAT001 + customerName: Patterson & Graham Garages + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 915.24 + details: + - name: Invoices + amount: 915.24 + - customerId: YOU001 + customerName: Peter Young + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2115.77 + details: + - name: Invoices + amount: 2115.77 + - customerId: PIC001 + customerName: Picture Frame Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 268.93 + details: + - name: Invoices + amount: 1136.71 + - name: Payments + amount: -867.78 + - customerId: ROB001 + customerName: Robertson Joinery + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4530.98 + details: + - name: Invoices + amount: 4530.98 + - customerId: SDE001 + customerName: S D Enterprises + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 15339.68 + details: + - name: Invoices + amount: 15339.68 + - customerId: STE002 + customerName: Steven Stephenson + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 8.35 + details: + - name: Invoices + amount: 8.35 + - customerId: STE001 + customerName: Stevenson & Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1562.75 + details: + - name: Invoices + amount: 1562.75 + - customerId: SWA001 + customerName: Swan Leisure Centre + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -16.68 + details: + - name: CreditNotes + amount: -16.68 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1615.51 + details: + - name: Invoices + amount: 1615.51 + - customerId: SHO001 + customerName: The Show Lodge + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7305.77 + details: + - name: Invoices + amount: 7305.77 + - customerId: VID001 + customerName: The Video Rental Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2041.64 + details: + - name: Invoices + amount: 2041.64 + Sage Business Cloud Accounting: + value: + generated: '2023-05-02T16:05:20.9416221Z' + reportDate: '2023-05-02T16:05:20.7435694Z' + data: + - customerId: 260f6a3f94a243738f2d5e08496a41a8 + customerName: 100 test name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -60 + details: + - name: CreditNotes + amount: -60 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1471 + details: + - name: Invoices + amount: 1891 + - name: Payments + amount: -420 + - customerId: 860dd9f1ad9346ba85117aedfa19cc72 + customerName: 100 test name DS + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1065 + details: + - name: Invoices + amount: 1080 + - name: Payments + amount: -15 + - customerId: 395d26ee8ab44f8b861b468caf63b00d + customerName: 222 Abdul's Test Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -120 + details: + - name: CreditNotes + amount: -120 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2443.8 + details: + - name: Invoices + amount: 2759.8 + - name: Payments + amount: -316 + - customerId: 013cf04960924a0da800f019369c3262 + customerName: 333 Abdul's Test Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -0.66 + details: + - name: Invoices + amount: 9.34 + - name: Payments + amount: -10 + - customerId: 4ba77efb904e4380accc242b1526ac2c + customerName: 333 Abdul's Test Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10 + details: + - name: CreditNotes + amount: -10 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 65 + details: + - name: Invoices + amount: 65 + - customerId: 18e45991fe6440ad8e8b5ecf9a2e7e09 + customerName: 444 Abdul's Test Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -2 + details: + - name: Invoices + amount: 48 + - name: Payments + amount: -50 + - customerId: 23ca7ffaa2b54360937531dde804c9aa + customerName: aaa + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -22 + details: + - name: CreditNotes + amount: -22 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -62 + details: + - name: Invoices + amount: 7 + - name: Payments + amount: -69 + - customerId: 2b93da6ce4af4dc99520eafd28768457 + customerName: Abdul Al-haj + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 288 + details: + - name: Invoices + amount: 288 + - customerId: 460af92dd82a4a61b6ce1d18245789b3 + customerName: Abdul Al-haj + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 48 + details: + - name: Invoices + amount: 48 + - customerId: b8bd7e0dfdd64d39abaaf2dcd1c48b49 + customerName: Abdul Al-haj + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -119.99 + details: + - name: CreditNotes + amount: -119.99 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: aa37b59417024d2494f01ba23d92a2ef + customerName: Abe The Engineer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1562 + details: + - name: CreditNotes + amount: -1562 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1337 + details: + - name: Invoices + amount: 1362 + - name: Payments + amount: -25 + - customerId: df65eaa6789111e8aaa5027d54329956 + customerName: Baguettes Ltd + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -844.99 + details: + - name: CreditNotes + amount: -844.99 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 616726.02 + details: + - name: Invoices + amount: 617888.74 + - name: Payments + amount: -1162.72 + - customerId: 2916114b3b6942a7b08f1bcc971f5bf9 + customerName: c.taylor@codat.io + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1.2 + details: + - name: Invoices + amount: 1.2 + - customerId: 0556b365ef4e42068fff775f847c0330 + customerName: Customer 71 (AUD) + agedCurrencyOutstanding: + - currency: AUD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -701 + details: + - name: Payments + amount: -701 + - customerId: 145dee01b49c4359a052682f234007e3 + customerName: Customer Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: Payments + amount: -10 + - customerId: 76f656dfbafa4cec823f1e2e43ea1a8e + customerName: Customer Test 59 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: Payments + amount: -10 + - customerId: a11e6776ca9a4e16af3425982de25a22 + customerName: Debs Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5279.2 + details: + - name: Invoices + amount: 5279.2 + - customerId: cc80e0fb747e4ddaab743d778d04ec4a + customerName: Debs US Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 15111 + details: + - name: Invoices + amount: 15111 + - customerId: adb9cae8b34e446da3d53305b299168b + customerName: Fo Shizzle + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 300 + details: + - name: Invoices + amount: 300 + - customerId: cc745370213545f6bd4129a7502f19fb + customerName: Grace Lo + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -1150 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -1150 + - customerId: 3b17c5ae9caf4b88a4a9e33a83fa321d + customerName: Hello + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12 + details: + - name: Invoices + amount: 12 + - customerId: 979c5156ea0e45d9a9ea7b9d54775138 + customerName: J Customer FR + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -52795 + details: + - name: CreditNotes + amount: -52795 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 134045 + details: + - name: Invoices + amount: 134045 + - customerId: 99d52ca7060341a698a664d1737663c5 + customerName: J Customer UK + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -265 + details: + - name: CreditNotes + amount: -265 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 15 + details: + - name: Invoices + amount: 30 + - name: Payments + amount: -15 + - customerId: f40870d5b704407481be14f780122d4f + customerName: J Customer US + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -161570 + details: + - name: CreditNotes + amount: -161570 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 181372 + details: + - name: Invoices + amount: 181372 + - customerId: 50a66e9756d2416d946419948bcf3631 + customerName: J Customer ZA + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10 + details: + - name: CreditNotes + amount: -10 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: 0328dd6b109a4a6cbcb3d1a73f1d541b + customerName: James Arroyo + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -719 + details: + - name: Invoices + amount: 178 + - name: Payments + amount: -897 + - customerId: bca2a47d7b4549c79b0c092d26b6661c + customerName: Jay Farm + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 25.01 + details: + - name: Invoices + amount: 25.01 + - customerId: 6477be6d012b4d48b4c160c098645c1c + customerName: Jo's Bake Shop + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -37.8 + details: + - name: CreditNotes + amount: -37.8 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 22.25 + details: + - name: Invoices + amount: 48 + - name: Payments + amount: -25.75 + - customerId: 097305a078ba473c884d2519ab290e57 + customerName: John QuickEntry Test + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 396 + details: + - name: Invoices + amount: 396 + - customerId: eac978a7622e4ef8b8d3af661f0cfdd3 + customerName: John Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 200 + details: + - name: Invoices + amount: 200 + - customerId: 3cc3148bbd8111e8bad90617b3da4b8a + customerName: John's Test Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1081.2 + details: + - name: CreditNotes + amount: -1081.2 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3379 + details: + - name: Invoices + amount: 3479 + - name: Payments + amount: -100 + - customerId: f66deccde15843ef80a82daad887146b + customerName: Kiran testing 2 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 48 + details: + - name: Invoices + amount: 48 + - customerId: 6e921696a21a45c891ff4716a18e7649 + customerName: M Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 900 + details: + - name: Invoices + amount: 900 + - customerId: bbb0582a0d054f5db268e570b50b4d6c + customerName: Mark Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 40 + details: + - name: Invoices + amount: 40 + - customerId: 440ba2199c07426a93e8edc1beb09791 + customerName: Matt Ager test EUR customer + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -8159.78 + details: + - name: CreditNotes + amount: -8159.78 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6016.67 + details: + - name: Invoices + amount: 6022.98 + - name: Payments + amount: -6.31 + - customerId: d430ed86b05645d7af0a630dae5d11d2 + customerName: Matthew Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 240 + details: + - name: Invoices + amount: 240 + - customerId: 9e8c3d82a2164ad29e29ab3a09ddf382 + customerName: Morv Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 300 + details: + - name: Invoices + amount: 300 + - customerId: fbdd38adb5b4441ebb200b83700d7ea5 + customerName: My Shop Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -384 + details: + - name: CreditNotes + amount: -384 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 398 + details: + - name: Invoices + amount: 398 + - customerId: 4b4cc40d998f47c3bec92fc088dcf327 + customerName: Nicoletta Carchia + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 90 + details: + - name: Invoices + amount: 90 + - customerId: ed070b1768bb4dd295e2a544a74c8ec0 + customerName: Paige Burlingham + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -48 + details: + - name: CreditNotes + amount: -48 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 48 + details: + - name: Invoices + amount: 48 + - customerId: 84709d3f01a4462eb7f1527718f525f4 + customerName: SageOneCustomer.BusinessName + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1085 + details: + - name: CreditNotes + amount: -1085 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: 90c438274d0b43759407da704394c104 + customerName: Test Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -16.2 + details: + - name: CreditNotes + amount: -16.2 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1137.2 + details: + - name: Invoices + amount: 1137.2 + - customerId: 762e6895c1ff43f988f35fb507e20dd9 + customerName: Test Custiomer 2 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -615 + details: + - name: CreditNotes + amount: -615 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2178.25 + details: + - name: Invoices + amount: 2178.25 + - customerId: 7b9c18af4b66454b9f7e9409eb7da123 + customerName: Test Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1200 + details: + - name: Invoices + amount: 1200 + - customerId: 4ccf5c5fa14046ecb591e0620d87ea2e + customerName: Test Customer 3 + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -50 + details: + - name: CreditNotes + amount: -50 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 499971 + details: + - name: Invoices + amount: 499971 + - customerId: f4ff85ba33dd11e797950a57719b2edb + customerName: Widgets Limited + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -23206.12 + details: + - name: CreditNotes + amount: -23206.12 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 733824.64 + details: + - name: Invoices + amount: 739536.49 + - name: Payments + amount: -5711.85 + Sage Intacct: + value: + generated: '2023-05-02T16:05:22.6557479Z' + reportDate: '2023-05-02T16:05:22.6081858Z' + data: + - customerId: '6' + customerName: AG Insurance + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 180 + details: + - name: Invoices + amount: 180 + - customerId: '531' + customerName: Shoprite + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -150 + details: + - name: Payments + amount: -150 + Xero: + value: + generated: '2023-05-02T16:05:20.0730291Z' + reportDate: '2023-05-02T16:05:20.0102278Z' + data: + - customerId: 305ca5cf-497d-4fee-a161-cdb30e6be989 + customerName: Basket Case + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 914.55 + details: + - name: Invoices + amount: 914.55 + - customerId: 362819c9-f285-4d09-ac95-26327863adac + customerName: Bayside Club + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3434 + details: + - name: Invoices + amount: 3434 + - customerId: 9ce626d2-14ea-463c-9fff-6785ab5f9bfb + customerName: Boom FM + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1623.75 + details: + - name: Invoices + amount: 1623.75 + - customerId: c523e12f-8b74-4d3a-bbd8-32d7a2f598b4 + customerName: City Limousines + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1169.95 + details: + - name: Invoices + amount: 1169.95 + - customerId: 1262c350-fe0f-40ec-aeff-41c95b4a45af + customerName: DIISR - Small Business Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4470.63 + details: + - name: Invoices + amount: 4470.63 + - customerId: 94cb6d7b-5291-49f3-a0bc-fc0c01e68575 + customerName: Marine Systems + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 396 + details: + - name: Invoices + amount: 396 + - customerId: 847933f0-7c35-4e5b-b884-5f9df64c8e4b + customerName: Port & Philip Freight + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2245 + details: + - name: Invoices + amount: 2245 + - customerId: a871a956-05b5-4e2a-9419-7aeb478ca647 + customerName: Ridgeway University + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6187.5 + details: + - name: Invoices + amount: 6187.5 + Zoho Books: + value: + generated: '2023-05-02T16:05:23.2078272Z' + reportDate: '2023-05-02T16:05:23.1573589Z' + data: + - customerId: '104957000000054050' + customerName: 'Doe, John' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10567 + details: + - name: CreditNotes + amount: -10567 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 38965 + details: + - name: Invoices + amount: 39865 + - name: Payments + amount: -900 + - customerId: '104957000000634160' + customerName: Dr. Jekyll + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -110 + details: + - name: CreditNotes + amount: -110 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: '104957000000080010' + customerName: Max Mustermann + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -68 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -68 + - customerId: '104957000000277089' + customerName: Miss. No Contact Persons + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10 + details: + - name: CreditNotes + amount: -10 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: '104957000000054080' + customerName: Ms. Jane Doe + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -465 + details: + - name: CreditNotes + amount: -465 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: '104957000000277001' + customerName: 'Sousa, Diogo' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9001 + details: + - name: Invoices + amount: 9001 + - customerId: '104957000000037097' + customerName: Test Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -9001 + details: + - name: CreditNotes + amount: -9001 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3556.98 + details: + - name: Invoices + amount: 4501 + - name: Payments + amount: -944.02 + - customerId: '104957000001497001' + customerName: Will Westrop + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 56 + details: + - name: Invoices + amount: 56 + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/agedCreditor/available': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + summary: Aged creditors report available + description: Indicates whether the aged creditor report is available for the company. + operationId: is-aged-creditors-report-available + x-speakeasy-name-override: is-aged-creditors-available + x-speakeasy-group: accounts-receivable.reports + responses: + '200': + description: OK + content: + application/json: + schema: + type: boolean + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/agedCreditor': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + parameters: + - $ref: '#/components/parameters/accountingReportDate' + - $ref: '#/components/parameters/accountingNumberOfPeriods' + - $ref: '#/components/parameters/accountingPeriodLengthDays' + summary: Aged creditors report + description: Returns aged creditors report for company that shows the total balance owed by a business to its suppliers over time. + operationId: get-accounting-aged-creditors-report + x-speakeasy-name-override: get-aged-creditors + x-speakeasy-group: accounts-receivable.reports + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAgedCreditorReport' + examples: + Clear Books: + value: + generated: '2023-05-02T16:05:21.7545859Z' + reportDate: '2023-05-02T16:05:21.7016767Z' + data: + - supplierId: owQ2Gqgj9f + supplierName: Abshire - Kshlerin + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -78.12 + details: + - name: BillCreditNotes + amount: -78.12 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 375.6 + details: + - name: Bills + amount: 375.6 + - supplierId: FyUkHbZxhn + supplierName: Arjun Kuvalis + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3782.27 + details: + - name: BillCreditNotes + amount: -3782.27 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 8556.1 + details: + - name: Bills + amount: 8556.1 + - supplierId: gxazX5hqx4 + supplierName: Bernier Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 213.19 + details: + - name: Bills + amount: 213.19 + - supplierId: ro8nWYGzlg + supplierName: Botsford - Hickle + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2242.95 + details: + - name: Bills + amount: 0 + - name: BillCreditNotes + amount: -2242.95 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 838.67 + details: + - name: Bills + amount: 838.67 + - supplierId: D4Q4iYwHou + supplierName: 'Breitenberg, Emard and Schiller' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -276.5 + details: + - name: BillCreditNotes + amount: -276.5 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 46060.53 + details: + - name: Bills + amount: 46060.53 + - supplierId: 9436ead6-545e-4e8c-8444-0220047c5a38 + supplierName: Champlin LLC + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 22726.97 + details: + - name: Bills + amount: 22726.97 + - supplierId: O6jExrbN3v + supplierName: Collins - Anderson + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -19.39 + details: + - name: BillCreditNotes + amount: -19.39 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 9d4b61a4-4ce3-4d90-8d6b-66614694dc27 + supplierName: Crona - Adams + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 302.8 + details: + - name: Bills + amount: 302.8 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: ad8f4ee1-7a04-415f-b3dc-365d41d8d4f0 + supplierName: 'Cronin, Kunde and Tremblay' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3271.91 + details: + - name: BillCreditNotes + amount: -3271.91 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3479.78 + details: + - name: Bills + amount: 3479.78 + - supplierId: 8GeHBdBZiZ + supplierName: 'DuBuque, Goyette and Franecki' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -16511.91 + details: + - name: BillCreditNotes + amount: -16511.91 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: XOPP3v2lQu + supplierName: Fisher and Sons + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 238599.9 + details: + - name: Bills + amount: 238599.9 + - supplierId: 0a7b0432-7de3-4e29-bf15-4e7ca0722384 + supplierName: Flatley - Kirlin + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -113.59 + details: + - name: BillCreditNotes + amount: -113.59 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 910.45 + details: + - name: Bills + amount: 910.45 + - supplierId: HrGZeW4I51 + supplierName: 'Frami, Simonis and Krajcik' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2070.59 + details: + - name: BillCreditNotes + amount: -2070.59 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: SFmBGSHLQ3 + supplierName: Gottlieb LLC + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -105.07 + details: + - name: BillCreditNotes + amount: -105.07 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: unNIu8Uyap + supplierName: Hahn and Sons + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -297.78 + details: + - name: BillCreditNotes + amount: -297.78 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2095.75 + details: + - name: Bills + amount: 2095.75 + - supplierId: GTGS3Sx241 + supplierName: Harvey Predovic + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3612.41 + details: + - name: Bills + amount: 3612.41 + - supplierId: w07H3CBm5P + supplierName: 'Hayes, Predovic and Ruecker' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -11662.51 + details: + - name: BillCreditNotes + amount: -11662.51 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 393776.18 + details: + - name: Bills + amount: 393776.18 + - supplierId: 92144542-2227-409e-8f5b-fc73260e670b + supplierName: 'Hettinger, Schmitt and Will' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 3433.54 + details: + - name: Bills + amount: 3433.54 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: rpLhEYz0ML + supplierName: Hickle - Buckridge + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -7484.88 + details: + - name: BillCreditNotes + amount: -7484.88 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: d2056eb9-649e-4808-8f96-d8ea4dac71fe + supplierName: Hodkiewicz Group + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -6627.16 + details: + - name: BillCreditNotes + amount: -6627.16 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 18266.27 + details: + - name: Bills + amount: 18266.27 + - supplierId: s3WcvMyVdR + supplierName: Howe - Ruecker + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4042.16 + details: + - name: Bills + amount: 4042.16 + - supplierId: b60XbI9zhE + supplierName: Jenkins Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -12938.29 + details: + - name: BillCreditNotes + amount: -12938.29 + - name: Bills + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 18360.8 + details: + - name: Bills + amount: 18360.8 + - supplierId: OtXKRTOcQc + supplierName: Jensen Steuber + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 190.16 + details: + - name: Bills + amount: 190.16 + - supplierId: c02bc2f1-631d-4721-aec1-a190d63e8322 + supplierName: Jones - Zulauf + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -69.05 + details: + - name: BillCreditNotes + amount: -69.05 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 51357.36 + details: + - name: Bills + amount: 51357.36 + - supplierId: c02382bd-ff23-4b34-bfd7-8dce15fa7d6a + supplierName: Keara Leffler + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2496.69 + details: + - name: BillCreditNotes + amount: -2496.69 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1519.74 + details: + - name: Bills + amount: 1519.74 + - supplierId: d3tf43eghS + supplierName: Klocko - Keebler + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12367.4 + details: + - name: Bills + amount: 12367.4 + - supplierId: 7GObELDcsE + supplierName: 'Lakin, Schmeler and Kihn' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -318.71 + details: + - name: BillCreditNotes + amount: -318.71 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: gO8p5O3Mvy + supplierName: Lehner Group + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1042.8 + details: + - name: BillCreditNotes + amount: -1042.8 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 62229022-713f-4c64-84f2-63cf6dd11443 + supplierName: Littel - Cole + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -7.5 + details: + - name: BillCreditNotes + amount: -7.5 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 39b32019-c5d0-4db3-ae83-f0a644e614ef + supplierName: Marvin - Schaden + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1611.56 + details: + - name: BillCreditNotes + amount: -1611.56 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 8635b986-048f-424c-985d-912576c004d9 + supplierName: 'Mills, Bechtelar and Wintheiser' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -604.41 + details: + - name: BillCreditNotes + amount: -604.41 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: d2fb1aba-79ac-4840-95d5-6c173c9beaad + supplierName: Morissette LLC + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -55.93 + details: + - name: BillCreditNotes + amount: -55.93 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 27dc0345-aae8-4b69-a903-fed6b0a8778b + supplierName: Newton Zieme + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1546.46 + details: + - name: Bills + amount: 1546.46 + - supplierId: 0d892acd-4b56-4412-80ee-381b8118637b + supplierName: Nicolas - McKenzie + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -186.97 + details: + - name: BillCreditNotes + amount: -186.97 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5131.74 + details: + - name: Bills + amount: 5131.74 + - supplierId: cc283863-960f-42f8-8e38-1e22235e9cfc + supplierName: Nicolas Group + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -6.41 + details: + - name: BillCreditNotes + amount: -6.41 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 9UvJVVmPHO + supplierName: Nienow - Schroeder + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2822.41 + details: + - name: BillCreditNotes + amount: -2822.41 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 1346295c-2970-47a7-8a99-1f935567db02 + supplierName: Polly Crona + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3600.36 + details: + - name: Bills + amount: 3600.36 + - supplierId: 5fcb09bf-ae92-42a1-a69b-57c5f0ebedd9 + supplierName: Raul Johns + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2938.85 + details: + - name: Bills + amount: 0 + - name: BillCreditNotes + amount: -2938.85 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: 4253a13e-638e-4a42-9e61-665a60267a48 + supplierName: 'Robel, Ledner and Stroman' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1106.72 + details: + - name: Bills + amount: 1106.72 + - supplierId: 143ed2c5-2623-465e-a015-5ac12df75aa6 + supplierName: Schulist - Douglas + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -12468.22 + details: + - name: BillCreditNotes + amount: -12468.22 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 39306.44 + details: + - name: Bills + amount: 39306.44 + - supplierId: d770b767-489e-455b-9d32-29c37a1b9d07 + supplierName: Schultz Group + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -517.52 + details: + - name: BillCreditNotes + amount: -517.52 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 98e93284-fcaa-440c-8f86-f36e5df591da + supplierName: Simonis - Ziemann + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -597.01 + details: + - name: BillCreditNotes + amount: -597.01 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: 87e907ed-97f8-4146-b276-fea2a10671bf + supplierName: Sporer and Sons + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -62443.6 + details: + - name: BillCreditNotes + amount: -62443.6 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 97682025-4e50-449f-8510-6d09d1d0f84b + supplierName: Sporer LLC + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1104.37 + details: + - name: BillCreditNotes + amount: -1104.37 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1050.12 + details: + - name: Bills + amount: 1050.12 + - supplierId: c51351a0-b43f-48c6-8dbb-8417171bda67 + supplierName: Veum - Schiller + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1966.59 + details: + - name: BillCreditNotes + amount: -1966.59 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10234.97 + details: + - name: Bills + amount: 10234.97 + - supplierId: 26f6b56a-4a86-468f-a302-9d60bdc01d91 + supplierName: Vincenzo Wolff + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -23450.31 + details: + - name: BillCreditNotes + amount: -23450.31 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: f589fd05-c5f8-4815-b205-0a9f3f0b3b96 + supplierName: Weber LLC + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -681.79 + details: + - name: BillCreditNotes + amount: -681.79 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10221.45 + details: + - name: Bills + amount: 10221.45 + - supplierId: 1cc8b95c-62ec-415a-ab0e-facf7e7218bf + supplierName: 'Welch, Terry and Hermiston' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1219.54 + details: + - name: Bills + amount: 1219.54 + - supplierId: f6CgWtm1aw + supplierName: Wisoky Group + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 272.67 + details: + - name: Bills + amount: 272.67 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: je5ok1Cam5 + supplierName: 'Wunsch, Kerluke and West' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7238.24 + details: + - name: Bills + amount: 7238.24 + Dynamics 365 Business Central: + value: + generated: '2023-05-02T16:05:21.1349781Z' + reportDate: '2023-05-02T16:05:21.0866594Z' + data: + - supplierId: e89328bd-485a-eb11-89fa-00224800af18 + supplierName: A QA + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -526.8 + details: + - name: BillCreditNotes + amount: -526.8 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 120 + details: + - name: Bills + amount: 120 + - supplierId: be1217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: 'Fabrikam, Inc.' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -65 + details: + - name: BillCreditNotes + amount: -65 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -11904.4 + details: + - name: Bills + amount: 461.6 + - name: BillPayments + amount: -12366 + - currency: PLN + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -15 + details: + - name: BillPayments + amount: -15 + - currency: MAD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5 + details: + - name: Bills + amount: 5 + - supplierId: c01217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: First Up Consultants + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12123.81 + details: + - name: Bills + amount: 12128.81 + - name: BillPayments + amount: -5 + - supplierId: c21217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: Graphic Design Institute + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7514.8 + details: + - name: Bills + amount: 7520.8 + - name: BillPayments + amount: -6 + - supplierId: 4a1b210e-b805-ec11-86bc-0022481a45c2 + supplierName: Kays Farm + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -121 + details: + - name: BillPayments + amount: -121 + - supplierId: c61217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: Nod Publishers + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 13156.74 + details: + - name: Bills + amount: 13156.74 + - supplierId: b864b5ae-4a5a-eb11-89fa-00224800af18 + supplierName: Test Supplier + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3951 + details: + - name: Bills + amount: 3951 + - currency: MAD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 121.45 + details: + - name: Bills + amount: 121.45 + - supplierId: 8b4c95b4-b705-ec11-86bc-0022481a45c2 + supplierName: Vegan Farm + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -5.27 + details: + - name: Bills + amount: 0 + - name: BillPayments + amount: -5.27 + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -11.75 + details: + - name: BillPayments + amount: -11.75 + - supplierId: c41217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: Wide World Importers + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 15843.22 + details: + - name: Bills + amount: 15848.22 + - name: BillPayments + amount: -5 + Exact (Netherlands): + value: + generated: '2023-05-02T16:05:19.8312183Z' + reportDate: '2023-05-02T16:05:19.7538301Z' + data: + - supplierId: 3150917c-1d92-4d77-9018-31b5c4758ca9 + supplierName: Abe + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -38.28 + details: + - name: BillCreditNotes + amount: -38.28 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1952.27 + details: + - name: Bills + amount: 1941.58 + - name: BillPayments + amount: 10.69 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Bills + amount: 10 + - supplierId: 5811b467-53eb-4491-8ca1-bc9b7889811b + supplierName: Ann's test supplier 2 + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10000 + details: + - name: BillCreditNotes + amount: -10000 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 117 + details: + - name: Bills + amount: 117 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4997.25 + details: + - name: Bills + amount: 4997.25 + - supplierId: 78afea22-ee21-48c3-84d5-45b9b24768e9 + supplierName: Ann's test supplier 2 + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 110 + details: + - name: Bills + amount: 108 + - name: BillPayments + amount: 2 + - supplierId: 773416a6-b196-487b-ae02-eeb273a86bcd + supplierName: Belastingdienst + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -293.14 + details: + - name: BillCreditNotes + amount: -293.14 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1547.08 + details: + - name: Bills + amount: 1547.08 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 32.17 + details: + - name: Bills + amount: 32.17 + - supplierId: 7017da1f-2d49-4601-abf3-c4e779459976 + supplierName: Bool Test + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 121 + details: + - name: Bills + amount: 121 + - supplierId: f87070e2-bbd7-4383-a7c9-824748c1d70e + supplierName: Exact Software Nederland B.V. + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -65.73 + details: + - name: BillCreditNotes + amount: -65.73 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -83351.62 + details: + - name: BillPayments + amount: -83381.63 + - name: Bills + amount: 30.01 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -8285.73 + details: + - name: BillPayments + amount: -8285.73 + - supplierId: 8cb6745b-4769-4c7a-9d92-bc688c60ca3c + supplierName: iZettle AB (Supplier) + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 19.93 + details: + - name: Bills + amount: 19.93 + - supplierId: 63fadca8-4905-475a-b32a-b4341293bcf4 + supplierName: Kelly's Industrial Supplies + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5 + details: + - name: BillPayments + amount: 5 + - supplierId: acde3236-898e-4e68-b076-4e946defbc5f + supplierName: Matt Ager Test Supplier 1 + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -276 + details: + - name: BillCreditNotes + amount: -276 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 75 + details: + - name: Bills + amount: 105 + - name: BillPayments + amount: -30 + - currency: RUB + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: BillPayments + amount: -10 + - supplierId: 5e6f49b9-6489-4b82-83e7-291d308919bb + supplierName: Mickey Mouse + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -12.1 + details: + - name: BillCreditNotes + amount: -12.1 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 119.97 + details: + - name: Bills + amount: 119.97 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -7040 + details: + - name: BillCreditNotes + amount: -7040 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 8800 + details: + - name: Bills + amount: 8800 + - supplierId: fc189bfa-f083-438c-bf09-379a0631d4a1 + supplierName: Mickey Mouse + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -0.83 + details: + - name: Bills + amount: -0.83 + - supplierId: 1d2c9f47-a2fc-48e6-a967-71583d764b10 + supplierName: NLSuppliers07 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 25 + details: + - name: Bills + amount: 25 + - supplierId: a1e88d58-caec-4ed6-ad1b-646ebb959c17 + supplierName: supplierrrr + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -55 + details: + - name: BillCreditNotes + amount: -55 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 11084 + details: + - name: Bills + amount: 11084 + - supplierId: cdcdce7b-0330-49fb-8169-0a50e0b74dcc + supplierName: Test NL sup1 + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 13.21 + details: + - name: BillPayments + amount: 13.21 + - supplierId: bad8020a-267f-41fb-9e0f-e93465ee9529 + supplierName: Test supplier + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 718.22 + details: + - name: Bills + amount: 718.22 + - supplierId: 26bc5305-8613-43e4-ab97-522ade34cbba + supplierName: Vandana's Test Supplier + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 403.74 + details: + - name: Bills + amount: 403.74 + Exact (UK): + value: + generated: '2023-05-02T16:05:22.8960035Z' + reportDate: '2023-05-02T16:05:22.8283897Z' + data: + - supplierId: 0185fea2-0298-445b-909a-0db685118a9e + supplierName: a + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10 + details: + - name: BillCreditNotes + amount: -10 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 560.1 + details: + - name: Bills + amount: 660.1 + - name: BillPayments + amount: -100 + - supplierId: 64ae712f-4155-48bb-9fce-98232c51d979 + supplierName: aa + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -400 + details: + - name: BillCreditNotes + amount: -400 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 30 + details: + - name: Bills + amount: 430 + - name: BillPayments + amount: -400 + - supplierId: 5f20075a-a28e-434d-81a6-2db0dc170e87 + supplierName: Abdi 99 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -65 + details: + - name: BillCreditNotes + amount: -65 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 609 + details: + - name: Bills + amount: 258 + - name: BillPayments + amount: 351 + - supplierId: 0d3f8692-4b0a-4bc3-85f2-4cb763306397 + supplierName: Ann's test supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3600 + details: + - name: BillCreditNotes + amount: -3600 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2400 + details: + - name: Bills + amount: 2400 + - supplierId: fc62db43-a6f8-4b65-9d29-15290ec56674 + supplierName: Anna's test supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1717.5 + details: + - name: BillCreditNotes + amount: -1717.5 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2751 + details: + - name: Bills + amount: 2751 + - supplierId: cde51f36-2a06-4eac-9784-c0c967c1e1ed + supplierName: b + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -6 + details: + - name: BillCreditNotes + amount: -6 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: 437c6631-3c5d-4351-b757-6ad4f94bd26e + supplierName: bb + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 220 + details: + - name: Bills + amount: 220 + - supplierId: fe713acb-3c98-423d-8372-68a32aae6232 + supplierName: cc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -60 + details: + - name: BillPayments + amount: -60 + - supplierId: 1c703cce-967c-4476-a86a-32e35341a8f5 + supplierName: Customer Bill Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -100073.4 + details: + - name: BillCreditNotes + amount: -100073.4 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 374.8 + details: + - name: Bills + amount: 373.8 + - name: BillPayments + amount: 1 + - supplierId: 6a4c6a14-d5eb-4427-aae0-c544f67dff7a + supplierName: CustomerAndSupplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2.05 + details: + - name: BillPayments + amount: 2.05 + - supplierId: efb5d438-7d3a-4b77-a254-2d90f76d3f22 + supplierName: dd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 200 + details: + - name: Bills + amount: 200 + - supplierId: 77b652bb-a363-4425-adbd-0206e2ce4639 + supplierName: e + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -72.33 + details: + - name: BillCreditNotes + amount: -72.33 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: a4d5d739-c979-4819-b0ce-666db1ec3a7d + supplierName: Exact Software (UK) Ltd � Exact Online + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 133.6 + details: + - name: Bills + amount: 133.6 + - supplierId: 7c8a9143-7322-48e3-b809-88a038b8a0e0 + supplierName: John Doe + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 192.5 + details: + - name: Bills + amount: 192.5 + - supplierId: a7cad20d-44db-442b-ac1f-90475802d6fb + supplierName: Pencils Pencils Pencils + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1200 + details: + - name: BillCreditNotes + amount: -1200 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3837 + details: + - name: Bills + amount: 3837 + - supplierId: 41302634-76b5-4442-b800-0bb63780e77c + supplierName: Some Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -46.8 + details: + - name: BillCreditNotes + amount: -46.8 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -54537.12 + details: + - name: Bills + amount: 455.73 + - name: BillPayments + amount: -54992.85 + FreeAgent: + value: + generated: '2023-05-02T16:05:23.3560058Z' + reportDate: '2023-05-02T16:05:23.3059155Z' + data: + - supplierId: '10123537' + supplierName: _Test 1 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: + - name: BillPayments + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 791 + details: + - name: Bills + amount: 791 + - currency: QAR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12 + details: + - name: Bills + amount: 12 + - supplierId: '11526230' + supplierName: '-' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -6430 + details: + - name: Bills + amount: 1500 + - name: BillCreditNotes + amount: -7930 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1200 + details: + - name: Bills + amount: 1200 + - supplierId: '9677150' + supplierName: '-' + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5 + details: + - name: Bills + amount: 5 + - supplierId: '8959011' + supplierName: '1' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -134.3 + details: + - name: BillCreditNotes + amount: -134.3 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 46 + details: + - name: Bills + amount: 46 + - supplierId: '6161941' + supplierName: A & J Fabtech Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2433.99 + details: + - name: BillCreditNotes + amount: -2433.99 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3431 + details: + - name: Bills + amount: 3431 + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 400 + details: + - name: Bills + amount: 400 + - supplierId: '6161963' + supplierName: ABB Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10 + details: + - name: BillCreditNotes + amount: -10 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: '9356878' + supplierName: Abdul Al-haj + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12 + details: + - name: Bills + amount: 12 + - supplierId: '8984892' + supplierName: Abraham's Spider Hunting Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 77 + details: + - name: Bills + amount: 77 + - supplierId: '9273150' + supplierName: Best Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -456 + details: + - name: BillCreditNotes + amount: -456 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: '6161956' + supplierName: C Allen + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -100 + details: + - name: BillCreditNotes + amount: -100 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 122 + details: + - name: Bills + amount: 122 + - supplierId: '7994567' + supplierName: codat + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Bills + amount: 10 + - supplierId: '5730310' + supplierName: Demo Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 200 + details: + - name: Bills + amount: 200 + - supplierId: '6162169' + supplierName: PricewaterhouseCoopers LLP + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 42 + details: + - name: Bills + amount: 42 + - supplierId: '10672202' + supplierName: Random Org + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -42 + details: + - name: BillCreditNotes + amount: -42 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 130 + details: + - name: Bills + amount: 130 + - supplierId: '8989342' + supplierName: Supplier Hidden + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -500 + details: + - name: BillCreditNotes + amount: -500 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -150 + details: + - name: BillPayments + amount: -150 + - supplierId: '7169654' + supplierName: The Eagle + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -492 + details: + - name: BillCreditNotes + amount: -492 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3523.75 + details: + - name: Bills + amount: 3523.75 + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 301 + details: + - name: Bills + amount: 301 + MYOB AccountRight and Essentials: + value: + generated: '2023-05-02T16:05:21.5229720Z' + reportDate: '2023-05-02T16:05:21.2821865Z' + data: [] + Oracle NetSuite: + value: + generated: '2023-05-02T16:05:20.3296968Z' + reportDate: '2023-05-02T16:05:20.2442587Z' + data: + - supplierId: '779' + supplierName: Test Vendor + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 56 + details: + - name: Bills + amount: 56 + - supplierId: '724' + supplierName: Vendor A.A.A + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 579.55 + details: + - name: Bills + amount: 524 + - name: BillPayments + amount: 55.55 + QuickBooks Desktop: + value: + generated: '2023-05-02T16:05:20.3972104Z' + reportDate: '2023-05-02T16:05:20.3178060Z' + data: + - supplierId: B0000-933272656 + supplierName: Patton Hardware Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: + - name: BillPayments + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5000 + details: + - name: Bills + amount: 5000 + QuickBooks Online: + value: + generated: '2023-05-02T16:05:21.3065432Z' + reportDate: '2023-05-02T16:05:21.2488309Z' + data: + - supplierId: '129' + supplierName: Ally Johnson + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 230.98 + details: + - name: Bills + amount: 276.38 + - name: BillPayments + amount: -45.4 + - supplierId: '88' + supplierName: Andrew Haberbosch + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -16 + details: + - name: BillCreditNotes + amount: -16 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 66.25 + details: + - name: BillPayments + amount: -13.75 + - name: Bills + amount: 80 + - supplierId: '53' + supplierName: Bank of AnyCity + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 63 + details: + - name: Bills + amount: 63 + - supplierId: '282' + supplierName: Becky's Bakery + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 490.5 + details: + - name: BillPayments + amount: -9.5 + - name: Bills + amount: 500 + - supplierId: '24' + supplierName: Brijesh Jain + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -69 + details: + - name: BillCreditNotes + amount: -69 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 52260 + details: + - name: Bills + amount: 52260 + - supplierId: '25' + supplierName: Brittney Hughes + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 70 + details: + - name: Bills + amount: 70 + - supplierId: '26' + supplierName: Burc Gunes + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 33.05 + details: + - name: Bills + amount: 33.05 + - supplierId: '27' + supplierName: Cass Hayden + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1450 + details: + - name: Bills + amount: 1500 + - name: BillPayments + amount: -50 + - supplierId: '51' + supplierName: City Water Co + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7.25 + details: + - name: Bills + amount: 24 + - name: BillPayments + amount: -16.75 + - supplierId: '297' + supplierName: Codat Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -128 + details: + - name: Bills + amount: 0 + - name: BillPayments + amount: -25 + - name: BillCreditNotes + amount: -103 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -328.32 + details: + - name: Bills + amount: 0 + - name: BillPayments + amount: -328.32 + - supplierId: '87' + supplierName: Costco + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -17.85 + details: + - name: BillPayments + amount: -17.85 + - supplierId: '57' + supplierName: Hall's Promo Items + agedCurrencyOutstanding: + - currency: HKD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1041.09 + details: + - name: Bills + amount: 1041.09 + - supplierId: '92' + supplierName: Huw Thomas + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 25292 + details: + - name: Bills + amount: 25302 + - name: BillPayments + amount: -10 + - supplierId: '85' + supplierName: Jay's Farm + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -446.83 + details: + - name: BillCreditNotes + amount: -446.83 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9759.68 + details: + - name: Bills + amount: 9822.46 + - name: BillPayments + amount: -62.78 + - supplierId: '34' + supplierName: Jennifer Hargreaves + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 239.01 + details: + - name: Bills + amount: 239.01 + - supplierId: '37' + supplierName: Kristina Gibson + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1710 + details: + - name: BillCreditNotes + amount: -1710 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 502.38 + details: + - name: Bills + amount: 502.38 + - supplierId: '41' + supplierName: Mark Howard + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3000 + details: + - name: Bills + amount: 3000 + - supplierId: '23' + supplierName: Mr Andrew Thomas Haberbosch + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -21.2 + details: + - name: BillCreditNotes + amount: -21.2 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 54.09 + details: + - name: Bills + amount: 54.09 + - supplierId: '54' + supplierName: Organization of Outstanding Event Planners + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 390 + details: + - name: Bills + amount: 390 + - supplierId: '47' + supplierName: Sanjeev Kak + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 21 + details: + - name: Bills + amount: 21 + - supplierId: '74' + supplierName: TestPushCustomer3 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 200 + details: + - name: Bills + amount: 200 + - supplierId: '86' + supplierName: Vegan Farm + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -42.76 + details: + - name: BillCreditNotes + amount: -42.76 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1249.3 + details: + - name: BillPayments + amount: -504.24 + - name: Bills + amount: 1753.54 + - supplierId: '58' + supplierName: Venue Rental + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 461 + details: + - name: Bills + amount: 500 + - name: BillPayments + amount: -39 + Sage 200cloud: + value: + generated: '2023-05-02T16:05:20.7939148Z' + reportDate: '2023-05-02T16:05:20.7474542Z' + data: + - supplierId: CON002 + supplierName: Concept Stationery Sub A + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 411.76 + details: + - name: Bills + amount: 782.56 + - name: BillPayments + amount: -370.8 + - supplierId: CON001 + supplierName: Concept Stationery Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -167.1 + details: + - name: BillCreditNotes + amount: -167.1 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5062.78 + details: + - name: Bills + amount: 5111.01 + - name: BillPayments + amount: -48.23 + - supplierId: MCN001 + supplierName: McNally Computer Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 25802.03 + details: + - name: Bills + amount: 25934.03 + - name: BillPayments + amount: -132 + - supplierId: MEA001 + supplierName: Mears Insurance + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -48 + details: + - name: BillCreditNotes + amount: -48 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1368.02 + details: + - name: Bills + amount: 1524 + - name: BillPayments + amount: -155.98 + - supplierId: NEW001 + supplierName: Newtown Builders Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -13.21 + details: + - name: BillCreditNotes + amount: -13.21 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1024.13 + details: + - name: Bills + amount: 1041.61 + - name: BillPayments + amount: -17.48 + - supplierId: QUA001 + supplierName: Quality Motors + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -105.64 + details: + - name: BillCreditNotes + amount: -105.64 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 155.92 + details: + - name: Bills + amount: 155.92 + - supplierId: RSP002 + supplierName: Richard Sanderson-Pope + agedCurrencyOutstanding: + - currency: JPY + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 60000 + details: + - name: Bills + amount: 60000 + - supplierId: SDE001 + supplierName: S D Enterprises + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1130.29 + details: + - name: Bills + amount: 1189.29 + - name: BillPayments + amount: -59 + - supplierId: STU001 + supplierName: Studio Designs + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 562.06 + details: + - name: Bills + amount: 562.06 + - supplierId: SUP002 + supplierName: Superclean + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2055.3 + details: + - name: Bills + amount: 2055.3 + - supplierId: SUP001 + supplierName: Superior Technologies Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9433.71 + details: + - name: Bills + amount: 9433.71 + - supplierId: THO001 + supplierName: Thompsons Electricals + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -135.13 + details: + - name: BillCreditNotes + amount: -135.13 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 576.04 + details: + - name: Bills + amount: 1091.04 + - name: BillPayments + amount: -515 + - supplierId: UNI001 + supplierName: Unique Systems + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -103.4 + details: + - name: BillCreditNotes + amount: -103.4 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1104.16 + details: + - name: Bills + amount: 1104.16 + - supplierId: WAL001 + supplierName: Wallace Office Equipment + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -70.76 + details: + - name: BillCreditNotes + amount: -70.76 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -55.52 + details: + - name: Bills + amount: 94.48 + - name: BillPayments + amount: -150 + - supplierId: WIS001 + supplierName: Wise Electricals Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -35.01 + details: + - name: BillCreditNotes + amount: -35.01 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -221.75 + details: + - name: Bills + amount: -121.75 + - name: BillPayments + amount: -100 + - supplierId: WIS002 + supplierName: Wiseman Paper Products + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5868.13 + details: + - name: Bills + amount: 5868.13 + Sage 50 (UK): + value: + generated: '2023-05-02T16:05:20.0257207Z' + reportDate: '2023-05-02T16:05:19.9751677Z' + data: + - supplierId: CON001 + supplierName: Concept Stationery Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1644.39 + details: + - name: Bills + amount: 1644.39 + - supplierId: MCN001 + supplierName: McNally Computer Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 24734.12 + details: + - name: Bills + amount: 24734.12 + - supplierId: NEW001 + supplierName: Newtown Builders Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -0.01 + details: + - name: BillCreditNotes + amount: -0.01 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0.01 + details: + - name: Bills + amount: 0.01 + - supplierId: QUA001 + supplierName: Quality Motors + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -42.63 + details: + - name: BillCreditNotes + amount: -42.63 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 72.85 + details: + - name: Bills + amount: 72.85 + - supplierId: SDE001 + supplierName: S D Enterprises + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 352.5 + details: + - name: Bills + amount: 352.5 + - supplierId: SUP002 + supplierName: Superclean + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1762.5 + details: + - name: Bills + amount: 1762.5 + - supplierId: SUP001 + supplierName: Superior Technologies Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9164.95 + details: + - name: Bills + amount: 9164.95 + - supplierId: THO001 + supplierName: Thompsons Electricals + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -135.13 + details: + - name: BillCreditNotes + amount: -135.13 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 472.24 + details: + - name: Bills + amount: 972.24 + - name: BillPayments + amount: -500 + - supplierId: UNI001 + supplierName: Unique Systems + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -103.4 + details: + - name: BillCreditNotes + amount: -103.4 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 744.16 + details: + - name: Bills + amount: 744.16 + - supplierId: WAL001 + supplierName: Wallace Office Equipment + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -58.76 + details: + - name: BillCreditNotes + amount: -58.76 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -55.52 + details: + - name: Bills + amount: 94.48 + - name: BillPayments + amount: -150 + - supplierId: WIS001 + supplierName: Wise Electricals Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -35.01 + details: + - name: BillCreditNotes + amount: -35.01 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 117.29 + details: + - name: Bills + amount: 117.29 + - supplierId: WIS002 + supplierName: Wiseman Paper Products + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5868.13 + details: + - name: Bills + amount: 5868.13 + Sage Business Cloud Accounting: + value: + generated: '2023-05-02T16:05:21.3095542Z' + reportDate: '2023-05-02T16:05:21.1514485Z' + data: + - supplierId: 65179671e9ef424caff8b9006cd111c8 + supplierName: 5555 Abdul's Test Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -60 + details: + - name: BillCreditNotes + amount: -60 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1548.84 + details: + - name: Bills + amount: 1608.84 + - name: BillPayments + amount: -60 + - supplierId: cf7f44d693904944a6a7cf3de0887964 + supplierName: Abdi Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -841570.32 + details: + - name: BillCreditNotes + amount: -841570.32 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 661901.14 + details: + - name: Bills + amount: 662062.14 + - name: BillPayments + amount: -161 + - supplierId: f82f0f59fbf44416b833562783388ee9 + supplierName: Abe's Spider Hunting Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -38.8 + details: + - name: Bills + amount: 1.2 + - name: BillPayments + amount: -40 + - supplierId: ec716559789111e8aaa5027d54329956 + supplierName: Bagels Limited + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -140.97 + details: + - name: BillCreditNotes + amount: -140.97 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1856307.16 + details: + - name: BillPayments + amount: -213 + - name: Bills + amount: 1856520.16 + - supplierId: b1354c4ae5db4d069acbcf49bee62215 + supplierName: Boyer Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 360000 + details: + - name: Bills + amount: 360000 + - supplierId: 46b3d6acedcb4738a9646dc512562cda + supplierName: callum + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1.2 + details: + - name: Bills + amount: 1.2 + - supplierId: 7e7450fadbb94d09abdaf609a51d05eb + supplierName: Debs UK Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -36 + details: + - name: BillCreditNotes + amount: -36 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1814652 + details: + - name: Bills + amount: 1814652 + - supplierId: bf6fc20701264c899a1ba96365aa9d70 + supplierName: Eliana's + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -105.6 + details: + - name: BillCreditNotes + amount: -105.6 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 26.4 + details: + - name: Bills + amount: 26.4 + - supplierId: 30862a4b2c084a4fa2e640f9ef371e4c + supplierName: Flour Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 60 + details: + - name: Bills + amount: 60 + - supplierId: 390ca10633cb4bf989961491e834b47a + supplierName: Jo Cheese + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9 + details: + - name: Bills + amount: 9 + - supplierId: b10be78d0e9340a79743c538a0b481d0 + supplierName: M7 Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 65150090 + details: + - name: Bills + amount: 65150090 + - supplierId: 693d3b961e744b02a6a260f4bada75b0 + supplierName: Matt Ager Test EU Supplier + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -6841.33 + details: + - name: BillCreditNotes + amount: -6841.33 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6841.33 + details: + - name: Bills + amount: 6841.33 + - supplierId: 1edf56c368e14a35a050b3e8336e2272 + supplierName: Mike B Commerce Test + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 300 + details: + - name: Bills + amount: 300 + - supplierId: c6d3fa5bf2634b148d0ee82b6fbb8fe3 + supplierName: my shop supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -120 + details: + - name: BillCreditNotes + amount: -120 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: cdeae2fcbe6447f698d2a59d68e4ad82 + supplierName: Nic Supp + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -36 + details: + - name: BillCreditNotes + amount: -36 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: 2e14c8cfee3041a4a5e8a619b336f900 + supplierName: Nic Supplies Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 30 + details: + - name: Bills + amount: 30 + - supplierId: c41981674176495f927f46ce663d46ac + supplierName: Ninetta Ponting + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -306 + details: + - name: BillPayments + amount: -306 + - supplierId: e2dd680fed99410982673f8fc2722357 + supplierName: Supplier 70 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -70 + details: + - name: BillPayments + amount: -70 + - supplierId: 8d61f7cd3a2f4ceea26ac5bca15e10da + supplierName: Supplier 71 (AUD) + agedCurrencyOutstanding: + - currency: AUD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -701 + details: + - name: BillPayments + amount: -701 + - supplierId: 7a67caeb261f40259f0948785090af0b + supplierName: supplier test + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12014.4 + details: + - name: Bills + amount: 12014.4 + - supplierId: d884f637bb3a4e589d640085b31ad6ee + supplierName: Tasty Treats Icecreams + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -454 + details: + - name: BillCreditNotes + amount: -454 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 456 + details: + - name: Bills + amount: 456 + - supplierId: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1152.78 + details: + - name: BillCreditNotes + amount: -1152.78 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 14960.37 + details: + - name: Bills + amount: 15064.41 + - name: BillPayments + amount: -104.04 + - supplierId: 2541e491791c485a96cc480cfde112d6 + supplierName: Test Supplier 2 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -50 + details: + - name: BillCreditNotes + amount: -50 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 63338524.47 + details: + - name: Bills + amount: 63338524.47 + - supplierId: 877aac191c3c40eda61115eea12641f7 + supplierName: Test Supplier 3 + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3535.61 + details: + - name: BillCreditNotes + amount: -3535.61 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 50658.58 + details: + - name: Bills + amount: 50658.58 + - supplierId: d98e7afb4ca846dfbb12ca285f95f863 + supplierName: Test Supplier 4 (US) + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 51872949 + details: + - name: Bills + amount: 51872949 + Sage Intacct: + value: + generated: '2023-05-02T16:05:22.9252709Z' + reportDate: '2023-05-02T16:05:22.8758390Z' + data: + - supplierId: '3' + supplierName: ADP + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 487.5 + details: + - name: Bills + amount: 487.5 + - supplierId: '14' + supplierName: Kristofferson Consulting + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7200 + details: + - name: Bills + amount: 7200 + - supplierId: '7' + supplierName: Lenovo + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 190 + details: + - name: Bills + amount: 190 + - supplierId: '8' + supplierName: Worldwide Commercial + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Bills + amount: 10 + Xero: + value: + generated: '2023-05-02T16:05:20.3006654Z' + reportDate: '2023-05-02T16:05:20.2587933Z' + data: + - supplierId: 699f0091-b127-4796-9f15-41a2f42abeb2 + supplierName: ABC Furniture + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1200 + details: + - name: Bills + amount: 1200 + - supplierId: 362819c9-f285-4d09-ac95-26327863adac + supplierName: Bayside Club + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 130 + details: + - name: Bills + amount: 130 + - supplierId: 2dc0ef7c-582f-4542-963b-dbdc069e4819 + supplierName: Bayside Wholesale + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 961.21 + details: + - name: Bills + amount: 961.21 + - supplierId: 51cbbfb0-8dc9-41aa-aad6-eb93b3cc40c6 + supplierName: Capital Cab Co + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 242 + details: + - name: Bills + amount: 242 + - supplierId: 3828f379-afa5-4b2a-9000-9c53d75ba1c6 + supplierName: Central Copiers + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1063.56 + details: + - name: Bills + amount: 1063.56 + - supplierId: 8a593982-291c-4ec3-9a42-3dbccbc6e3c8 + supplierName: MCO Cleaning Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 119.08 + details: + - name: Bills + amount: 119.08 + - supplierId: 97cc88ca-f89b-41f0-b8b9-e750b6f2f1d9 + supplierName: Net Connect + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 54.13 + details: + - name: Bills + amount: 54.13 + - supplierId: dec56ceb-65e9-43b3-ac98-7fe09eb37e31 + supplierName: PowerDirect + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 244.45 + details: + - name: Bills + amount: 244.45 + - supplierId: f5a77e82-50e3-4340-a6e0-13d6a482a08a + supplierName: SMART Agency + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4500 + details: + - name: Bills + amount: 4500 + - supplierId: 3a0d40a2-2698-4cf5-b7b2-30133c632ab6 + supplierName: Swanston Security + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 93.64 + details: + - name: Bills + amount: 93.64 + - supplierId: ac48c67d-3eea-44eb-96b1-9f7a89d9b761 + supplierName: Xero + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 56.35 + details: + - name: Bills + amount: 56.35 + - supplierId: 94a82e91-53da-4f87-a417-63d6a1607ced + supplierName: Young Bros Transport + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 125.03 + details: + - name: Bills + amount: 125.03 + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/financials/balanceSheet': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Financial statements + summary: Get balance sheet + description: Gets the latest balance sheet for a company. + operationId: get-accounting-balance-sheet + x-speakeasy-group: financial-statements.balance-sheet + parameters: + - $ref: '#/components/parameters/accountingPeriodLength' + - $ref: '#/components/parameters/accountingPeriodsToCompare' + - $ref: '#/components/parameters/accountingStartMonth' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBalanceSheet' + examples: + Clear Books: + value: + currency: GBP + reports: + - date: '2023-03-31T00:00:00' + assets: + accountId: '' + name: Assets + value: 4643976.27 + items: + - accountId: '' + name: Fixed Assets + value: 3930291.27 + items: + - accountId: 724ca578-8b5d-4bdb-ad45-e3820eee9de9 + name: Office Equipment + value: 2354838.89 + items: [] + - accountId: be3eb911-034b-42de-95db-0d58ac978b7f + name: Computer Equipment + value: 1575452.38 + items: [] + - accountId: '' + name: Current Assets + value: 713685 + items: + - accountId: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + name: Accounts Receivable + value: 66538.63 + items: [] + - accountId: 22de1660-d745-4809-a363-16b134607e66 + name: Prepayments + value: 27250.93 + items: [] + - accountId: e5d7612c-1671-47b4-b733-5db48363fcd0 + name: Inventory + value: 113157.44 + items: [] + - accountId: '' + name: Bank + value: 506738 + items: + - accountId: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + value: 506738 + items: [] + liabilities: + accountId: '' + name: Liabilities + value: 1183797.31 + items: + - accountId: '' + name: Current Liabilities + value: 544797.71 + items: + - accountId: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + name: VAT + value: 27683.3 + items: [] + - accountId: d19852a2-e292-4eb9-a909-9dadb95c0e76 + name: Rounding + value: 0 + items: [] + - accountId: 9be6382f-6b33-402d-b448-0db1dbf67a98 + name: Historical Adjustment + value: 8985.44 + items: [] + - accountId: 53bf27a7-7497-4c61-9887-dfaad5c6d80a + name: Accounts Payable + value: 36981.83 + items: [] + - accountId: 8852a857-aa9d-4706-839f-638e9d6b5a66 + name: Unpaid Expense Claims + value: 0 + items: [] + - accountId: 3b58f7ff-fa16-453a-9931-f020816d76e7 + name: Interest Payables + value: 1193.59 + items: [] + - accountId: 8636effc-50fb-45ba-8b2b-18336fa29b6b + name: John Smith + value: 1147.11 + items: [] + - accountId: e2530acd-91c8-48f8-a35f-935dbd7432e2 + name: Accruals + value: 439935.82 + items: [] + - accountId: 62060aae-e5a6-4db5-a3bb-6abec6d47959 + name: Credit Card Control Account + value: 28870.62 + items: [] + - accountId: '' + name: Long Term Liability + value: 638999.6 + items: + - accountId: 55008233-40e7-41ac-84af-2255fa028c2e + name: Loan + value: 638999.6 + items: [] + netAssets: 3460178.96 + equity: + accountId: '' + name: Equity + value: 3460178.96 + items: + - accountId: 39225d6f-3722-4508-ac3f-a2f6ec96ad31 + name: Retained Earnings + value: 3405201.39 + items: [] + - accountId: 78828dd9-6008-4662-b43c-e9d87907fd2b + name: Current Year Earnings + value: 54977.57 + items: [] + - date: '2023-02-28T00:00:00' + assets: + accountId: '' + name: Assets + value: 4599890.71 + items: + - accountId: '' + name: Fixed Assets + value: 3882793.51 + items: + - accountId: 724ca578-8b5d-4bdb-ad45-e3820eee9de9 + name: Office Equipment + value: 2036803.36 + items: [] + - accountId: be3eb911-034b-42de-95db-0d58ac978b7f + name: Computer Equipment + value: 1845990.15 + items: [] + - accountId: '' + name: Current Assets + value: 717097.2 + items: + - accountId: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + name: Accounts Receivable + value: 136245.44 + items: [] + - accountId: 22de1660-d745-4809-a363-16b134607e66 + name: Prepayments + value: 18719.25 + items: [] + - accountId: e5d7612c-1671-47b4-b733-5db48363fcd0 + name: Inventory + value: 146898.62 + items: [] + - accountId: '' + name: Bank + value: 415233.89 + items: + - accountId: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + value: 415233.89 + items: [] + liabilities: + accountId: '' + name: Liabilities + value: 1150262.51 + items: + - accountId: '' + name: Current Liabilities + value: 508579.57 + items: + - accountId: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + name: VAT + value: 22517.83 + items: [] + - accountId: d19852a2-e292-4eb9-a909-9dadb95c0e76 + name: Rounding + value: 0 + items: [] + - accountId: 9be6382f-6b33-402d-b448-0db1dbf67a98 + name: Historical Adjustment + value: 5994.86 + items: [] + - accountId: 53bf27a7-7497-4c61-9887-dfaad5c6d80a + name: Accounts Payable + value: 49993.06 + items: [] + - accountId: 8852a857-aa9d-4706-839f-638e9d6b5a66 + name: Unpaid Expense Claims + value: 0 + items: [] + - accountId: 3b58f7ff-fa16-453a-9931-f020816d76e7 + name: Interest Payables + value: 1424.88 + items: [] + - accountId: 8636effc-50fb-45ba-8b2b-18336fa29b6b + name: John Smith + value: 1863.01 + items: [] + - accountId: e2530acd-91c8-48f8-a35f-935dbd7432e2 + name: Accruals + value: 399839.88 + items: [] + - accountId: 62060aae-e5a6-4db5-a3bb-6abec6d47959 + name: Credit Card Control Account + value: 26946.05 + items: [] + - accountId: '' + name: Long Term Liability + value: 641682.94 + items: + - accountId: 55008233-40e7-41ac-84af-2255fa028c2e + name: Loan + value: 641682.94 + items: [] + netAssets: 3449628.2 + equity: + accountId: '' + name: Equity + value: 3449628.19 + items: + - accountId: 39225d6f-3722-4508-ac3f-a2f6ec96ad31 + name: Retained Earnings + value: 3405201.39 + items: [] + - accountId: 78828dd9-6008-4662-b43c-e9d87907fd2b + name: Current Year Earnings + value: 44426.8 + items: [] + mostRecentAvailableMonth: '2023-03-31T00:00:00' + earliestAvailableMonth: '2018-04-01T00:00:00' + Dynamics 365 Business Central: + value: + currency: GBP + reports: + - date: '2023-03-27T00:00:00' + assets: + name: Assets + value: 260454.26 + items: + - name: '' + value: 27.34 + items: + - accountId: c0861a65-c69f-ec11-80f1-0022481b4546 + name: 10 - Account no cat Balance Sheet + value: 27.34 + items: [] + - accountId: 9cc90e3e-843d-ed11-97e8-0022481b89f2 + name: 12345 - Income Statement and Asset + value: 0 + items: [] + - name: Equipment + value: 5504.37 + items: + - accountId: 5b9782f7-0fe7-ec11-82f9-0022481afc56 + name: 1350 - Iana test + value: 16 + items: [] + - accountId: 6c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40800 - Equipment + value: 5488.37 + items: [] + - name: Cash + value: 36998.49 + items: + - accountId: 5e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40100 - Checking account + value: -35824.11 + items: [] + - accountId: 601217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40200 - Savings account + value: 2802.59 + items: [] + - accountId: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40300 - Petty Cash + value: 70020.01 + items: [] + - accountId: 5c062318-3c59-ed11-8c36-002248c5e6c0 + name: 4544 - cash bal + value: 0 + items: [] + - name: Accounts Receivable + value: 189399.22 + items: + - accountId: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40400 - Accounts Receivable + value: 129008.09 + items: [] + - accountId: 9cb05c6f-9fbd-ed11-9a88-000d3a7ea13c + name: 40450 - test3 + value: 0 + items: [] + - accountId: 7a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46200 - Purchase VAT 20 % EU + value: -11635.12 + items: [] + - accountId: 7c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46210 - Purchase VAT 5 % EU + value: 0 + items: [] + - accountId: 7e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46300 - Purchase VAT 20 % + value: 71992.44 + items: [] + - accountId: 801217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46310 - Purchase VAT 5 % + value: 9.35 + items: [] + - accountId: 821217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46320 - Purchase Full VAT 5 % + value: 10 + items: [] + - accountId: 841217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46330 - Purchase Full VAT 20 % + value: 14.46 + items: [] + - accountId: 1bd1222e-94bd-ed11-9a88-6045bd0f961f + name: 9999 - BaleSales + value: 0 + items: [] + - name: Prepaid Expenses + value: -1040 + items: + - accountId: 661217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40500 - Prepaid Rent + value: 0 + items: [] + - accountId: 681217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40600 - Prepaid Insurance + value: -1040 + items: [] + - accountId: 781217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 41000 - Vendor Prepayments + value: 0 + items: [] + - name: Inventory + value: 26065.84 + items: + - accountId: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40700 - Inventory + value: 26065.84 + items: [] + - name: Accumulated Depreciation + value: 3499 + items: + - accountId: 6e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40900 - Accumulated Depreciation + value: 3499 + items: [] + - name: Assets + value: 0 + items: + - accountId: 701217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40910 - WIP Job Sales + value: 0 + items: [] + - accountId: 721217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40920 - Invoiced Job Sales + value: 0 + items: [] + - accountId: 741217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40940 - Accrued Job Costs + value: 0 + items: [] + - accountId: 761217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40950 - WIP Job Costs + value: 0 + items: [] + liabilities: + name: Liabilities + value: 99721.85 + items: + - name: Current Liabilities + value: 99735.85 + items: + - accountId: 8a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50100 - Accounts Payable + value: 42435.31 + items: [] + - accountId: 8c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50200 - Purchase Discounts + value: 210.22 + items: [] + - accountId: 8e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50300 - Purchase Returns & Allowances + value: 0 + items: [] + - accountId: 901217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50400 - Deferred Revenue + value: 0 + items: [] + - accountId: 921217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50500 - Credit Cards + value: 0 + items: [] + - accountId: 9e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 52000 - Customer Prepayments + value: 0 + items: [] + - accountId: a01217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56100 - Sales VAT 20 % + value: 57906.98 + items: [] + - accountId: a21217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56110 - Sales VAT 5 % + value: -816.66 + items: [] + - accountId: a41217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56120 - Sales Full VAT 5 % + value: 0 + items: [] + - accountId: a61217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56130 - Sales Full VAT 20 % + value: 0 + items: [] + - accountId: a81217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56140 - VAT Payable + value: 0 + items: [] + - name: Payroll Liabilities + value: -14 + items: + - accountId: 941217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50700 - Accrued Salaries & Wages + value: 0 + items: [] + - accountId: 961217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51400 - Employee Benefits Payable + value: 0 + items: [] + - accountId: 981217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51500 - Holiday Compensation Payable + value: 7 + items: [] + - accountId: 9a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51600 - Employees Payable + value: -21 + items: [] + - name: Long Term Liabilities + value: 0 + items: + - accountId: 9c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51900 - Notes Payable + value: 0 + items: [] + netAssets: 160732.41 + equity: + name: Equity + value: 160732.41 + items: + - name: Common Stock + value: 19988.72 + items: + - accountId: aa1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60100 - Share Capital + value: 19988.72 + items: [] + - name: Retained Earnings + value: 69723.14 + items: + - accountId: ac1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60200 - Retained Earnings + value: 69723.14 + items: [] + - name: Dividends + value: 0 + items: + - accountId: b01217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60300 - Dividends + value: 0 + items: [] + - accountId: NO-ID-EARNINGS-SO-FAR + name: Earnings so far + value: 71020.55 + items: [] + - date: '2023-02-28T00:00:00' + assets: + name: Assets + value: 262531.32 + items: + - name: '' + value: 27.34 + items: + - accountId: c0861a65-c69f-ec11-80f1-0022481b4546 + name: 10 - Account no cat Balance Sheet + value: 27.34 + items: [] + - accountId: 9cc90e3e-843d-ed11-97e8-0022481b89f2 + name: 12345 - Income Statement and Asset + value: 0 + items: [] + - name: Equipment + value: 5504.37 + items: + - accountId: 5b9782f7-0fe7-ec11-82f9-0022481afc56 + name: 1350 - Iana test + value: 16 + items: [] + - accountId: 6c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40800 - Equipment + value: 5488.37 + items: [] + - name: Cash + value: 37693.84 + items: + - accountId: 5e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40100 - Checking account + value: -35778.16 + items: [] + - accountId: 601217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40200 - Savings account + value: 2802.59 + items: [] + - accountId: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40300 - Petty Cash + value: 70669.41 + items: [] + - accountId: 5c062318-3c59-ed11-8c36-002248c5e6c0 + name: 4544 - cash bal + value: 0 + items: [] + - name: Accounts Receivable + value: 188021.29 + items: + - accountId: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40400 - Accounts Receivable + value: 127634.34 + items: [] + - accountId: 9cb05c6f-9fbd-ed11-9a88-000d3a7ea13c + name: 40450 - test3 + value: 0 + items: [] + - accountId: 7a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46200 - Purchase VAT 20 % EU + value: -11635.12 + items: [] + - accountId: 7c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46210 - Purchase VAT 5 % EU + value: 0 + items: [] + - accountId: 7e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46300 - Purchase VAT 20 % + value: 71988.26 + items: [] + - accountId: 801217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46310 - Purchase VAT 5 % + value: 9.35 + items: [] + - accountId: 821217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46320 - Purchase Full VAT 5 % + value: 10 + items: [] + - accountId: 841217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46330 - Purchase Full VAT 20 % + value: 14.46 + items: [] + - accountId: 1bd1222e-94bd-ed11-9a88-6045bd0f961f + name: 9999 - BaleSales + value: 0 + items: [] + - name: Prepaid Expenses + value: -1040 + items: + - accountId: 661217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40500 - Prepaid Rent + value: 0 + items: [] + - accountId: 681217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40600 - Prepaid Insurance + value: -1040 + items: [] + - accountId: 781217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 41000 - Vendor Prepayments + value: 0 + items: [] + - name: Inventory + value: 28825.48 + items: + - accountId: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40700 - Inventory + value: 28825.48 + items: [] + - name: Accumulated Depreciation + value: 3499 + items: + - accountId: 6e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40900 - Accumulated Depreciation + value: 3499 + items: [] + - name: Assets + value: 0 + items: + - accountId: 701217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40910 - WIP Job Sales + value: 0 + items: [] + - accountId: 721217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40920 - Invoiced Job Sales + value: 0 + items: [] + - accountId: 741217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40940 - Accrued Job Costs + value: 0 + items: [] + - accountId: 761217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40950 - WIP Job Costs + value: 0 + items: [] + liabilities: + name: Liabilities + value: 99680 + items: + - name: Current Liabilities + value: 99694 + items: + - accountId: 8a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50100 - Accounts Payable + value: 42459.31 + items: [] + - accountId: 8c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50200 - Purchase Discounts + value: 210.22 + items: [] + - accountId: 8e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50300 - Purchase Returns & Allowances + value: 0 + items: [] + - accountId: 901217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50400 - Deferred Revenue + value: 0 + items: [] + - accountId: 921217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50500 - Credit Cards + value: 0 + items: [] + - accountId: 9e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 52000 - Customer Prepayments + value: 0 + items: [] + - accountId: a01217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56100 - Sales VAT 20 % + value: 57841.13 + items: [] + - accountId: a21217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56110 - Sales VAT 5 % + value: -816.66 + items: [] + - accountId: a41217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56120 - Sales Full VAT 5 % + value: 0 + items: [] + - accountId: a61217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56130 - Sales Full VAT 20 % + value: 0 + items: [] + - accountId: a81217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56140 - VAT Payable + value: 0 + items: [] + - name: Payroll Liabilities + value: -14 + items: + - accountId: 941217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50700 - Accrued Salaries & Wages + value: 0 + items: [] + - accountId: 961217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51400 - Employee Benefits Payable + value: 0 + items: [] + - accountId: 981217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51500 - Holiday Compensation Payable + value: 7 + items: [] + - accountId: 9a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51600 - Employees Payable + value: -21 + items: [] + - name: Long Term Liabilities + value: 0 + items: + - accountId: 9c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51900 - Notes Payable + value: 0 + items: [] + netAssets: 162851.32 + equity: + name: Equity + value: 162851.32 + items: + - name: Common Stock + value: 19988.72 + items: + - accountId: aa1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60100 - Share Capital + value: 19988.72 + items: [] + - name: Retained Earnings + value: 69723.14 + items: + - accountId: ac1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60200 - Retained Earnings + value: 69723.14 + items: [] + - name: Dividends + value: 0 + items: + - accountId: b01217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60300 - Dividends + value: 0 + items: [] + - accountId: NO-ID-EARNINGS-SO-FAR + name: Earnings so far + value: 73139.46 + items: [] + mostRecentAvailableMonth: '2023-03-31T00:00:00' + earliestAvailableMonth: '2022-09-01T00:00:00' + Exact (Netherlands): + value: + reports: [] + Exact (UK): + value: + currency: GBP + reports: + - date: '2022-10-31T00:00:00Z' + assets: + name: Assets + value: -2 + items: + - accountId: cf9572e7-8afa-4339-9113-af32a66d9df9 + name: 15400 - Trade Debtors + value: -3 + items: [] + - accountId: ba382d88-a4e5-4117-8fc6-4752ee8bc93d + name: 15801 - Standard account + value: 1 + items: [] + liabilities: + name: Liabilities + value: 0 + items: [] + netAssets: -2 + equity: + name: Equities + value: -2 + items: + - accountId: PROFIT-AND-LOSS + name: Profit for this period + value: -2 + items: [] + - date: '2022-09-30T00:00:00Z' + assets: + name: Assets + value: 208 + items: + - accountId: 885ff551-664d-451b-995b-cb114c9877d0 + name: 15890 - Unallocated Cash + value: 0 + items: [] + - accountId: cf9572e7-8afa-4339-9113-af32a66d9df9 + name: 15400 - Trade Debtors + value: 78 + items: [] + - accountId: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: 15880 - Bank + value: 130 + items: [] + liabilities: + name: Liabilities + value: 0 + items: + - accountId: 88d733a8-51e1-4ee7-b2a0-fb49879e36cc + name: 21000 - Trade Creditors + value: 0 + items: [] + netAssets: 208 + equity: + name: Equities + value: 208 + items: + - accountId: PROFIT-AND-LOSS + name: Profit for this period + value: 208 + items: [] + mostRecentAvailableMonth: '2022-10-31T00:00:00' + earliestAvailableMonth: '2022-04-01T00:00:00' + FreshBooks: + value: + currency: GBP + reports: + - date: '2023-04-30T00:00:00' + assets: + name: assets + value: 38416.28 + items: + - accountId: '167679' + name: Cash + value: -3011.5 + items: + - accountId: '291721' + name: Petty Cash + value: -3022.5 + items: [] + - accountId: '3427097' + name: Cash + value: 11 + items: [] + - accountId: '67357' + name: Accounts Receivable + value: 41445.53 + items: + - accountId: '128611' + name: Accounts Receivable + value: 41445.53 + items: [] + - accountId: '2761661' + name: Current Asset + value: -11 + items: + - accountId: '3420060' + name: Prepaid Expenses + value: -11 + items: [] + - accountId: '2288207' + name: 'Property, Plant, and Equipment' + value: -6.75 + items: + - accountId: '2792069' + name: Office Equipment + value: -6.75 + items: [] + liabilities: + name: liabilities + value: 9310.72 + items: + - accountId: '2288209' + name: Accounts Payable + value: 460.39 + items: + - accountId: '3385145' + name: Accounts Payable + value: 460.39 + items: [] + - accountId: '67361' + name: Taxes Payable + value: 36.75 + items: + - accountId: '128615' + name: VAT + value: -108.9 + items: [] + - accountId: '3380553' + name: Customs Duty + value: -2.5 + items: [] + - accountId: '3380555' + name: Excise Duty + value: -54.45 + items: [] + - accountId: '3384241' + name: tax 50 + value: 0.7 + items: [] + - accountId: '3384293' + name: helloabdul + value: 86.03 + items: [] + - accountId: '3384425' + name: hello2 + value: 114.76 + items: [] + - accountId: '3420099' + name: VAT1 + value: 1.11 + items: [] + - accountId: '237025' + name: Customer Credit + value: 8813.58 + items: + - accountId: '392937' + name: Customer Credit + value: 8813.58 + items: [] + netAssets: 29105.56 + equity: + name: equity + value: 29105.56 + items: + - accountId: '' + name: Net Income + value: 29105.56 + items: [] + - date: '2023-03-31T00:00:00' + assets: + name: assets + value: 38416.28 + items: + - accountId: '167679' + name: Cash + value: -3011.5 + items: + - accountId: '291721' + name: Petty Cash + value: -3022.5 + items: [] + - accountId: '3427097' + name: Cash + value: 11 + items: [] + - accountId: '67357' + name: Accounts Receivable + value: 41445.53 + items: + - accountId: '128611' + name: Accounts Receivable + value: 41445.53 + items: [] + - accountId: '2761661' + name: Current Asset + value: -11 + items: + - accountId: '3420060' + name: Prepaid Expenses + value: -11 + items: [] + - accountId: '2288207' + name: 'Property, Plant, and Equipment' + value: -6.75 + items: + - accountId: '2792069' + name: Office Equipment + value: -6.75 + items: [] + liabilities: + name: liabilities + value: 9310.72 + items: + - accountId: '2288209' + name: Accounts Payable + value: 460.39 + items: + - accountId: '3385145' + name: Accounts Payable + value: 460.39 + items: [] + - accountId: '67361' + name: Taxes Payable + value: 36.75 + items: + - accountId: '128615' + name: VAT + value: -108.9 + items: [] + - accountId: '3380553' + name: Customs Duty + value: -2.5 + items: [] + - accountId: '3380555' + name: Excise Duty + value: -54.45 + items: [] + - accountId: '3384241' + name: tax 50 + value: 0.7 + items: [] + - accountId: '3384293' + name: helloabdul + value: 86.03 + items: [] + - accountId: '3384425' + name: hello2 + value: 114.76 + items: [] + - accountId: '3420099' + name: VAT1 + value: 1.11 + items: [] + - accountId: '237025' + name: Customer Credit + value: 8813.58 + items: + - accountId: '392937' + name: Customer Credit + value: 8813.58 + items: [] + netAssets: 29105.56 + equity: + name: equity + value: 29105.56 + items: + - accountId: '' + name: Net Income + value: 29105.56 + items: [] + mostRecentAvailableMonth: '2023-04-30T00:00:00' + earliestAvailableMonth: '2022-10-01T00:00:00' + KashFlow: + value: + currency: GBP + reports: + - date: '2022-09-30T00:00:00' + assets: + name: Assets + value: 109979.14 + items: + - name: Fixed Assets + value: 923.62 + items: + - accountId: '29362903' + name: FIXED ASSET CODE (SALES) + value: -100 + items: [] + - accountId: '29362906' + name: FIXED ASSET CODE (OUTGOING) + value: 1006 + items: [] + - accountId: '29358753' + name: TESTCODE + value: 9.29 + items: [] + - accountId: '21481884' + name: Computer equipment cost + value: 8.33 + items: [] + - name: Current Assets + value: 109055.52 + items: + - accountId: '21481886' + name: Trade debtors + value: 67166.51 + items: [] + - accountId: '636062' + name: Current account + value: 425.33 + items: [] + - accountId: '680495' + name: Test Account + value: 38003 + items: [] + - accountId: '684416' + name: Tide Account 2 + value: 303.22 + items: [] + - accountId: '684418' + name: New Tide Account + value: 303.22 + items: [] + - accountId: '686687' + name: Pete Test 02/05 + value: 301.64 + items: [] + - accountId: '696204' + name: Go Live + value: 9 + items: [] + - accountId: '696740' + name: Production Test + value: 0.08 + items: [] + - accountId: '707236' + name: Dave Push Test uat + value: 123.41 + items: [] + - accountId: '707240' + name: Dave Push Test integ + value: 139.54 + items: [] + - accountId: '813944' + name: Please dont balance + value: 110 + items: [] + - accountId: '765768' + name: 16th Account + value: 326 + items: [] + - accountId: '809283' + name: abduls company credit card + value: 13.85 + items: [] + - accountId: '809318' + name: ASSET ACCOUNT + value: 110 + items: [] + - accountId: '776582' + name: VandanaKasAcc1 + value: 20 + items: [] + - accountId: '780580' + name: ABRAHAM2 + value: 40 + items: [] + - accountId: '780605' + name: AbeVanTest3 + value: 10 + items: [] + - accountId: '780619' + name: VandanaAccTest4 + value: 92.63 + items: [] + - accountId: '780669' + name: NewXeroAccount10 + value: 21 + items: [] + - accountId: '780672' + name: NewKasAccount10 + value: 111 + items: [] + - accountId: '809742' + name: HSBBBBB + value: 111 + items: [] + - accountId: '833089' + name: AAAAA + value: 260 + items: [] + - accountId: '21481890' + name: Output VAT + value: 511.04 + items: [] + - accountId: '21481891' + name: Input VAT + value: 504.05 + items: [] + - accountId: '21481895' + name: CIS deductions + value: 40 + items: [] + liabilities: + name: Liabilities + value: 80187.1 + items: + - name: Current Liabilities + value: 80187.1 + items: + - accountId: '21481902' + name: Other + value: 43799.56 + items: [] + - accountId: '21481888' + name: Cash in hand + value: 317.07 + items: [] + - accountId: '612964' + name: Bank account + value: 33011.08 + items: [] + - accountId: '687106' + name: May 4th Account + value: 926.81 + items: [] + - accountId: '21481892' + name: VAT control account + value: 322 + items: [] + - accountId: '21481893' + name: Trade creditors + value: 1618.27 + items: [] + - accountId: '29553868' + name: Creditors Control Account + value: 192.31 + items: [] + netAssets: 29792.04 + equity: + name: Equity + value: 29792.05 + items: + - name: Capital and Reserves + value: 29792.05 + items: + - accountId: '21481901' + name: Retained profit/loss + value: 31402.01 + items: [] + - accountId: '0' + name: P&L Account + value: -1609.96 + items: [] + - date: '2022-08-31T00:00:00' + assets: + name: Assets + value: 109979.14 + items: + - name: Fixed Assets + value: 923.62 + items: + - accountId: '29362903' + name: FIXED ASSET CODE (SALES) + value: -100 + items: [] + - accountId: '29362906' + name: FIXED ASSET CODE (OUTGOING) + value: 1006 + items: [] + - accountId: '29358753' + name: TESTCODE + value: 9.29 + items: [] + - accountId: '21481884' + name: Computer equipment cost + value: 8.33 + items: [] + - name: Current Assets + value: 109055.52 + items: + - accountId: '21481886' + name: Trade debtors + value: 67166.51 + items: [] + - accountId: '636062' + name: Current account + value: 425.33 + items: [] + - accountId: '680495' + name: Test Account + value: 38003 + items: [] + - accountId: '684416' + name: Tide Account 2 + value: 303.22 + items: [] + - accountId: '684418' + name: New Tide Account + value: 303.22 + items: [] + - accountId: '686687' + name: Pete Test 02/05 + value: 301.64 + items: [] + - accountId: '696204' + name: Go Live + value: 9 + items: [] + - accountId: '696740' + name: Production Test + value: 0.08 + items: [] + - accountId: '707236' + name: Dave Push Test uat + value: 123.41 + items: [] + - accountId: '707240' + name: Dave Push Test integ + value: 139.54 + items: [] + - accountId: '813944' + name: Please dont balance + value: 110 + items: [] + - accountId: '765768' + name: 16th Account + value: 326 + items: [] + - accountId: '809283' + name: abduls company credit card + value: 13.85 + items: [] + - accountId: '809318' + name: ASSET ACCOUNT + value: 110 + items: [] + - accountId: '776582' + name: VandanaKasAcc1 + value: 20 + items: [] + - accountId: '780580' + name: ABRAHAM2 + value: 40 + items: [] + - accountId: '780605' + name: AbeVanTest3 + value: 10 + items: [] + - accountId: '780619' + name: VandanaAccTest4 + value: 92.63 + items: [] + - accountId: '780669' + name: NewXeroAccount10 + value: 21 + items: [] + - accountId: '780672' + name: NewKasAccount10 + value: 111 + items: [] + - accountId: '809742' + name: HSBBBBB + value: 111 + items: [] + - accountId: '833089' + name: AAAAA + value: 260 + items: [] + - accountId: '21481890' + name: Output VAT + value: 511.04 + items: [] + - accountId: '21481891' + name: Input VAT + value: 504.05 + items: [] + - accountId: '21481895' + name: CIS deductions + value: 40 + items: [] + liabilities: + name: Liabilities + value: 80187.1 + items: + - name: Current Liabilities + value: 80187.1 + items: + - accountId: '21481902' + name: Other + value: 43799.56 + items: [] + - accountId: '21481888' + name: Cash in hand + value: 317.07 + items: [] + - accountId: '612964' + name: Bank account + value: 33011.08 + items: [] + - accountId: '687106' + name: May 4th Account + value: 926.81 + items: [] + - accountId: '21481892' + name: VAT control account + value: 322 + items: [] + - accountId: '21481893' + name: Trade creditors + value: 1618.27 + items: [] + - accountId: '29553868' + name: Creditors Control Account + value: 192.31 + items: [] + netAssets: 29792.04 + equity: + name: Equity + value: 29792.05 + items: + - name: Capital and Reserves + value: 29792.05 + items: + - accountId: '21481901' + name: Retained profit/loss + value: 31402.01 + items: [] + - accountId: '0' + name: P&L Account + value: -1609.96 + items: [] + mostRecentAvailableMonth: '2022-09-30T00:00:00' + earliestAvailableMonth: '2022-03-01T00:00:00' + MYOB AccountRight and Essentials: + value: + currency: GBP + reports: + - date: '2022-11-30T00:00:00' + assets: + name: Assets + value: 0 + items: [] + liabilities: + name: Liabilities + value: 0 + items: [] + netAssets: 0 + equity: + name: Equity + value: 0 + items: [] + - date: '2022-10-31T00:00:00' + assets: + name: Assets + value: 0 + items: [] + liabilities: + name: Liabilities + value: 0 + items: [] + netAssets: 0 + equity: + name: Equity + value: 0 + items: [] + mostRecentAvailableMonth: '2022-11-30T00:00:00' + earliestAvailableMonth: '2022-05-01T00:00:00' + Oracle NetSuite: + value: + currency: GBP + reports: + - date: '2023-05-31T00:00:00' + assets: + accountId: '' + name: Assets + value: 703 + items: + - accountId: '119' + name: Accounts Receivable + value: -565 + items: [] + - accountId: '122' + name: Undeposited Funds + value: 10 + items: [] + - accountId: '211' + name: VAT on Purchases + value: 24 + items: [] + - accountId: '716' + name: Inventory In Transit + value: 120 + items: [] + - accountId: '825' + name: Codat Europe Bank + value: 558.22 + items: + - accountId: '825' + name: Codat Europe Bank + value: 558.22 + items: [] + - accountId: '844' + name: Asset account test 2 + value: 555.78 + items: + - accountId: '844' + name: Asset account test 2 + value: 555.78 + items: [] + liabilities: + accountId: '' + name: Liabilities + value: 635.55 + items: + - accountId: '111' + name: Accounts Payable + value: 635.55 + items: + - accountId: '111' + name: Accounts Payable + value: 635.55 + items: [] + netAssets: 67.45 + equity: + accountId: '' + name: Equity + value: 67.45 + items: + - accountId: '851' + name: Demo account equity + value: -11 + items: [] + - name: Net Income + value: 78.45 + items: [] + - date: '2023-04-30T00:00:00' + assets: + accountId: '' + name: Assets + value: 703 + items: + - accountId: '119' + name: Accounts Receivable + value: -565 + items: [] + - accountId: '122' + name: Undeposited Funds + value: 10 + items: [] + - accountId: '211' + name: VAT on Purchases + value: 24 + items: [] + - accountId: '716' + name: Inventory In Transit + value: 120 + items: [] + - accountId: '825' + name: Codat Europe Bank + value: 558.22 + items: + - accountId: '825' + name: Codat Europe Bank + value: 558.22 + items: [] + - accountId: '844' + name: Asset account test 2 + value: 555.78 + items: + - accountId: '844' + name: Asset account test 2 + value: 555.78 + items: [] + liabilities: + accountId: '' + name: Liabilities + value: 635.55 + items: + - accountId: '111' + name: Accounts Payable + value: 635.55 + items: + - accountId: '111' + name: Accounts Payable + value: 635.55 + items: [] + netAssets: 67.45 + equity: + accountId: '' + name: Equity + value: 67.45 + items: + - accountId: '851' + name: Demo account equity + value: -11 + items: [] + - name: Net Income + value: 78.45 + items: [] + mostRecentAvailableMonth: '2023-05-31T00:00:00' + earliestAvailableMonth: '2022-11-01T00:00:00' + QuickBooks Desktop: + value: + currency: GBP + reports: + - date: '2023-04-30T00:00:00' + assets: + name: ASSETS + value: 549695.86 + items: + - name: Current Assets + value: 81821.64 + items: + - name: Checking/Savings + value: 57007.53 + items: + - accountId: 20000-933270541 + name: 10100 � Checking + value: 40814.11 + items: [] + - accountId: 30000-933270541 + name: 10300 � Savings + value: 15693.42 + items: [] + - accountId: 550001-1071509830 + name: 10400 � Petty Cash + value: 500 + items: [] + - name: Accounts Receivable + value: 7719.99 + items: + - accountId: 40000-933270541 + name: 11000 � Accounts Receivable + value: 7719.99 + items: [] + - name: Other Current Assets + value: 17094.12 + items: + - accountId: 60000-933270541 + name: 12100 � Inventory Asset + value: 13177.4 + items: [] + - accountId: 50000-933270541 + name: 12800 � Employee Advances + value: 770 + items: [] + - accountId: 370001-1071514466 + name: 13100 � Pre-paid Insurance + value: 1350 + items: [] + - accountId: 70000-933270541 + name: 13400 � Retainage Receivable + value: 1796.72 + items: [] + - name: Fixed Assets + value: 466154.22 + items: + - accountId: 5F0000-1197755449 + name: 15000 � Furniture and Equipment + value: 22826 + items: [] + - accountId: 90000-933270541 + name: 15100 � Vehicles + value: 78936.91 + items: [] + - accountId: 600000-1197756365 + name: 15200 � Buildings and Improvements + value: 325000 + items: [] + - accountId: 590000-1071511920 + name: 15300 � Construction Equipment + value: 15300 + items: [] + - accountId: 610000-1197756496 + name: 16900 � Land + value: 90000 + items: [] + - accountId: 620000-1197756666 + name: 17000 � Accumulated Depreciation + value: -65908.69 + items: [] + - name: Other Assets + value: 1720 + items: + - accountId: 80000063-1197709076 + name: 18700 � Security Deposits + value: 1720 + items: [] + liabilities: + name: Liabilities + value: 451499.2 + items: + - name: Current Liabilities + value: 6718.02 + items: + - name: Accounts Payable + value: 5000 + items: + - accountId: C0000-933270541 + name: 20000 � Accounts Payable + value: 5000 + items: [] + - name: Credit Cards + value: 1400 + items: + - accountId: 570000-1071509253 + name: 20500 � QuickBooks Credit Card + value: 1400 + items: [] + - name: Other Current Liabilities + value: 318.02 + items: + - accountId: 100000-933270541 + name: 25500 � Sales Tax Payable + value: 318.02 + items: [] + - name: Long Term Liabilities + value: 444781.18 + items: + - accountId: 120000-933270541 + name: 23000 � Loan - Vehicles (Van) + value: 19932.64 + items: [] + - accountId: 80000075-1197719780 + name: 23100 � Loan - Vehicles (Utility Truck) + value: 19936.91 + items: [] + - accountId: 80000076-1197719828 + name: 23200 � Loan - Vehicles (Pickup Truck) + value: 22641 + items: [] + - accountId: 5B0000-1197774305 + name: 28100 � Loan - Construction Equipment + value: 14343.11 + items: [] + - accountId: 80000068-1197710590 + name: 28200 � Loan - Furniture/Office Equip + value: 21000 + items: [] + - accountId: 8000008F-1197954502 + name: 28700 � Note Payable - Bank of Anycity + value: 50644.52 + items: [] + - accountId: 80000067-1197709946 + name: 28900 � Mortgage - Office Building + value: 296283 + items: [] + netAssets: 98196.66 + equity: + name: Equity + value: 98196.66 + items: + - accountId: 10000-933270541 + name: 30000 � Opening Bal Equity + value: 38773.75 + items: [] + - accountId: 80000066-1197709715 + name: 30100 � Capital Stock + value: 500 + items: [] + - accountId: 160000-933270541 + name: 32000 � Retained Earnings + value: 36213.97 + items: [] + - name: Net Income + value: 22708.94 + items: [] + - date: '2023-03-31T00:00:00' + assets: + name: ASSETS + value: 547971.05 + items: + - name: Current Assets + value: 80096.83 + items: + - name: Checking/Savings + value: 45769.39 + items: + - accountId: 20000-933270541 + name: 10100 � Checking + value: 29575.97 + items: [] + - accountId: 30000-933270541 + name: 10300 � Savings + value: 15693.42 + items: [] + - accountId: 550001-1071509830 + name: 10400 � Petty Cash + value: 500 + items: [] + - name: Accounts Receivable + value: 16228.47 + items: + - accountId: 40000-933270541 + name: 11000 � Accounts Receivable + value: 16228.47 + items: [] + - name: Other Current Assets + value: 18098.97 + items: + - accountId: 60000-933270541 + name: 12100 � Inventory Asset + value: 13507.25 + items: [] + - accountId: 50000-933270541 + name: 12800 � Employee Advances + value: 770 + items: [] + - accountId: 370001-1071514466 + name: 13100 � Pre-paid Insurance + value: 2025 + items: [] + - accountId: 70000-933270541 + name: 13400 � Retainage Receivable + value: 1796.72 + items: [] + - name: Fixed Assets + value: 466154.22 + items: + - accountId: 5F0000-1197755449 + name: 15000 � Furniture and Equipment + value: 22826 + items: [] + - accountId: 90000-933270541 + name: 15100 � Vehicles + value: 78936.91 + items: [] + - accountId: 600000-1197756365 + name: 15200 � Buildings and Improvements + value: 325000 + items: [] + - accountId: 590000-1071511920 + name: 15300 � Construction Equipment + value: 15300 + items: [] + - accountId: 610000-1197756496 + name: 16900 � Land + value: 90000 + items: [] + - accountId: 620000-1197756666 + name: 17000 � Accumulated Depreciation + value: -65908.69 + items: [] + - name: Other Assets + value: 1720 + items: + - accountId: 80000063-1197709076 + name: 18700 � Security Deposits + value: 1720 + items: [] + liabilities: + name: Liabilities + value: 453300.75 + items: + - name: Current Liabilities + value: 5714 + items: + - name: Accounts Payable + value: 5714 + items: + - accountId: C0000-933270541 + name: 20000 � Accounts Payable + value: 5714 + items: [] + - name: Long Term Liabilities + value: 447586.75 + items: + - accountId: 120000-933270541 + name: 23000 � Loan - Vehicles (Van) + value: 20376.27 + items: [] + - accountId: 80000075-1197719780 + name: 23100 � Loan - Vehicles (Utility Truck) + value: 19936.91 + items: [] + - accountId: 80000076-1197719828 + name: 23200 � Loan - Vehicles (Pickup Truck) + value: 22641 + items: [] + - accountId: 5B0000-1197774305 + name: 28100 � Loan - Construction Equipment + value: 14343.11 + items: [] + - accountId: 80000068-1197710590 + name: 28200 � Loan - Furniture/Office Equip + value: 21000 + items: [] + - accountId: 8000008F-1197954502 + name: 28700 � Note Payable - Bank of Anycity + value: 53006.46 + items: [] + - accountId: 80000067-1197709946 + name: 28900 � Mortgage - Office Building + value: 296283 + items: [] + netAssets: 94670.3 + equity: + name: Equity + value: 94670.3 + items: + - accountId: 10000-933270541 + name: 30000 � Opening Bal Equity + value: 38773.75 + items: [] + - accountId: 80000066-1197709715 + name: 30100 � Capital Stock + value: 500 + items: [] + - accountId: 160000-933270541 + name: 32000 � Retained Earnings + value: 36213.97 + items: [] + - name: Net Income + value: 19182.58 + items: [] + mostRecentAvailableMonth: '2023-04-30T00:00:00' + earliestAvailableMonth: '2022-10-01T00:00:00' + QuickBooks Online Sandbox: + value: + currency: GBP + reports: + - date: '2023-04-30T00:00:00' + assets: + name: Assets + value: 3856584.88 + items: + - name: Fixed Asset + value: 2766.17 + items: + - accountId: '3' + name: Accumulated Depreciation + value: -399.96 + items: [] + - accountId: '5' + name: Furniture and Equipment + value: 2750 + items: [] + - accountId: '7' + name: Leasehold Improvements + value: -99.12 + items: [] + - accountId: '9' + name: Vehicles + value: 515.25 + items: [] + - name: Bank + value: 520021.91 + items: + - accountId: '114' + name: 0983741 SamplePushBankAccount2 + value: 40.5 + items: [] + - accountId: '175' + name: 1 Push-FrontDoor-Test-1 + value: 112 + items: [] + - accountId: '134' + name: 1001001 Revenue + value: -235.34 + items: [] + - accountId: '110' + name: 101 Push Refactor Test + value: -149.4 + items: [] + - accountId: '102' + name: 10101 IntegrationTest + value: -1444.14 + items: [] + - accountId: '103' + name: 101011 testdemo1 + value: 18.6 + items: [] + - accountId: '104' + name: 101012 Dave Test + value: -5.4 + items: [] + - accountId: '105' + name: 101013 Push Test + value: 5.4 + items: [] + - accountId: '107' + name: 11 aaa + value: 23610.49 + items: [] + - accountId: '115' + name: '1111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111' + value: -9000.81 + items: [] + - accountId: '100' + name: 1131 Savings2 + value: 30281.54 + items: [] + - accountId: '109' + name: 122 Generic Push Test + value: -1079.05 + items: [] + - accountId: '101' + name: 123 Test Savings + value: 2293.37 + items: [] + - accountId: '111' + name: 123123 Steve Test + value: -1104.2 + items: [] + - accountId: '124' + name: 123175 Nominal Card + value: -2013.04 + items: [] + - accountId: '137' + name: 1232 test 55 + value: 1.29 + items: [] + - accountId: '122' + name: 1234567 Card3million + value: -85 + items: [] + - accountId: '176' + name: 12345671 testName_1 + value: 17546.08 + items: [] + - accountId: '165' + name: 123564 Huws testing name + value: -2 + items: [] + - accountId: '159' + name: 1533465364 Huws test name + value: 282.21 + items: [] + - accountId: '161' + name: 160894 Tom Automated Tests ExpensesAccount + value: -15900.6 + items: [] + - accountId: '108' + name: 19191 New Push Operation Test + value: 317.54 + items: [] + - accountId: '139' + name: 2501 Barclays + value: 211127.4 + items: [] + - accountId: '140' + name: 2502 HSBC + value: 109500.4 + items: [] + - accountId: '141' + name: 2503 BoA + value: 128050.89 + items: [] + - accountId: '138' + name: 4234 test55 + value: -29.28 + items: [] + - accountId: '106' + name: aa aa + value: -5.4 + items: [] + - accountId: '129' + name: Account Test 11 + value: 33.93 + items: [] + - accountId: '147' + name: Bank EUR + value: 188.5 + items: [] + - accountId: '173' + name: Cash on hand + value: 2655 + items: [] + - accountId: '178' + name: Citi + value: 189.11 + items: [] + - accountId: '81' + name: Current + value: 24513.64 + items: [] + - accountId: '177' + name: HSBC HKD + value: -39.39 + items: [] + - accountId: '169' + name: Matt Ager Test UI Parent Account + value: 75 + items: [] + - accountId: '89' + name: TestBankAccount_1 + value: 272.07 + items: [] + - name: Accounts Receivable + value: 3074459.19 + items: + - accountId: '70' + name: Debtors + value: 3041138.07 + items: [] + - accountId: '80' + name: Debtors - USD + value: 33315.2 + items: [] + - accountId: '125' + name: Debtors 2 + value: -7.45 + items: [] + - accountId: '88' + name: TestBankAccount + value: 13.37 + items: [] + - name: Other Current Asset + value: 259337.61 + items: + - accountId: '98' + name: Account_001 + value: 545.86 + items: [] + - accountId: '185' + name: Loans To Officers + value: 1200 + items: [] + - accountId: '179' + name: Loans to Others + value: 58.2 + items: [] + - accountId: '171' + name: Matt Ager Test UI Parent Account 1 + value: 11 + items: [] + - accountId: '168' + name: Other current assets + value: 10 + items: [] + - accountId: '65' + name: Stock Asset + value: 36524 + items: [] + - accountId: '150' + name: stock test + value: 10 + items: [] + - accountId: '77' + name: Uncategorised Asset + value: 47.8 + items: [] + - accountId: '85' + name: Undeposited Funds + value: 220930.75 + items: [] + liabilities: + name: Liabilities + value: 169469.71 + items: + - name: Accounts Payable + value: 93748.74 + items: + - accountId: '71' + name: Creditors + value: 93635.4 + items: [] + - accountId: '74' + name: Creditors - HKD + value: 113.34 + items: [] + - name: Credit Card + value: 10841.34 + items: + - accountId: '142' + name: 2504 Amex - CC + value: 9957.72 + items: [] + - accountId: '126' + name: Credit Card 2 + value: -71.91 + items: [] + - accountId: '183' + name: Expense Automated Tests Credit Card + value: -2469.91 + items: [] + - accountId: '57' + name: Visa Credit Card + value: 3425.44 + items: [] + - name: Other Current Liability + value: 10001.33 + items: + - accountId: '118' + name: Current Liabilities + value: 82.12 + items: [] + - accountId: '157' + name: Loan Payable - Kay's Bank + value: 12726 + items: [] + - accountId: '187' + name: Payroll Clearing + value: -3458.3 + items: [] + - accountId: '53' + name: VAT Control + value: -4738.49 + items: [] + - accountId: '54' + name: VAT Suspense + value: 5390 + items: [] + - name: Long Term Liability + value: 54878.3 + items: + - accountId: '158' + name: Loan Long term borrowings - Jay's Bank + value: 35630 + items: [] + - accountId: '84' + name: Long term borrowings + value: -1100 + items: [] + - accountId: '63' + name: Note Payable + value: 19348.3 + items: [] + - accountId: '86' + name: Accruals and deferred income + value: 1000 + items: [] + netAssets: 3687115.17 + equity: + name: Equity + value: 3687115.17 + items: + - name: Equity + value: 3697585.43 + items: + - accountId: '55' + name: Opening Balance Equity + value: 966720.56 + items: [] + - accountId: '2' + name: Retained Earnings + value: 2706364.87 + items: [] + - accountId: '61' + name: Owner's Equity - Contributions + value: 25500 + items: [] + - accountId: '62' + name: Owner's Equity - Draws + value: -1000 + items: [] + - name: Profit for the year + value: -10470.26 + items: [] + - date: '2023-03-31T00:00:00' + assets: + name: Assets + value: 4385453.25 + items: + - name: Fixed Asset + value: 2766.17 + items: + - accountId: '3' + name: Accumulated Depreciation + value: -399.96 + items: [] + - accountId: '5' + name: Furniture and Equipment + value: 2750 + items: [] + - accountId: '7' + name: Leasehold Improvements + value: -99.12 + items: [] + - accountId: '9' + name: Vehicles + value: 515.25 + items: [] + - name: Bank + value: 1048102.14 + items: + - accountId: '114' + name: 0983741 SamplePushBankAccount2 + value: 40.5 + items: [] + - accountId: '175' + name: 1 Push-FrontDoor-Test-1 + value: 112 + items: [] + - accountId: '134' + name: 1001001 Revenue + value: -235.34 + items: [] + - accountId: '110' + name: 101 Push Refactor Test + value: -149.4 + items: [] + - accountId: '102' + name: 10101 IntegrationTest + value: -1444.14 + items: [] + - accountId: '103' + name: 101011 testdemo1 + value: 18.6 + items: [] + - accountId: '104' + name: 101012 Dave Test + value: -5.4 + items: [] + - accountId: '105' + name: 101013 Push Test + value: 5.4 + items: [] + - accountId: '107' + name: 11 aaa + value: 23610.49 + items: [] + - accountId: '115' + name: '1111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111' + value: -9000.81 + items: [] + - accountId: '100' + name: 1131 Savings2 + value: 30281.54 + items: [] + - accountId: '109' + name: 122 Generic Push Test + value: -1079.05 + items: [] + - accountId: '101' + name: 123 Test Savings + value: 2293.37 + items: [] + - accountId: '111' + name: 123123 Steve Test + value: -1104.2 + items: [] + - accountId: '124' + name: 123175 Nominal Card + value: -2013.04 + items: [] + - accountId: '137' + name: 1232 test 55 + value: 1.29 + items: [] + - accountId: '122' + name: 1234567 Card3million + value: -85 + items: [] + - accountId: '176' + name: 12345671 testName_1 + value: 14029.28 + items: [] + - accountId: '165' + name: 123564 Huws testing name + value: -2 + items: [] + - accountId: '159' + name: 1533465364 Huws test name + value: 282.21 + items: [] + - accountId: '161' + name: 160894 Tom Automated Tests ExpensesAccount + value: -11410.5 + items: [] + - accountId: '108' + name: 19191 New Push Operation Test + value: 317.54 + items: [] + - accountId: '139' + name: 2501 Barclays + value: 741293.8 + items: [] + - accountId: '140' + name: 2502 HSBC + value: 109155.93 + items: [] + - accountId: '141' + name: 2503 BoA + value: 128055.89 + items: [] + - accountId: '138' + name: 4234 test55 + value: -14.28 + items: [] + - accountId: '106' + name: aa aa + value: -5.4 + items: [] + - accountId: '129' + name: Account Test 11 + value: 33.93 + items: [] + - accountId: '147' + name: Bank EUR + value: 188.5 + items: [] + - accountId: '173' + name: Cash on hand + value: -5 + items: [] + - accountId: '178' + name: Citi + value: 189.11 + items: [] + - accountId: '81' + name: Current + value: 24438.64 + items: [] + - accountId: '177' + name: HSBC HKD + value: -39.39 + items: [] + - accountId: '169' + name: Matt Ager Test UI Parent Account + value: 75 + items: [] + - accountId: '89' + name: TestBankAccount_1 + value: 272.07 + items: [] + - name: Accounts Receivable + value: 3075173.68 + items: + - accountId: '70' + name: Debtors + value: 3041854.11 + items: [] + - accountId: '80' + name: Debtors - USD + value: 33315.2 + items: [] + - accountId: '125' + name: Debtors 2 + value: -9 + items: [] + - accountId: '88' + name: TestBankAccount + value: 13.37 + items: [] + - name: Other Current Asset + value: 259411.26 + items: + - accountId: '98' + name: Account_001 + value: 545.86 + items: [] + - accountId: '185' + name: Loans To Officers + value: 1200 + items: [] + - accountId: '179' + name: Loans to Others + value: 58.2 + items: [] + - accountId: '171' + name: Matt Ager Test UI Parent Account 1 + value: 11 + items: [] + - accountId: '168' + name: Other current assets + value: 10 + items: [] + - accountId: '65' + name: Stock Asset + value: 36533.45 + items: [] + - accountId: '150' + name: stock test + value: 10 + items: [] + - accountId: '77' + name: Uncategorised Asset + value: 47.8 + items: [] + - accountId: '85' + name: Undeposited Funds + value: 220994.95 + items: [] + liabilities: + name: Liabilities + value: 699368.94 + items: + - name: Accounts Payable + value: 93773.74 + items: + - accountId: '71' + name: Creditors + value: 93660.4 + items: [] + - accountId: '74' + name: Creditors - HKD + value: 113.34 + items: [] + - name: Credit Card + value: 12226.79 + items: + - accountId: '142' + name: 2504 Amex - CC + value: 11004.72 + items: [] + - accountId: '126' + name: Credit Card 2 + value: -71.91 + items: [] + - accountId: '183' + name: Expense Automated Tests Credit Card + value: -2471.46 + items: [] + - accountId: '57' + name: Visa Credit Card + value: 3765.44 + items: [] + - name: Other Current Liability + value: 538490.11 + items: + - accountId: '118' + name: Current Liabilities + value: 72.12 + items: [] + - accountId: '157' + name: Loan Payable - Kay's Bank + value: 12726 + items: [] + - accountId: '187' + name: Payroll Clearing + value: -3458.3 + items: [] + - accountId: '53' + name: VAT Control + value: -3792.71 + items: [] + - accountId: '54' + name: VAT Suspense + value: 532943 + items: [] + - name: Long Term Liability + value: 54878.3 + items: + - accountId: '158' + name: Loan Long term borrowings - Jay's Bank + value: 35630 + items: [] + - accountId: '84' + name: Long term borrowings + value: -1100 + items: [] + - accountId: '63' + name: Note Payable + value: 19348.3 + items: [] + - accountId: '86' + name: Accruals and deferred income + value: 1000 + items: [] + netAssets: 3686084.31 + equity: + name: Equity + value: 3686084.31 + items: + - name: Equity + value: 3697585.43 + items: + - accountId: '55' + name: Opening Balance Equity + value: 966720.56 + items: [] + - accountId: '2' + name: Retained Earnings + value: 2706364.87 + items: [] + - accountId: '61' + name: Owner's Equity - Contributions + value: 25500 + items: [] + - accountId: '62' + name: Owner's Equity - Draws + value: -1000 + items: [] + - name: Profit for the year + value: -11501.12 + items: [] + mostRecentAvailableMonth: '2023-04-30T00:00:00' + earliestAvailableMonth: '2022-10-01T00:00:00' + QuickBooks Online: + value: + reports: [] + Sage 50 (UK): + value: + currency: GBP + reports: + - date: '2023-03-31T00:00:00' + assets: + name: Assets + value: 239322.69 + items: + - name: Fixed Assets + value: 81530.08 + items: + - name: Plant and Machinery + value: 46515 + items: + - accountId: '0020' + name: Plant and Machinery + value: 50000 + items: [] + - accountId: '0021' + name: Plant/Machinery Depreciation + value: -3485 + items: [] + - name: Furniture and Fixtures + value: 16807 + items: + - accountId: '0040' + name: Furniture and Fixtures + value: 16900 + items: [] + - accountId: '0041' + name: Furniture/Fixture Depreciation + value: -93 + items: [] + - name: Motor Vehicles + value: 18208.08 + items: + - accountId: '0051' + name: Motor Vehicles Depreciation + value: -2091.92 + items: [] + - accountId: '0050' + name: Motor Vehicles + value: 20300 + items: [] + - name: Current Assets + value: 157792.61 + items: + - name: Stock + value: 35000 + items: + - accountId: '1001' + name: Stock + value: 35000 + items: [] + - name: Debtors + value: 90640.61 + items: + - accountId: '1100' + name: Debtors Control Account + value: 90640.61 + items: [] + - accountId: '1103' + name: Prepayments + value: 0 + items: [] + - name: Deposits and Cash + value: 5148.01 + items: + - accountId: '1220' + name: Building Society Account + value: 507.53 + items: [] + - accountId: '1230' + name: Petty Cash + value: 1130.48 + items: [] + - accountId: '1210' + name: Bank Deposit Account + value: 3510 + items: [] + - name: VAT Liability + value: 27003.99 + items: + - accountId: '2201' + name: Purchase Tax Control Account + value: 12203.64 + items: [] + - accountId: '2202' + name: VAT Liability + value: 14800.35 + items: [] + liabilities: + name: Liabilities + value: 97996.05 + items: + - name: Current Liabilities + value: 84941.05 + items: + - name: Bank Account + value: 20091.04 + items: + - accountId: '1200' + name: Bank Current Account + value: 20091.04 + items: [] + - name: Credit Card (Creditors) + value: -9358.97 + items: + - accountId: '1240' + name: Company Credit Card + value: -9358.97 + items: [] + - name: 'Creditors : Short Term' + value: 44502.68 + items: + - accountId: '2100' + name: Creditors Control Account + value: 44502.68 + items: [] + - accountId: '2109' + name: Accruals + value: 0 + items: [] + - name: VAT Liability + value: 22182.53 + items: + - accountId: '2200' + name: Sales Tax Control Account + value: 22182.53 + items: [] + - name: Taxation + value: 7403.77 + items: + - accountId: '2210' + name: P.A.Y.E. + value: 5396.79 + items: [] + - accountId: '2211' + name: National Insurance + value: 2006.98 + items: [] + - name: Wages + value: 120 + items: + - accountId: '2220' + name: Net Wages + value: 0 + items: [] + - accountId: '2230' + name: Pension Fund + value: 120 + items: [] + - name: Non-Current Liabilities + value: 13055 + items: + - name: 'Creditors : Long Term' + value: 13055 + items: + - accountId: '2310' + name: Hire Purchase + value: 6160 + items: [] + - accountId: '2300' + name: Loans + value: 6895 + items: [] + netAssets: 141326.64 + equity: + name: Equity + value: 141326.64 + items: + - name: Share Capital + value: 96332 + items: + - accountId: '3000' + name: Ordinary Shares + value: 96332 + items: [] + - name: Profit and Loss Account + value: 44994.64 + items: [] + - date: '2023-02-28T00:00:00' + assets: + name: Assets + value: 239322.69 + items: + - name: Fixed Assets + value: 81530.08 + items: + - name: Plant and Machinery + value: 46515 + items: + - accountId: '0020' + name: Plant and Machinery + value: 50000 + items: [] + - accountId: '0021' + name: Plant/Machinery Depreciation + value: -3485 + items: [] + - name: Furniture and Fixtures + value: 16807 + items: + - accountId: '0040' + name: Furniture and Fixtures + value: 16900 + items: [] + - accountId: '0041' + name: Furniture/Fixture Depreciation + value: -93 + items: [] + - name: Motor Vehicles + value: 18208.08 + items: + - accountId: '0051' + name: Motor Vehicles Depreciation + value: -2091.92 + items: [] + - accountId: '0050' + name: Motor Vehicles + value: 20300 + items: [] + - name: Current Assets + value: 157792.61 + items: + - name: Stock + value: 35000 + items: + - accountId: '1001' + name: Stock + value: 35000 + items: [] + - name: Debtors + value: 90640.61 + items: + - accountId: '1100' + name: Debtors Control Account + value: 90640.61 + items: [] + - accountId: '1103' + name: Prepayments + value: 0 + items: [] + - name: Deposits and Cash + value: 5148.01 + items: + - accountId: '1220' + name: Building Society Account + value: 507.53 + items: [] + - accountId: '1230' + name: Petty Cash + value: 1130.48 + items: [] + - accountId: '1210' + name: Bank Deposit Account + value: 3510 + items: [] + - name: VAT Liability + value: 27003.99 + items: + - accountId: '2201' + name: Purchase Tax Control Account + value: 12203.64 + items: [] + - accountId: '2202' + name: VAT Liability + value: 14800.35 + items: [] + liabilities: + name: Liabilities + value: 97996.05 + items: + - name: Current Liabilities + value: 84941.05 + items: + - name: Bank Account + value: 20091.04 + items: + - accountId: '1200' + name: Bank Current Account + value: 20091.04 + items: [] + - name: Credit Card (Creditors) + value: -9358.97 + items: + - accountId: '1240' + name: Company Credit Card + value: -9358.97 + items: [] + - name: 'Creditors : Short Term' + value: 44502.68 + items: + - accountId: '2100' + name: Creditors Control Account + value: 44502.68 + items: [] + - accountId: '2109' + name: Accruals + value: 0 + items: [] + - name: VAT Liability + value: 22182.53 + items: + - accountId: '2200' + name: Sales Tax Control Account + value: 22182.53 + items: [] + - name: Taxation + value: 7403.77 + items: + - accountId: '2210' + name: P.A.Y.E. + value: 5396.79 + items: [] + - accountId: '2211' + name: National Insurance + value: 2006.98 + items: [] + - name: Wages + value: 120 + items: + - accountId: '2220' + name: Net Wages + value: 0 + items: [] + - accountId: '2230' + name: Pension Fund + value: 120 + items: [] + - name: Non-Current Liabilities + value: 13055 + items: + - name: 'Creditors : Long Term' + value: 13055 + items: + - accountId: '2310' + name: Hire Purchase + value: 6160 + items: [] + - accountId: '2300' + name: Loans + value: 6895 + items: [] + netAssets: 141326.64 + equity: + name: Equity + value: 141326.64 + items: + - name: Share Capital + value: 96332 + items: + - accountId: '3000' + name: Ordinary Shares + value: 96332 + items: [] + - name: Profit and Loss Account + value: 44994.64 + items: [] + mostRecentAvailableMonth: '2023-03-31T00:00:00' + earliestAvailableMonth: '2021-04-01T00:00:00' + Sage Business Cloud Accounting: + value: + currency: GBP + reports: + - date: '2022-10-31T00:00:00' + assets: + name: Assets + value: 1740591.73 + items: + - accountId: 9a25937b267a11e797950a57719b2edb + name: 1200 - Current + value: 8493.25 + items: [] + - accountId: 9a3e4bc6267a11e797950a57719b2edb + name: 1210 - Cash + value: 2664.25 + items: [] + - accountId: 9a98cf79267a11e797950a57719b2edb + name: 1 - Assets - Cost + value: 1302.24 + items: [] + - accountId: 9a990bbd267a11e797950a57719b2edb + name: 30 - Office equipment and IT - Cost + value: 100 + items: [] + - accountId: 9a99117b267a11e797950a57719b2edb + name: 40 - Fixtures and fittings - Cost + value: 485 + items: [] + - accountId: 9a9915ef267a11e797950a57719b2edb + name: 50 - Motor Vehicles - Cost + value: -426.67 + items: [] + - accountId: 9a991c56267a11e797950a57719b2edb + name: 1100 - Trade Debtors + value: 1425254.88 + items: [] + - accountId: 9a991e47267a11e797950a57719b2edb + name: 1101 - Provision for doubtful debtors + value: 25 + items: [] + - accountId: 7e6c7ed52c2d11e8b45c025132dab352 + name: 1220 - Savings + value: -155764.91 + items: [] + - accountId: 2572c8766afc11e8aaa5027d54329956 + name: 1230 - Tide Current + value: 509590.44 + items: [] + - accountId: e5889b459f544926ac5b8e6756df2ad4 + name: 1560 - Abdi Internet Bank + value: 49.61 + items: [] + - accountId: b17083bc9b2748b4ab321b024e260eda + name: 147852 - Abdi Live Test + value: -225830.75 + items: [] + - accountId: 92b80ba619d34cafbedd0eb2e69a82f7 + name: 12345678 - ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + value: 34321.11 + items: [] + - accountId: ae17d64a96a741719f1d31045aa4a8ef + name: 11113 - bills bank account + value: 2919.35 + items: [] + - accountId: 7c8be6c5e19a40cd92f93e36aecd4156 + name: 12345698 - Abdi Savings + value: 8949 + items: [] + - accountId: 5a64e8ada630412eb8fd1762175b3182 + name: 12345748 - My Test Bank Account + value: 20438.71 + items: [] + - accountId: 8cd0b0b93f0f4c8ba3434bc72d297cc2 + name: 12345758 - AlexT + value: 1080 + items: [] + - accountId: d340f7af2ba249cbb1c4cf12a6fdae14 + name: 12345768 - AbdiCredit + value: -40 + items: [] + - accountId: 8065f6270c984d6dae78ce817399ac4d + name: 101010 - Test Push Account + value: 120 + items: [] + - accountId: b34c43d0f3cd404ead4b282c2163c021 + name: 231 - TestArch12345 + value: -20 + items: [] + - accountId: 0f114074c6874794961e6e4b1ab6e4b1 + name: 466 - TestArch321 + value: 0.01 + items: [] + - accountId: fd4573ca207742d7bc8f04481952e53a + name: 1004 - Card Provider Bank Account + value: -4 + items: [] + - accountId: 90f1a608fcee4bddbc81cce5f6335060 + name: 345678 - Capital on Tap Bank Account CC + value: -120 + items: [] + - accountId: 5e77ffb2faa540a794f2dbd157064556 + name: 12345788 - Mike B Commerce Test Bank Account + value: 89120.55 + items: [] + - accountId: ad11ee61cdc54d4bb991f4855d9608b0 + name: 12345798 - Current Account 5 + value: 30 + items: [] + - accountId: f8cfa3dd79da436683f1768de75858b0 + name: 12345818 - Maria's Current Account + value: 1732.13 + items: [] + - accountId: e6717e9019c7456787e9054822772ebb + name: 12345828 - Joseph Test + value: 15662 + items: [] + - accountId: 495afbea7acb4be38cb5910b8c8db27d + name: 56743 - Nic Test Bank Account + value: 13.4 + items: [] + - accountId: f7559ab5cf8a493aa436503bd9712158 + name: 12345858 - Rob Credit Card + value: -200 + items: [] + - accountId: 83fbaf62ee244bebbee822d97b267c55 + name: 12345898 - Joseph (EUR) + value: 95.09 + items: [] + - accountId: afac9b7c22184fae8f7bc734d880b166 + name: 12345928 - Matt Ager test loan + value: 10 + items: [] + - accountId: 553ed57b302b4eda881b129b6abda736 + name: 12345938 - Matt Ager Test Current Account + value: 239.77 + items: [] + - accountId: 785c9d9f9b954307bd700bede22cf0b5 + name: 12345948 - Matt Ager Test Savings Account + value: 195 + items: [] + - accountId: 3c18fba9e0ba414bb6668bc0668a3090 + name: 12345958 - Matt Ager Test Credit Card + value: 30 + items: [] + - accountId: a11475c87cd54d0bb81951852ad91035 + name: 12345968 - Matt Ager Test Cash + value: 290 + items: [] + - accountId: 3d067bcf4a4b4a408ef3abaa4d944b91 + name: 12345978 - Matt Ager Test Other Bank Account + value: 20 + items: [] + - accountId: 179e02763960436c903b7ff2708659a2 + name: 12345988 - Matt Ager Test EUR Account + value: -58.16 + items: [] + - accountId: bb6151d3fd744fa6a81f2164b1d156dc + name: 13918348 - PUSH 1 Matt Ager Test EUR Account + value: 9 + items: [] + - accountId: 9a207c1a748b45f29117fa7126c12a9e + name: 13918594 - Australian Current Account + value: 1.43 + items: [] + - accountId: ab8e9947a5434c848e9a294188664117 + name: 13918604 - Bank Account 70 + value: -70 + items: [] + - accountId: 77650bcb6a1d4924be22d6a5da309031 + name: 13918624 - COT GBP Account + value: -10 + items: [] + - accountId: 8be8979ae30c46a6830dc653c9ad4400 + name: 57436 - Capital on Tap Business Credit Card + value: -105 + items: [] + liabilities: + name: Liabilities + value: 173084617.49 + items: + - accountId: 9a992290267a11e797950a57719b2edb + name: 2100 - Trade Creditors + value: 183778965.2 + items: [] + - accountId: 9a992966267a11e797950a57719b2edb + name: 2200 - VAT on Sales + value: 57234.67 + items: [] + - accountId: 9a992b99267a11e797950a57719b2edb + name: 2201 - VAT on Purchases + value: -34745.24 + items: [] + - accountId: 9a992d9e267a11e797950a57719b2edb + name: 2202 - VAT Liability + value: 256.86 + items: [] + - accountId: 9a992fb3267a11e797950a57719b2edb + name: 2203 - VAT Allocations & Adjustments + value: -40 + items: [] + - accountId: 9a9931b4267a11e797950a57719b2edb + name: 2205 - VAT on Sales - Holding Account + value: 199200.59 + items: [] + - accountId: 9a9933d1267a11e797950a57719b2edb + name: 2206 - VAT on Purchases - Holding Account + value: -10893226.32 + items: [] + - accountId: b954fb00e56447259a9f0cd84dbb6125 + name: 12345 - Pete Bill Account + value: -6383.05 + items: [] + - accountId: 7723dee96cbb435a800c2f7c047f47f3 + name: 312323 - Commerce Prepaid + value: -12842.93 + items: [] + - accountId: f96e7c899a1c4336bfbfe3d91ff4c157 + name: 121212 - Commerce Prepaid2 + value: -464.36 + items: [] + - accountId: 7ed323223f8d4d8f8f737d76e380a254 + name: 987 - Mike B Commerce Prepaid Test Account + value: -5011.84 + items: [] + - accountId: a2b43df636774b5a92fbfd889e390348 + name: 989 - Mike B Commerce Loan Test Account + value: 62 + items: [] + - accountId: 5cdf52bfb00d4d86b5a01e8af0761fe5 + name: 990 - Mike B Commerce Loan Test Account + value: 1538.24 + items: [] + - accountId: 09f1976c146f40c6b2009b26f1d20f97 + name: 42 - TestDatatypesAccount + value: 100 + items: [] + - accountId: 229eb087d0574c28be42fa4cc89af1f3 + name: 2110 - Trade Creditors + value: -26.33 + items: [] + netAssets: -171344025.76 + equity: + name: Equities + value: -171344025.76 + items: + - accountId: PROFIT-AND-LOSS + name: Profit for this period + value: -171344025.76 + items: [] + - date: '2022-09-30T00:00:00' + assets: + name: Assets + value: 1748139.93 + items: + - accountId: 9a25937b267a11e797950a57719b2edb + name: 1200 - Current + value: 8493.25 + items: [] + - accountId: 9a3e4bc6267a11e797950a57719b2edb + name: 1210 - Cash + value: 2664.25 + items: [] + - accountId: 9a98cf79267a11e797950a57719b2edb + name: 1 - Assets - Cost + value: 1302.24 + items: [] + - accountId: 9a990bbd267a11e797950a57719b2edb + name: 30 - Office equipment and IT - Cost + value: 100 + items: [] + - accountId: 9a99117b267a11e797950a57719b2edb + name: 40 - Fixtures and fittings - Cost + value: 485 + items: [] + - accountId: 9a9915ef267a11e797950a57719b2edb + name: 50 - Motor Vehicles - Cost + value: -426.67 + items: [] + - accountId: 9a991c56267a11e797950a57719b2edb + name: 1100 - Trade Debtors + value: 1432812.05 + items: [] + - accountId: 9a991e47267a11e797950a57719b2edb + name: 1101 - Provision for doubtful debtors + value: 25 + items: [] + - accountId: 7e6c7ed52c2d11e8b45c025132dab352 + name: 1220 - Savings + value: -155764.91 + items: [] + - accountId: 2572c8766afc11e8aaa5027d54329956 + name: 1230 - Tide Current + value: 509590.44 + items: [] + - accountId: e5889b459f544926ac5b8e6756df2ad4 + name: 1560 - Abdi Internet Bank + value: 49.61 + items: [] + - accountId: b17083bc9b2748b4ab321b024e260eda + name: 147852 - Abdi Live Test + value: -225830.75 + items: [] + - accountId: 92b80ba619d34cafbedd0eb2e69a82f7 + name: 12345678 - ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + value: 34321.11 + items: [] + - accountId: ae17d64a96a741719f1d31045aa4a8ef + name: 11113 - bills bank account + value: 2919.35 + items: [] + - accountId: 7c8be6c5e19a40cd92f93e36aecd4156 + name: 12345698 - Abdi Savings + value: 8949 + items: [] + - accountId: 5a64e8ada630412eb8fd1762175b3182 + name: 12345748 - My Test Bank Account + value: 20438.74 + items: [] + - accountId: 8cd0b0b93f0f4c8ba3434bc72d297cc2 + name: 12345758 - AlexT + value: 1080 + items: [] + - accountId: d340f7af2ba249cbb1c4cf12a6fdae14 + name: 12345768 - AbdiCredit + value: -40 + items: [] + - accountId: 8065f6270c984d6dae78ce817399ac4d + name: 101010 - Test Push Account + value: 120 + items: [] + - accountId: b34c43d0f3cd404ead4b282c2163c021 + name: 231 - TestArch12345 + value: -20 + items: [] + - accountId: 0f114074c6874794961e6e4b1ab6e4b1 + name: 466 - TestArch321 + value: 0.01 + items: [] + - accountId: fd4573ca207742d7bc8f04481952e53a + name: 1004 - Card Provider Bank Account + value: -4 + items: [] + - accountId: 90f1a608fcee4bddbc81cce5f6335060 + name: 345678 - Capital on Tap Bank Account CC + value: -120 + items: [] + - accountId: 5e77ffb2faa540a794f2dbd157064556 + name: 12345788 - Mike B Commerce Test Bank Account + value: 89120.55 + items: [] + - accountId: ad11ee61cdc54d4bb991f4855d9608b0 + name: 12345798 - Current Account 5 + value: 30 + items: [] + - accountId: f8cfa3dd79da436683f1768de75858b0 + name: 12345818 - Maria's Current Account + value: 1732.13 + items: [] + - accountId: e6717e9019c7456787e9054822772ebb + name: 12345828 - Joseph Test + value: 15662 + items: [] + - accountId: 495afbea7acb4be38cb5910b8c8db27d + name: 56743 - Nic Test Bank Account + value: 13.4 + items: [] + - accountId: f7559ab5cf8a493aa436503bd9712158 + name: 12345858 - Rob Credit Card + value: -200 + items: [] + - accountId: 83fbaf62ee244bebbee822d97b267c55 + name: 12345898 - Joseph (EUR) + value: 95.09 + items: [] + - accountId: afac9b7c22184fae8f7bc734d880b166 + name: 12345928 - Matt Ager test loan + value: 10 + items: [] + - accountId: 553ed57b302b4eda881b129b6abda736 + name: 12345938 - Matt Ager Test Current Account + value: 239.77 + items: [] + - accountId: 785c9d9f9b954307bd700bede22cf0b5 + name: 12345948 - Matt Ager Test Savings Account + value: 195 + items: [] + - accountId: 3c18fba9e0ba414bb6668bc0668a3090 + name: 12345958 - Matt Ager Test Credit Card + value: 30 + items: [] + - accountId: a11475c87cd54d0bb81951852ad91035 + name: 12345968 - Matt Ager Test Cash + value: 290 + items: [] + - accountId: 3d067bcf4a4b4a408ef3abaa4d944b91 + name: 12345978 - Matt Ager Test Other Bank Account + value: 20 + items: [] + - accountId: 179e02763960436c903b7ff2708659a2 + name: 12345988 - Matt Ager Test EUR Account + value: -58.16 + items: [] + - accountId: 9a207c1a748b45f29117fa7126c12a9e + name: 13918594 - Australian Current Account + value: 1.43 + items: [] + - accountId: ab8e9947a5434c848e9a294188664117 + name: 13918604 - Bank Account 70 + value: -70 + items: [] + - accountId: 77650bcb6a1d4924be22d6a5da309031 + name: 13918624 - COT GBP Account + value: -10 + items: [] + - accountId: 8be8979ae30c46a6830dc653c9ad4400 + name: 57436 - Capital on Tap Business Credit Card + value: -105 + items: [] + liabilities: + name: Liabilities + value: 161482418.52 + items: + - accountId: 9a992290267a11e797950a57719b2edb + name: 2100 - Trade Creditors + value: 171440565.23 + items: [] + - accountId: 9a992966267a11e797950a57719b2edb + name: 2200 - VAT on Sales + value: 57232.9 + items: [] + - accountId: 9a992b99267a11e797950a57719b2edb + name: 2201 - VAT on Purchases + value: -34745.24 + items: [] + - accountId: 9a992d9e267a11e797950a57719b2edb + name: 2202 - VAT Liability + value: 256.86 + items: [] + - accountId: 9a992fb3267a11e797950a57719b2edb + name: 2203 - VAT Allocations & Adjustments + value: -40 + items: [] + - accountId: 9a9931b4267a11e797950a57719b2edb + name: 2205 - VAT on Sales - Holding Account + value: 199003.36 + items: [] + - accountId: 9a9933d1267a11e797950a57719b2edb + name: 2206 - VAT on Purchases - Holding Account + value: -10156826.32 + items: [] + - accountId: b954fb00e56447259a9f0cd84dbb6125 + name: 12345 - Pete Bill Account + value: -6383.05 + items: [] + - accountId: 7723dee96cbb435a800c2f7c047f47f3 + name: 312323 - Commerce Prepaid + value: -12842.93 + items: [] + - accountId: f96e7c899a1c4336bfbfe3d91ff4c157 + name: 121212 - Commerce Prepaid2 + value: -464.36 + items: [] + - accountId: 7ed323223f8d4d8f8f737d76e380a254 + name: 987 - Mike B Commerce Prepaid Test Account + value: -5011.84 + items: [] + - accountId: a2b43df636774b5a92fbfd889e390348 + name: 989 - Mike B Commerce Loan Test Account + value: 62 + items: [] + - accountId: 5cdf52bfb00d4d86b5a01e8af0761fe5 + name: 990 - Mike B Commerce Loan Test Account + value: 1538.24 + items: [] + - accountId: 09f1976c146f40c6b2009b26f1d20f97 + name: 42 - TestDatatypesAccount + value: 100 + items: [] + - accountId: 229eb087d0574c28be42fa4cc89af1f3 + name: 2110 - Trade Creditors + value: -26.33 + items: [] + netAssets: -159734278.59 + equity: + name: Equities + value: -159734278.59 + items: + - accountId: PROFIT-AND-LOSS + name: Profit for this period + value: -159734278.59 + items: [] + mostRecentAvailableMonth: '2022-10-31T00:00:00' + earliestAvailableMonth: '2022-04-01T00:00:00' + Wave: + value: + currency: GBP + reports: + - date: '2022-11-30T00:00:00' + assets: + name: Assets + value: 2220.87 + items: + - name: Cash and Bank + value: 1001.87 + items: + - name: Abdi Bank + value: 158.9 + items: [] + - name: Cash on Hand + value: 245.31 + items: [] + - name: Current Account + value: 597.66 + items: [] + - name: Other Current Assets + value: 219 + items: + - name: Accounts Receivable + value: 211.99 + items: [] + - name: Unrealized Gain on Foreign Exchange + value: 7.01 + items: [] + - name: Long-term Assets + value: 1000 + items: + - name: Furniture + value: 1000 + items: [] + liabilities: + name: Liabilities + value: 4641.15 + items: + - name: Current Liabilities + value: 4641.15 + items: + - name: Accounts Payable + value: 3557.14 + items: [] + - name: Abdul's new Tax + value: 7.54 + items: [] + - name: FederalABC + value: 1002.6 + items: [] + - name: STANDARD + value: 73.87 + items: [] + netAssets: -2420.28 + equity: + name: Equity + value: -2420.28 + items: + - name: Other Equity + value: 63.8 + items: + - name: Owner Investment / Drawings + value: -36.2 + items: [] + - name: Some Equity + value: 100 + items: [] + - name: Retained Earnings + value: -2484.08 + items: + - name: Profit for all prior years + value: -1950.59 + items: [] + - name: 'Profit between Jan 1, 2022 and Nov 30, 2022' + value: -533.49 + items: [] + - date: '2022-10-31T00:00:00' + assets: + name: Assets + value: 2222.22 + items: + - name: Cash and Bank + value: 1001.87 + items: + - name: Abdi Bank + value: 158.9 + items: [] + - name: Cash on Hand + value: 245.31 + items: [] + - name: Current Account + value: 597.66 + items: [] + - name: Other Current Assets + value: 220.35 + items: + - name: Accounts Receivable + value: 211.99 + items: [] + - name: Unrealized Gain on Foreign Exchange + value: 8.36 + items: [] + - name: Long-term Assets + value: 1000 + items: + - name: Furniture + value: 1000 + items: [] + liabilities: + name: Liabilities + value: 4086.15 + items: + - name: Current Liabilities + value: 4086.15 + items: + - name: Accounts Payable + value: 3002.14 + items: [] + - name: Abdul's new Tax + value: 7.54 + items: [] + - name: FederalABC + value: 1002.6 + items: [] + - name: STANDARD + value: 73.87 + items: [] + netAssets: -1863.93 + equity: + name: Equity + value: -1863.93 + items: + - name: Other Equity + value: 63.8 + items: + - name: Owner Investment / Drawings + value: -36.2 + items: [] + - name: Some Equity + value: 100 + items: [] + - name: Retained Earnings + value: -1927.73 + items: + - name: Profit for all prior years + value: -1950.59 + items: [] + - name: 'Profit between Jan 1, 2022 and Oct 31, 2022' + value: 22.86 + items: [] + mostRecentAvailableMonth: '2022-11-30T00:00:00' + earliestAvailableMonth: '2022-05-01T00:00:00' + Xero: + value: + currency: GBP + reports: + - date: '2023-03-31T23:59:59' + assets: + name: Assets + value: 24166.8 + items: + - name: Current Assets + value: 21486.84 + items: + - name: Bank + value: 924.25 + items: + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + value: 924.25 + items: [] + - accountId: a1e2c53a-18b9-40cb-8e87-e2db200fe8af + name: Inventory + value: 121.21 + items: [] + - accountId: 8add7c44-ffe0-4a42-869e-b85dadd5eac1 + name: Accounts Receivable + value: 20441.38 + items: [] + - name: Fixed Assets + value: 2679.96 + items: + - accountId: a4602fb6-2e9d-4064-b318-c409032692ba + name: Office Equipment + value: 3665.63 + items: [] + - accountId: 8d1ae68b-1251-4b44-9d7a-639b3976935c + name: Computer Equipment + value: -985.67 + items: [] + liabilities: + name: Liabilities + value: 14265.73 + items: + - name: Current Liabilities + value: 14265.73 + items: + - accountId: b12f79b9-a082-4b8b-971e-d321292943c7 + name: VAT + value: 1194.45 + items: [] + - accountId: 1873bf00-e52f-48e9-89d6-619c93723f60 + name: Unpaid Expense Claims + value: 150.85 + items: [] + - accountId: 7ff95c6a-5849-4030-a361-52165fab6490 + name: Historical Adjustment + value: 4130.98 + items: [] + - accountId: e0faa299-ca0d-4b0a-9e32-0dfabdf9179a + name: Accounts Payable + value: 8789.45 + items: [] + netAssets: 9901.07 + equity: + name: Equity + value: 9901.07 + items: + - accountId: 524c9f2d-e680-4861-82f6-4ad171b51de5 + name: Retained Earnings + value: -7961.99 + items: [] + - accountId: abababab-abab-abab-abab-abababababab + name: Current Year Earnings + value: 17863.06 + items: [] + - date: '2023-02-28T23:59:59' + assets: + name: Assets + value: 24166.8 + items: + - name: Current Assets + value: 21486.84 + items: + - name: Bank + value: 924.25 + items: + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + value: 924.25 + items: [] + - accountId: a1e2c53a-18b9-40cb-8e87-e2db200fe8af + name: Inventory + value: 121.21 + items: [] + - accountId: 8add7c44-ffe0-4a42-869e-b85dadd5eac1 + name: Accounts Receivable + value: 20441.38 + items: [] + - name: Fixed Assets + value: 2679.96 + items: + - accountId: a4602fb6-2e9d-4064-b318-c409032692ba + name: Office Equipment + value: 3665.63 + items: [] + - accountId: 8d1ae68b-1251-4b44-9d7a-639b3976935c + name: Computer Equipment + value: -985.67 + items: [] + liabilities: + name: Liabilities + value: 14265.73 + items: + - name: Current Liabilities + value: 14265.73 + items: + - accountId: b12f79b9-a082-4b8b-971e-d321292943c7 + name: VAT + value: 1194.45 + items: [] + - accountId: 1873bf00-e52f-48e9-89d6-619c93723f60 + name: Unpaid Expense Claims + value: 150.85 + items: [] + - accountId: 7ff95c6a-5849-4030-a361-52165fab6490 + name: Historical Adjustment + value: 4130.98 + items: [] + - accountId: e0faa299-ca0d-4b0a-9e32-0dfabdf9179a + name: Accounts Payable + value: 8789.45 + items: [] + netAssets: 9901.07 + equity: + name: Equity + value: 9901.07 + items: + - accountId: 524c9f2d-e680-4861-82f6-4ad171b51de5 + name: Retained Earnings + value: -7961.99 + items: [] + - accountId: abababab-abab-abab-abab-abababababab + name: Current Year Earnings + value: 17863.06 + items: [] + mostRecentAvailableMonth: '2023-03-31T00:00:00' + earliestAvailableMonth: '2022-09-01T00:00:00' + Zoho Books: + value: + currency: GBP + reports: + - date: '2022-10-31T00:00:00' + assets: + name: Assets + value: 63170.61 + items: + - name: Current Assets + value: 63150.61 + items: + - name: Cash + value: 1678.31 + items: + - accountId: '104957000000000349' + name: Petty Cash + value: -8246.75 + items: [] + - accountId: '104957000000000346' + name: Undeposited Funds + value: 9925.06 + items: [] + - name: Bank + value: 69910.1 + items: + - accountId: '104957000000060010' + name: Abdi Test + value: 69858.44 + items: [] + - accountId: '104957000000065002' + name: Abdi Test 2 + value: 20 + items: [] + - accountId: '104957000000080006' + name: EUR Test Bank Account + value: 24.29 + items: [] + - accountId: '104957000000508001' + name: Subtra USD wallet + value: 7.37 + items: [] + - accountId: '104957000000000352' + name: Accounts Receivable + value: -959.64 + items: [] + - name: Other Current Assets + value: -7478.16 + items: + - accountId: '104957000000000358' + name: Advance Tax + value: 2.63 + items: [] + - accountId: '104957000000000457' + name: Employee Advance + value: 0 + items: [] + - accountId: '104957000000033015' + name: Input VAT + value: 356.84 + items: [] + - accountId: '104957000000000511' + name: Inventory Asset + value: 90.06 + items: [] + - accountId: '104957000000032010' + name: Prepaid Expenses + value: -8017.69 + items: [] + - accountId: '104957000000388007' + name: Sales to Customers (Cash) + value: 0 + items: [] + - accountId: '104957000000093001' + name: Test prepaid expenses child account + value: 0 + items: [] + - accountId: '104957000000096007' + name: Test prepaid expenses child account 2 + value: 100 + items: [] + - accountId: '104957000000096001' + name: Test prepaid expenses child child account + value: -50 + items: [] + - accountId: '104957000000085001' + name: Test stock account + value: 40 + items: [] + - name: Other Assets + value: 0 + items: [] + - name: Fixed Assets + value: 20 + items: + - accountId: '104957000000000355' + name: Furniture and Equipment + value: 20 + items: [] + liabilities: + name: Liabilities + value: 8615.39 + items: + - name: Liabilities + value: 8615.39 + items: + - name: Current Liabilities + value: 8615.39 + items: + - accountId: '104957000000000361' + name: Accounts Payable + value: 2084.6 + items: [] + - accountId: '104957000000618001' + name: Creadit Card - BA Company + value: 656.05 + items: [] + - accountId: '104957000000183010' + name: Credit Card + value: 26.25 + items: [] + - accountId: '104957000000000460' + name: Employee Reimbursements + value: 10.35 + items: [] + - accountId: '104957000000000499' + name: Opening Balance Adjustments + value: 0 + items: [] + - accountId: '104957000000033017' + name: Output VAT + value: 3934.75 + items: [] + - accountId: '104957000000000501' + name: Unearned Revenue + value: 1903.39 + items: [] + - accountId: '104957000000054026' + name: VAT MOSS Payable + value: 0 + items: [] + - accountId: '104957000000000364' + name: VAT Payable + value: 0 + items: [] + - name: Long Term Liabilities + value: 0 + items: [] + - name: Other Liabilities + value: 0 + items: + - accountId: '104957000000006001' + name: Tag Adjustments + value: 0 + items: [] + netAssets: 54555.22 + equity: + name: Equities + value: 54555.22 + items: + - accountId: '' + name: Current Year Earnings + value: -15199.89 + items: [] + - accountId: '104957000000000451' + name: Drawing + value: 0 + items: [] + - accountId: '104957000000000373' + name: Opening Balance Offset + value: 10000 + items: [] + - accountId: '104957000000000370' + name: Owner's Equity + value: 0 + items: [] + - accountId: '104957000000000367' + name: Retained Earnings + value: 59755.11 + items: [] + - date: '2022-09-01T00:00:00' + assets: + name: Assets + value: 63170.61 + items: + - name: Current Assets + value: 63150.61 + items: + - name: Cash + value: 1678.31 + items: + - accountId: '104957000000000349' + name: Petty Cash + value: -8246.75 + items: [] + - accountId: '104957000000000346' + name: Undeposited Funds + value: 9925.06 + items: [] + - name: Bank + value: 69910.1 + items: + - accountId: '104957000000060010' + name: Abdi Test + value: 69858.44 + items: [] + - accountId: '104957000000065002' + name: Abdi Test 2 + value: 20 + items: [] + - accountId: '104957000000080006' + name: EUR Test Bank Account + value: 24.29 + items: [] + - accountId: '104957000000508001' + name: Subtra USD wallet + value: 7.37 + items: [] + - accountId: '104957000000000352' + name: Accounts Receivable + value: -959.64 + items: [] + - name: Other Current Assets + value: -7478.16 + items: + - accountId: '104957000000000358' + name: Advance Tax + value: 2.63 + items: [] + - accountId: '104957000000000457' + name: Employee Advance + value: 0 + items: [] + - accountId: '104957000000033015' + name: Input VAT + value: 356.84 + items: [] + - accountId: '104957000000000511' + name: Inventory Asset + value: 90.06 + items: [] + - accountId: '104957000000032010' + name: Prepaid Expenses + value: -8017.69 + items: [] + - accountId: '104957000000388007' + name: Sales to Customers (Cash) + value: 0 + items: [] + - accountId: '104957000000093001' + name: Test prepaid expenses child account + value: 0 + items: [] + - accountId: '104957000000096007' + name: Test prepaid expenses child account 2 + value: 100 + items: [] + - accountId: '104957000000096001' + name: Test prepaid expenses child child account + value: -50 + items: [] + - accountId: '104957000000085001' + name: Test stock account + value: 40 + items: [] + - name: Other Assets + value: 0 + items: [] + - name: Fixed Assets + value: 20 + items: + - accountId: '104957000000000355' + name: Furniture and Equipment + value: 20 + items: [] + liabilities: + name: Liabilities + value: 8615.39 + items: + - name: Liabilities + value: 8615.39 + items: + - name: Current Liabilities + value: 8615.39 + items: + - accountId: '104957000000000361' + name: Accounts Payable + value: 2084.6 + items: [] + - accountId: '104957000000618001' + name: Creadit Card - BA Company + value: 656.05 + items: [] + - accountId: '104957000000183010' + name: Credit Card + value: 26.25 + items: [] + - accountId: '104957000000000460' + name: Employee Reimbursements + value: 10.35 + items: [] + - accountId: '104957000000000499' + name: Opening Balance Adjustments + value: 0 + items: [] + - accountId: '104957000000033017' + name: Output VAT + value: 3934.75 + items: [] + - accountId: '104957000000000501' + name: Unearned Revenue + value: 1903.39 + items: [] + - accountId: '104957000000054026' + name: VAT MOSS Payable + value: 0 + items: [] + - accountId: '104957000000000364' + name: VAT Payable + value: 0 + items: [] + - name: Long Term Liabilities + value: 0 + items: [] + - name: Other Liabilities + value: 0 + items: + - accountId: '104957000000006001' + name: Tag Adjustments + value: 0 + items: [] + netAssets: 54555.22 + equity: + name: Equities + value: 54555.22 + items: + - accountId: '' + name: Current Year Earnings + value: -15199.89 + items: [] + - accountId: '104957000000000451' + name: Drawing + value: 0 + items: [] + - accountId: '104957000000000373' + name: Opening Balance Offset + value: 10000 + items: [] + - accountId: '104957000000000370' + name: Owner's Equity + value: 0 + items: [] + - accountId: '104957000000000367' + name: Retained Earnings + value: 59755.11 + items: [] + mostRecentAvailableMonth: '2022-10-31T00:00:00' + earliestAvailableMonth: '2022-04-01T00:00:00' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/financials/profitAndLoss': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Financial statements + summary: Get profit and loss + description: Gets the latest profit and loss for a company. + operationId: get-accounting-profit-and-loss + x-speakeasy-group: financial-statements.profit-and-loss + parameters: + - $ref: '#/components/parameters/accountingPeriodLength' + - $ref: '#/components/parameters/accountingPeriodsToCompare' + - $ref: '#/components/parameters/accountingStartMonth' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingProfitAndLossReport' + examples: + Clear Books: + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + accountId: '' + name: Income + value: 146840.42 + items: + - accountId: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + value: 146840.42 + items: [] + costOfSales: + accountId: '' + name: Cost of Sales + value: 29955.45 + items: + - accountId: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + value: 29955.45 + items: [] + grossProfit: 116884.97 + expenses: + accountId: '' + name: Expenses + value: 62407.18 + items: + - accountId: 868591ad-f9c2-4956-a5ec-c32c1d48c6f3 + name: Advertising & Marketing + value: 24962.87 + items: [] + - accountId: 940c8a59-3348-4a0b-a1b1-781d9f29cc8b + name: Depreciation Expense + value: 1550.12 + items: [] + - accountId: e7ac3baa-cfbe-40c1-a172-83d22e84435b + name: Entertainment-100% business + value: 1410.61 + items: [] + - accountId: b5e801e8-8dbc-4390-ac99-3b0fff54a89f + name: General Expenses + value: 1283.66 + items: [] + - accountId: 5360066d-1474-49f6-a7a5-c66d5f6032ba + name: 'Light, Power, Heating' + value: 1168.13 + items: [] + - accountId: 138a8eb3-5c08-4e59-a3bc-892119694447 + name: Motor Vehicle Expenses + value: 944.89 + items: [] + - accountId: 1734ff00-2a17-45b4-8db6-2dc2e832c460 + name: 'Postage, Freight & Courier' + value: 977.96 + items: [] + - accountId: 7aa7988a-ff61-4cb8-bef3-15395355d108 + name: Printing & Stationery + value: 889.94 + items: [] + - accountId: 9cbe5fe4-ca60-4792-8bf1-de01fb7010aa + name: Rent + value: 8000 + items: [] + - accountId: 04f7111b-55d4-4efc-b329-1bd5c791933a + name: Repairs & Maintenance + value: 719.86 + items: [] + - accountId: 7d8d0322-f452-47de-a8e8-54b0130e6f38 + name: Subscriptions + value: 40 + items: [] + - accountId: 043b6bcb-dfe6-4c97-9b4c-f9b300fe3f03 + name: Telephone & Internet + value: 45 + items: [] + - accountId: df62060b-41cc-4bf2-9de7-c7e537b5663a + name: Travel - National + value: 6000.46 + items: [] + - accountId: eef78ed1-dfed-447c-bdba-3a49fb2c044b + name: Audit & Accountancy fees + value: 0 + items: [] + - accountId: f3aa84fe-5c31-4107-b207-7e0419f636d7 + name: Bank Fees + value: 609.29 + items: [] + - accountId: c16f5c35-8283-47da-9d09-5fecb183b0cb + name: Cleaning + value: 130 + items: [] + - accountId: fb3210ef-edeb-48af-bb49-b85d40c1e6bb + name: Corporation Tax + value: 630.62 + items: [] + - accountId: 7f6a0e92-65be-4333-9a0a-d981b03bedd1 + name: Wages + value: 12000 + items: [] + - accountId: e8a0a24e-2dab-46b1-bfe1-6e92551c04e8 + name: Purchase Discounts + value: 510.1 + items: [] + - accountId: 4378ddba-36b4-4b35-9970-bd972b20d137 + name: Amortization + value: 5.72 + items: [] + - accountId: 78785fd7-f197-4c34-aa17-6e76b9255d34 + name: Interest Paid (operating) + value: 527.95 + items: [] + netOperatingProfit: 54477.79 + otherExpenses: + accountId: '' + name: Other Expenses + value: 350.44 + items: + - accountId: cbf82e0d-87a7-464d-b567-9274ea94a1c0 + name: Charitable and Political Donations + value: 350.44 + items: [] + otherIncome: + accountId: '' + name: Other Income + value: 850.22 + items: + - accountId: 68794a8f-b22d-4520-b97b-025b7cb10f94 + name: Other Revenue + value: 850.22 + items: [] + netOtherIncome: 499.78 + netProfit: 54977.57 + - fromDate: '2023-02-01T00:00:00' + toDate: '2023-02-28T00:00:00' + income: + accountId: '' + name: Income + value: 108461.81 + items: + - accountId: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + value: 108461.81 + items: [] + costOfSales: + accountId: '' + name: Cost of Sales + value: 18438.51 + items: + - accountId: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + value: 18438.51 + items: [] + grossProfit: 90023.3 + expenses: + accountId: '' + name: Expenses + value: 46096.28 + items: + - accountId: 868591ad-f9c2-4956-a5ec-c32c1d48c6f3 + name: Advertising & Marketing + value: 18438.51 + items: [] + - accountId: 940c8a59-3348-4a0b-a1b1-781d9f29cc8b + name: Depreciation Expense + value: 669.33 + items: [] + - accountId: e7ac3baa-cfbe-40c1-a172-83d22e84435b + name: Entertainment-100% business + value: 609.09 + items: [] + - accountId: b5e801e8-8dbc-4390-ac99-3b0fff54a89f + name: General Expenses + value: 554.28 + items: [] + - accountId: 5360066d-1474-49f6-a7a5-c66d5f6032ba + name: 'Light, Power, Heating' + value: 448.35 + items: [] + - accountId: 138a8eb3-5c08-4e59-a3bc-892119694447 + name: Motor Vehicle Expenses + value: 412.48 + items: [] + - accountId: 1734ff00-2a17-45b4-8db6-2dc2e832c460 + name: 'Postage, Freight & Courier' + value: 426.92 + items: [] + - accountId: 7aa7988a-ff61-4cb8-bef3-15395355d108 + name: Printing & Stationery + value: 388.49 + items: [] + - accountId: 9cbe5fe4-ca60-4792-8bf1-de01fb7010aa + name: Rent + value: 8000 + items: [] + - accountId: 04f7111b-55d4-4efc-b329-1bd5c791933a + name: Repairs & Maintenance + value: 314.25 + items: [] + - accountId: 7d8d0322-f452-47de-a8e8-54b0130e6f38 + name: Subscriptions + value: 40 + items: [] + - accountId: 043b6bcb-dfe6-4c97-9b4c-f9b300fe3f03 + name: Telephone & Internet + value: 45 + items: [] + - accountId: df62060b-41cc-4bf2-9de7-c7e537b5663a + name: Travel - National + value: 325.25 + items: [] + - accountId: eef78ed1-dfed-447c-bdba-3a49fb2c044b + name: Audit & Accountancy fees + value: 0 + items: [] + - accountId: f3aa84fe-5c31-4107-b207-7e0419f636d7 + name: Bank Fees + value: 2600.97 + items: [] + - accountId: c16f5c35-8283-47da-9d09-5fecb183b0cb + name: Cleaning + value: 130 + items: [] + - accountId: fb3210ef-edeb-48af-bb49-b85d40c1e6bb + name: Corporation Tax + value: 239.41 + items: [] + - accountId: 7f6a0e92-65be-4333-9a0a-d981b03bedd1 + name: Wages + value: 12000 + items: [] + - accountId: e8a0a24e-2dab-46b1-bfe1-6e92551c04e8 + name: Purchase Discounts + value: 220.26 + items: [] + - accountId: 4378ddba-36b4-4b35-9970-bd972b20d137 + name: Amortization + value: 5.72 + items: [] + - accountId: 78785fd7-f197-4c34-aa17-6e76b9255d34 + name: Interest Paid (operating) + value: 227.97 + items: [] + netOperatingProfit: 43927.02 + otherExpenses: + accountId: '' + name: Other Expenses + value: 350.44 + items: + - accountId: cbf82e0d-87a7-464d-b567-9274ea94a1c0 + name: Charitable and Political Donations + value: 350.44 + items: [] + otherIncome: + accountId: '' + name: Other Income + value: 850.22 + items: + - accountId: 68794a8f-b22d-4520-b97b-025b7cb10f94 + name: Other Revenue + value: 850.22 + items: [] + netOtherIncome: 499.78 + netProfit: 44426.8 + reportBasis: Unknown + currency: GBP + mostRecentAvailableMonth: '2023-03-01T00:00:00' + earliestAvailableMonth: '2018-04-01T00:00:00' + Dynamics 365 Business Central: + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 658.5 + items: + - name: Sales Returns & Allowances + value: 0 + items: + - accountId: 8aba49ae-461a-ed11-90eb-000d3a873324 + name: '0121 - ' + value: 0 + items: [] + - accountId: 1e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10400 - Sales Returns & Allowances + value: 0 + items: [] + - name: 'Income, Services' + value: 0 + items: + - accountId: ac6a3a74-c69f-ec11-80f1-0022481b4546 + name: 10005-1 - Child + value: 0 + items: [] + - accountId: 161217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '10100 - Income, Services' + value: 0 + items: [] + - name: 'Income, Jobs' + value: 0 + items: + - accountId: 1f2618f9-c79f-ec11-80f1-0022481b4546 + name: 10005-2 - Child Child + value: 0 + items: [] + - accountId: 1a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10250 - Job Sales + value: 0 + items: [] + - name: '' + value: 0 + items: + - accountId: de1cabee-4a33-ed11-97e8-0022481aa72d + name: 1005002 - Test account no cat 2 + value: 0 + items: [] + - accountId: b74b0c08-aa59-eb11-89f9-00224800a7ae + name: '1006 - Account without category Income ' + value: 0 + items: [] + - accountId: 023a8eba-c12e-ed11-97e8-000d3a8753f5 + name: 3213 - vdfgdf + value: 0 + items: [] + - accountId: aa666f5a-c22e-ed11-97e8-0022480052b7 + name: 'TEST INCOME A/C - ' + value: 0 + items: [] + - name: 'Income, Product Sales' + value: 658.5 + items: + - accountId: 181217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '10200 - Income, Product Sales' + value: 658.5 + items: [] + - name: Sales Discounts + value: 0 + items: + - accountId: 1c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10300 - Sales Discounts + value: 0 + items: [] + - name: Job Sales Contra + value: 0 + items: + - accountId: 201217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10450 - Job Sales Applied + value: 0 + items: [] + - name: Income + value: 0 + items: + - accountId: 221217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10500 - Interest Income + value: 0 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 2735.64 + items: + - name: Materials + value: 2735.64 + items: + - accountId: 281217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20100 - Cost of Materials + value: 2735.64 + items: [] + - name: Labour + value: 0 + items: + - accountId: 2a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20200 - Cost of Labour + value: 0 + items: [] + - name: Jobs Cost + value: 0 + items: + - accountId: 2c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20300 - Job Costs + value: 0 + items: [] + grossProfit: -2077.14 + expenses: + name: Expense + value: 41.77 + items: + - name: '' + value: 0 + items: + - accountId: e9b4e2c2-4b33-ed11-97e8-0022481aa72d + name: 1005003 - Expense Test account no cat + value: 0 + items: [] + - accountId: 1d60f4a2-6d19-ed11-90eb-002248009024 + name: 1234512345 - Invalid VAT Posting Setup + value: 0 + items: [] + - name: Interest Expense + value: 0 + items: + - accountId: bd407350-340b-ec11-86bc-0022481a4971 + name: 1093 - export with misc type + value: 0 + items: [] + - accountId: 381217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30300 - Interest Expense + value: 0 + items: [] + - name: Other Income & Expenses + value: 0 + items: + - accountId: 2e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20399 - Job Costs Applied + value: 0 + items: [] + - accountId: 4e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31400 - Office Supplies Expense + value: 0 + items: [] + - accountId: 501217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31500 - Miscellaneous Expense + value: 0 + items: [] + - accountId: 521217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '31600 - Depreciation, Equipment' + value: 0 + items: [] + - accountId: 541217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31900 - Rounding + value: 0 + items: [] + - name: Benefits Expense + value: 0 + items: + - accountId: 57a95f12-9ecf-ec11-8e7e-00224800faf5 + name: 23 - test account + value: 0 + items: [] + - name: Fees Expense + value: 0 + items: + - accountId: 3f6818aa-a4cf-ec11-8e7e-00224800faf5 + name: 30 - test expenses 2 + value: 0 + items: [] + - accountId: 3a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30400 - Bank Charges and Fees + value: 0 + items: [] + - accountId: 3c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30500 - Processing Fees + value: 0 + items: [] + - name: Rent Expense + value: 0 + items: + - accountId: 341217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30100 - Rent Expense + value: 0 + items: [] + - name: Advertising Expense + value: 0 + items: + - accountId: 361217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30200 - Advertising Expense + value: 0 + items: [] + - name: Bad Debt Expense + value: 0 + items: + - accountId: 3e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30600 - Bad Debt Expense + value: 0 + items: [] + - name: Salaries Expense + value: 0 + items: + - accountId: 401217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30700 - Salaries Expense + value: 0 + items: [] + - name: Payroll Expense + value: 0 + items: + - accountId: 421217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30800 - Payroll Tax Expense + value: 0 + items: [] + - accountId: 441217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '30900 - Workers Compensation ' + value: 0 + items: [] + - name: Insurance Expense + value: 41.77 + items: + - accountId: 461217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31000 - Health & Dental Insurance Expense + value: 41.77 + items: [] + - accountId: 481217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31100 - Life Insurance Expense + value: 0 + items: [] + - name: Repairs and Maintenance Expense + value: 0 + items: + - accountId: 4a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31200 - Repairs and Maintenance Expense + value: 0 + items: [] + - name: Utilities Expense + value: 0 + items: + - accountId: 4c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31300 - Utilities Expense + value: 0 + items: [] + - name: Travel Expense + value: 0 + items: + - accountId: 61d17174-61db-ec11-82f9-002248008de8 + name: 999992 - Payhawk General + value: 0 + items: [] + - accountId: 3a37ed38-a6cf-ec11-8e7e-00224800faf5 + name: 999998 - Payhawk General + value: 0 + items: [] + - accountId: 64ee049b-a1cf-ec11-8e7e-00224800faf5 + name: 999999 - Payhawk General + value: 0 + items: [] + netOperatingProfit: -2118.91 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -2118.91 + - fromDate: '2023-02-01T00:00:00' + toDate: '2023-02-28T00:00:00' + income: + name: Income + value: 414.51 + items: + - name: Sales Returns & Allowances + value: -125.17 + items: + - accountId: 8aba49ae-461a-ed11-90eb-000d3a873324 + name: '0121 - ' + value: -125.17 + items: [] + - accountId: 1e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10400 - Sales Returns & Allowances + value: 0 + items: [] + - name: 'Income, Services' + value: -10 + items: + - accountId: ac6a3a74-c69f-ec11-80f1-0022481b4546 + name: 10005-1 - Child + value: -10 + items: [] + - accountId: 161217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '10100 - Income, Services' + value: 0 + items: [] + - name: 'Income, Jobs' + value: -12.91 + items: + - accountId: 1f2618f9-c79f-ec11-80f1-0022481b4546 + name: 10005-2 - Child Child + value: -12.91 + items: [] + - accountId: 1a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10250 - Job Sales + value: 0 + items: [] + - name: '' + value: 0 + items: + - accountId: de1cabee-4a33-ed11-97e8-0022481aa72d + name: 1005002 - Test account no cat 2 + value: 0 + items: [] + - accountId: b74b0c08-aa59-eb11-89f9-00224800a7ae + name: '1006 - Account without category Income ' + value: 0 + items: [] + - accountId: 023a8eba-c12e-ed11-97e8-000d3a8753f5 + name: 3213 - vdfgdf + value: 0 + items: [] + - accountId: aa666f5a-c22e-ed11-97e8-0022480052b7 + name: 'TEST INCOME A/C - ' + value: 0 + items: [] + - name: 'Income, Product Sales' + value: 430.4 + items: + - accountId: 181217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '10200 - Income, Product Sales' + value: 430.4 + items: [] + - name: Sales Discounts + value: 0 + items: + - accountId: 1c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10300 - Sales Discounts + value: 0 + items: [] + - name: Job Sales Contra + value: 0 + items: + - accountId: 201217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10450 - Job Sales Applied + value: 0 + items: [] + - name: Income + value: 132.19 + items: + - accountId: 221217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10500 - Interest Income + value: 132.19 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 328 + items: + - name: Materials + value: 328 + items: + - accountId: 281217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20100 - Cost of Materials + value: 328 + items: [] + - name: Labour + value: 0 + items: + - accountId: 2a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20200 - Cost of Labour + value: 0 + items: [] + - name: Jobs Cost + value: 0 + items: + - accountId: 2c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20300 - Job Costs + value: 0 + items: [] + grossProfit: 86.51 + expenses: + name: Expense + value: 1482.02 + items: + - name: '' + value: 9.52 + items: + - accountId: e9b4e2c2-4b33-ed11-97e8-0022481aa72d + name: 1005003 - Expense Test account no cat + value: 0 + items: [] + - accountId: 1d60f4a2-6d19-ed11-90eb-002248009024 + name: 1234512345 - Invalid VAT Posting Setup + value: 9.52 + items: [] + - name: Interest Expense + value: 0 + items: + - accountId: bd407350-340b-ec11-86bc-0022481a4971 + name: 1093 - export with misc type + value: 0 + items: [] + - accountId: 381217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30300 - Interest Expense + value: 0 + items: [] + - name: Other Income & Expenses + value: 0 + items: + - accountId: 2e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20399 - Job Costs Applied + value: 0 + items: [] + - accountId: 4e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31400 - Office Supplies Expense + value: 0 + items: [] + - accountId: 501217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31500 - Miscellaneous Expense + value: 0 + items: [] + - accountId: 521217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '31600 - Depreciation, Equipment' + value: 0 + items: [] + - accountId: 541217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31900 - Rounding + value: 0 + items: [] + - name: Benefits Expense + value: 0 + items: + - accountId: 57a95f12-9ecf-ec11-8e7e-00224800faf5 + name: 23 - test account + value: 0 + items: [] + - name: Fees Expense + value: 0 + items: + - accountId: 3f6818aa-a4cf-ec11-8e7e-00224800faf5 + name: 30 - test expenses 2 + value: 0 + items: [] + - accountId: 3a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30400 - Bank Charges and Fees + value: 0 + items: [] + - accountId: 3c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30500 - Processing Fees + value: 0 + items: [] + - name: Rent Expense + value: 0 + items: + - accountId: 341217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30100 - Rent Expense + value: 0 + items: [] + - name: Advertising Expense + value: 0 + items: + - accountId: 361217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30200 - Advertising Expense + value: 0 + items: [] + - name: Bad Debt Expense + value: -1.82 + items: + - accountId: 3e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30600 - Bad Debt Expense + value: -1.82 + items: [] + - name: Salaries Expense + value: 0 + items: + - accountId: 401217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30700 - Salaries Expense + value: 0 + items: [] + - name: Payroll Expense + value: 0 + items: + - accountId: 421217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30800 - Payroll Tax Expense + value: 0 + items: [] + - accountId: 441217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '30900 - Workers Compensation ' + value: 0 + items: [] + - name: Insurance Expense + value: 1474.32 + items: + - accountId: 461217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31000 - Health & Dental Insurance Expense + value: 1474.32 + items: [] + - accountId: 481217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31100 - Life Insurance Expense + value: 0 + items: [] + - name: Repairs and Maintenance Expense + value: 0 + items: + - accountId: 4a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31200 - Repairs and Maintenance Expense + value: 0 + items: [] + - name: Utilities Expense + value: 0 + items: + - accountId: 4c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31300 - Utilities Expense + value: 0 + items: [] + - name: Travel Expense + value: 0 + items: + - accountId: 61d17174-61db-ec11-82f9-002248008de8 + name: 999992 - Payhawk General + value: 0 + items: [] + - accountId: 3a37ed38-a6cf-ec11-8e7e-00224800faf5 + name: 999998 - Payhawk General + value: 0 + items: [] + - accountId: 64ee049b-a1cf-ec11-8e7e-00224800faf5 + name: 999999 - Payhawk General + value: 0 + items: [] + netOperatingProfit: -1395.51 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -1395.51 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-03-01T00:00:00' + earliestAvailableMonth: '2021-04-01T00:00:00' + Exact (Netherlands): + value: + reports: + - fromDate: '2022-09-01T00:00:00Z' + toDate: '2022-09-30T00:00:00Z' + income: + name: Income + value: -286 + items: + - accountId: 2421e8a0-5355-4ec0-af11-021fe4f39fcd + name: 8000 - Omzet binnenland hoog tarief + value: -286 + items: [] + - accountId: 0b5b5d8b-1c0c-4767-88d8-c99206da6ace + name: 555777 - Sales + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: -286 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: -286 + otherExpenses: + name: Other Expenses + value: 5.25 + items: + - accountId: e405eff6-5c15-43b9-a5f0-ba592b26fbbe + name: 9410 - Inkoopkortingen + value: 5.25 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: -5.25 + netProfit: -291.25 + - fromDate: '2022-08-01T00:00:00Z' + toDate: '2022-08-31T00:00:00Z' + income: + name: Income + value: 664.73 + items: + - accountId: 2421e8a0-5355-4ec0-af11-021fe4f39fcd + name: 8000 - Omzet binnenland hoog tarief + value: 643.33 + items: [] + - accountId: 62981769-c358-4ee5-aa8a-c9d5c559dd5c + name: 9275 - Activa realisatie verlies + value: -13.6 + items: [] + - accountId: f93008c5-f45b-4200-82a8-d0d5e1584ee7 + name: 1234567 - james_test2 + value: 35 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 664.73 + expenses: + name: Expenses + value: 13.6 + items: + - accountId: 62981769-c358-4ee5-aa8a-c9d5c559dd5c + name: 9275 - Activa realisatie verlies + value: 13.6 + items: [] + netOperatingProfit: 651.13 + otherExpenses: + name: Other Expenses + value: 45 + items: + - accountId: e405eff6-5c15-43b9-a5f0-ba592b26fbbe + name: 9410 - Inkoopkortingen + value: 45 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: -45 + netProfit: 606.13 + reportBasis: Unknown + currency: EUR + mostRecentAvailableMonth: '2022-09-01T00:00:00' + earliestAvailableMonth: '2020-11-01T00:00:00' + Exact (UK): + value: + reports: + - fromDate: '2022-10-01T00:00:00Z' + toDate: '2022-10-31T00:00:00Z' + income: + name: Income + value: -2 + items: + - accountId: 43acd218-6a95-445f-994c-660273e0ced9 + name: 41000 - Sales + value: -2 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: -2 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: -2 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -2 + - fromDate: '2022-09-01T00:00:00Z' + toDate: '2022-09-30T00:00:00Z' + income: + name: Income + value: 208 + items: + - accountId: 43acd218-6a95-445f-994c-660273e0ced9 + name: 41000 - Sales + value: 208 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 208 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 208 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 208 + reportBasis: Unknown + currency: GBP + mostRecentAvailableMonth: '2022-10-01T00:00:00' + earliestAvailableMonth: '2020-11-01T00:00:00' + FreshBooks: + value: + reports: + - fromDate: '2023-04-01T00:00:00' + toDate: '2023-04-30T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 24.05 + items: + - accountId: '3384197' + name: Advertising + value: 0.21 + items: [] + - accountId: '3380421' + name: Car & Truck Expenses + value: 11 + items: [] + - accountId: '3361426' + name: Meals & Entertainment + value: 12.82 + items: [] + - accountId: '3379249' + name: Supplies + value: 0.02 + items: [] + netOperatingProfit: -24.05 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -24.04 + reportBasis: Cash + currency: GBP + mostRecentAvailableMonth: '2023-04-01T00:00:00' + earliestAvailableMonth: '2021-05-01T00:00:00' + KashFlow: + value: + reports: + - fromDate: '2022-09-01T00:00:00' + toDate: '2022-09-30T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost Of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2022-08-01T00:00:00' + toDate: '2022-08-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost Of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + reportBasis: Unknown + currency: GBP + mostRecentAvailableMonth: '2022-09-01T00:00:00' + earliestAvailableMonth: '2020-10-01T00:00:00' + MYOB AccountRight and Essentials: + value: + reports: + - fromDate: '2022-11-01T00:00:00' + toDate: '2022-11-30T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2022-10-01T00:00:00' + toDate: '2022-10-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2022-11-01T00:00:00' + earliestAvailableMonth: '2020-12-01T00:00:00' + Oracle NetSuite: + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: -123.45 + items: + - accountId: '58' + name: Expenses + value: -123.45 + items: [] + netOperatingProfit: 123.45 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 123.45 + - fromDate: '2023-01-01T00:00:00' + toDate: '2023-01-31T00:00:00' + income: + name: Income + value: 11 + items: + - accountId: '108' + name: Shipping and Handling + value: 11 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 11 + expenses: + name: Expenses + value: 11 + items: + - accountId: '58' + name: Expenses + value: 11 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-03-01T00:00:00' + earliestAvailableMonth: '2022-11-01T00:00:00' + QuickBooks Desktop: + value: + reports: + - fromDate: '2023-04-01T00:00:00' + toDate: '2023-04-30T00:00:00' + income: + name: Income + value: 7673.5 + items: + - accountId: 170000-933270541 + name: 40100 � Construction Income + value: 7673.5 + items: + - accountId: 190000-933270541 + name: 40130 � Labor Income + value: 840 + items: [] + - accountId: 1A0000-933270542 + name: 40140 � Materials Income + value: 4103.5 + items: [] + - accountId: 1C0000-933270542 + name: 40150 � Subcontracted Labor Income + value: 2730 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 1729.85 + items: + - accountId: 1E0000-933270542 + name: 50100 � Cost of Goods Sold + value: 329.85 + items: [] + - accountId: 300000-933270542 + name: 54000 � Job Expenses + value: 1400 + items: + - accountId: 340000-933270542 + name: 54500 � Subcontractors + value: 1400 + items: [] + grossProfit: 5943.65 + expenses: + name: Expense + value: 2417.29 + items: + - accountId: 1F0000-933270542 + name: 60100 � Automobile + value: 1066.56 + items: + - accountId: 200000-933270542 + name: 60110 � Fuel + value: 162 + items: [] + - accountId: 580000-1071498064 + name: 60120 � Insurance + value: 712.56 + items: [] + - accountId: 210000-933270542 + name: 60130 � Repairs and Maintenance + value: 192 + items: [] + - accountId: 230000-933270542 + name: 60600 � Bank Service Charges + value: 12.5 + items: [] + - accountId: 290000-933270542 + name: 62100 � Insurance + value: 675 + items: + - accountId: 2A0000-933270542 + name: 62110 � Disability Insurance + value: 50 + items: [] + - accountId: 2B0000-933270542 + name: 62120 � Liability Insurance + value: 350 + items: [] + - accountId: 2C0000-933270542 + name: 62130 � Work Comp + value: 275 + items: [] + - accountId: 2D0000-933270542 + name: 62400 � Interest Expense + value: 438.3 + items: + - accountId: 2F0000-933270542 + name: 62420 � Loan Interest + value: 438.3 + items: [] + - accountId: 480000-933270542 + name: 65100 � Utilities + value: 224.93 + items: + - accountId: 490000-933270542 + name: 65110 � Gas and Electric + value: 120.93 + items: [] + - accountId: 4A0000-933270542 + name: 65120 � Telephone + value: 80 + items: [] + - accountId: 4B0000-933270542 + name: 65130 � Water + value: 24 + items: [] + netOperatingProfit: 3526.36 + otherExpenses: + name: Other Expense + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 3526.36 + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 16500 + items: + - accountId: 170000-933270541 + name: 40100 � Construction Income + value: 16500 + items: + - accountId: 1C0000-933270542 + name: 40150 � Subcontracted Labor Income + value: 16500 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 7500 + items: + - accountId: 300000-933270542 + name: 54000 � Job Expenses + value: 7500 + items: + - accountId: 340000-933270542 + name: 54500 � Subcontractors + value: 7500 + items: [] + grossProfit: 9000 + expenses: + name: Expense + value: 3159.99 + items: + - accountId: 1F0000-933270542 + name: 60100 � Automobile + value: 359 + items: + - accountId: 200000-933270542 + name: 60110 � Fuel + value: 127 + items: [] + - accountId: 210000-933270542 + name: 60130 � Repairs and Maintenance + value: 232 + items: [] + - accountId: 230000-933270542 + name: 60600 � Bank Service Charges + value: 12.5 + items: [] + - accountId: 290000-933270542 + name: 62100 � Insurance + value: 675 + items: + - accountId: 2A0000-933270542 + name: 62110 � Disability Insurance + value: 50 + items: [] + - accountId: 2B0000-933270542 + name: 62120 � Liability Insurance + value: 350 + items: [] + - accountId: 2C0000-933270542 + name: 62130 � Work Comp + value: 275 + items: [] + - accountId: 2D0000-933270542 + name: 62400 � Interest Expense + value: 456.29 + items: + - accountId: 2F0000-933270542 + name: 62420 � Loan Interest + value: 456.29 + items: [] + - accountId: 3D0000-933270542 + name: 64200 � Repairs + value: 1164 + items: + - accountId: 3F0000-933270542 + name: 64220 � Computer Repairs + value: 714 + items: [] + - accountId: 400000-933270542 + name: 64230 � Equipment Repairs + value: 450 + items: [] + - accountId: 480000-933270542 + name: 65100 � Utilities + value: 493.2 + items: + - accountId: 490000-933270542 + name: 65110 � Gas and Electric + value: 389.2 + items: [] + - accountId: 4A0000-933270542 + name: 65120 � Telephone + value: 80 + items: [] + - accountId: 4B0000-933270542 + name: 65130 � Water + value: 24 + items: [] + netOperatingProfit: 5840.01 + otherExpenses: + name: Other Expense + value: 0 + items: [] + otherIncome: + name: Other Income + value: 93.42 + items: + - accountId: 4C0000-933270542 + name: 70200 � Interest Income + value: 93.42 + items: [] + netOtherIncome: 93.42 + netProfit: 5933.43 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-04-01T00:00:00' + earliestAvailableMonth: '2021-05-01T00:00:00' + QuickBooks Online Sandbox: + value: + reports: + - fromDate: '2023-04-01T00:00:00' + toDate: '2023-04-30T00:00:00' + income: + name: Income + value: 35.7 + items: + - accountId: '68' + name: Billable Expenses Income + value: -15 + items: [] + - accountId: '44' + name: Sales + value: 130 + items: [] + - accountId: '66' + name: Sales of Product Income + value: 42.5 + items: [] + - accountId: '1' + name: Services + value: -131.8 + items: [] + - accountId: '149' + name: Shipping Income + value: 10 + items: [] + costOfSales: + name: Cost of Sales + value: -8.16 + items: + - accountId: '67' + name: Cost of sales + value: 33.51 + items: [] + - accountId: '69' + name: Cost of Sales - billable expenses + value: -41.67 + items: [] + grossProfit: 43.86 + expenses: + name: Expenses + value: -987 + items: + - accountId: '148' + name: Billable Test + value: -250 + items: [] + - accountId: '16' + name: Computer and Internet Expenses + value: -897 + items: [] + - accountId: '18' + name: Depreciation Expense + value: 100 + items: [] + - accountId: '19' + name: Dues and Subscriptions + value: -40 + items: [] + - accountId: '64' + name: Purchases + value: 100 + items: [] + netOperatingProfit: 1030.86 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 1030.86 + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 1664.93 + items: + - accountId: '14' + name: Commission Income + value: 64 + items: [] + - accountId: '44' + name: Sales + value: 952.29 + items: [] + - accountId: '43' + name: Sales Discounts + value: 9.05 + items: [] + - accountId: '66' + name: Sales of Product Income + value: 223.52 + items: [] + - accountId: '1' + name: Services + value: 392.32 + items: [] + - accountId: '149' + name: Shipping Income + value: 23.75 + items: [] + costOfSales: + name: Cost of Sales + value: 2568.09 + items: + - accountId: '67' + name: Cost of sales + value: 27.09 + items: [] + - accountId: '69' + name: Cost of Sales - billable expenses + value: 41 + items: [] + - accountId: '10' + name: Entertainment Booking Fees paid on behalf of clients + value: 2500 + items: [] + grossProfit: -903.16 + expenses: + name: Expenses + value: 397.62 + items: + - accountId: '148' + name: Billable Test + value: -35.75 + items: [] + - accountId: '12' + name: Business Licenses and Permits + value: -8 + items: [] + - accountId: '16' + name: Computer and Internet Expenses + value: 42.46 + items: [] + - accountId: '20' + name: Equipment rental + value: -22.76 + items: [] + - accountId: '116' + name: HM Revenue & Customs (VAT) Expense + value: -25.2 + items: [] + - accountId: '24' + name: Insurance Expense + value: 5.32 + items: [] + - accountId: '23' + name: Insurance Expense-Health Insurance + value: -34 + items: [] + - accountId: '31' + name: Marketing Expense + value: -11.56 + items: [] + - accountId: '35' + name: Office Supplies + value: -12.89 + items: [] + - accountId: '64' + name: Purchases + value: 500 + items: [] + netOperatingProfit: -1300.78 + otherExpenses: + name: Other Expenses + value: 11.92 + items: + - accountId: '52' + name: Exchange Gain or Loss + value: 11.92 + items: [] + otherIncome: + name: Other Income + value: 29.41 + items: + - accountId: '21' + name: Finance Charge Income + value: -13.44 + items: [] + - accountId: '27' + name: Insurance Proceeds Received + value: 7.85 + items: [] + - accountId: '29' + name: Interest income + value: 15 + items: [] + - accountId: '39' + name: Proceeds from Sale of Assets + value: 20 + items: [] + netOtherIncome: 17.49 + netProfit: -1283.29 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-04-01T00:00:00' + earliestAvailableMonth: '2021-05-01T00:00:00' + QuickBooks Online: + value: + reports: + - fromDate: '2023-01-01T00:00:00' + toDate: '2023-01-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 4300 + items: + - accountId: '68' + name: 303 HM Revenue & Customs (VAT) Expense + value: 250 + items: [] + - accountId: '22' + name: 408 Travelling expenses + value: 4050 + items: [] + netOperatingProfit: -4300 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -4300 + - fromDate: '2022-12-01T00:00:00' + toDate: '2022-12-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 10 + items: + - accountId: '16' + name: 292 Advertising + value: 10 + items: [] + netOperatingProfit: -10 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -10 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-01-01T00:00:00' + earliestAvailableMonth: '2021-02-01T00:00:00' + Sage 200cloud: + value: + reports: + - fromDate: '2020-12-01T00:00:00Z' + toDate: '2020-12-31T00:00:00Z' + income: + name: Income + value: 0 + items: + - name: Total Sales + value: 0 + items: + - accountId: '101' + name: Product Sales + value: 0 + items: [] + - accountId: '102' + name: Export Sales + value: 0 + items: [] + - accountId: '103' + name: Sales of Assets + value: 0 + items: [] + - accountId: '104' + name: Credit Charges (Late Payments) + value: 0 + items: [] + - accountId: '105' + name: Other Sales + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: + - name: Total Purchases + value: 0 + items: + - accountId: '201' + name: Purchases + value: 0 + items: [] + - accountId: '202' + name: Purchase Charges + value: 0 + items: [] + - accountId: '203' + name: Stock + value: 0 + items: [] + - name: Total Direct Expenses + value: 0 + items: + - accountId: '301' + name: Labour + value: 0 + items: [] + - accountId: '302' + name: Commissions + value: 0 + items: [] + - accountId: '303' + name: Sales Promotion + value: 0 + items: [] + - accountId: '304' + name: Miscellaneous Expenses + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: + - name: Total Overheads + value: 0 + items: + - accountId: '401' + name: Gross Wages + value: 0 + items: [] + - accountId: '402' + name: Rent and Rates + value: 0 + items: [] + - accountId: '403' + name: 'Heat, Light and Power' + value: 0 + items: [] + - accountId: '404' + name: Motor Expenses + value: 0 + items: [] + - accountId: '405' + name: Travelling and Entertainment + value: 0 + items: [] + - accountId: '406' + name: Printing and Stationery + value: 0 + items: [] + - accountId: '407' + name: Professional Fees + value: 0 + items: [] + - accountId: '408' + name: Equipment Hire and Rental + value: 0 + items: [] + - accountId: '409' + name: Maintenance + value: 0 + items: [] + - accountId: '410' + name: Bank Charges and Interest + value: 0 + items: [] + - accountId: '411' + name: Depreciation + value: 0 + items: [] + - accountId: '412' + name: Bad Debts + value: 0 + items: [] + - accountId: '413' + name: General Expenses + value: 0 + items: [] + - accountId: '414' + name: Suspense & Mispostings + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: + - accountId: '10,1001' + name: Taxation + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2020-11-01T00:00:00Z' + toDate: '2020-11-30T00:00:00Z' + income: + name: Income + value: 0 + items: + - name: Total Sales + value: 0 + items: + - accountId: '101' + name: Product Sales + value: 0 + items: [] + - accountId: '102' + name: Export Sales + value: 0 + items: [] + - accountId: '103' + name: Sales of Assets + value: 0 + items: [] + - accountId: '104' + name: Credit Charges (Late Payments) + value: 0 + items: [] + - accountId: '105' + name: Other Sales + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: + - name: Total Purchases + value: 0 + items: + - accountId: '201' + name: Purchases + value: 0 + items: [] + - accountId: '202' + name: Purchase Charges + value: 0 + items: [] + - accountId: '203' + name: Stock + value: 0 + items: [] + - name: Total Direct Expenses + value: 0 + items: + - accountId: '301' + name: Labour + value: 0 + items: [] + - accountId: '302' + name: Commissions + value: 0 + items: [] + - accountId: '303' + name: Sales Promotion + value: 0 + items: [] + - accountId: '304' + name: Miscellaneous Expenses + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: + - name: Total Overheads + value: 0 + items: + - accountId: '401' + name: Gross Wages + value: 0 + items: [] + - accountId: '402' + name: Rent and Rates + value: 0 + items: [] + - accountId: '403' + name: 'Heat, Light and Power' + value: 0 + items: [] + - accountId: '404' + name: Motor Expenses + value: 0 + items: [] + - accountId: '405' + name: Travelling and Entertainment + value: 0 + items: [] + - accountId: '406' + name: Printing and Stationery + value: 0 + items: [] + - accountId: '407' + name: Professional Fees + value: 0 + items: [] + - accountId: '408' + name: Equipment Hire and Rental + value: 0 + items: [] + - accountId: '409' + name: Maintenance + value: 0 + items: [] + - accountId: '410' + name: Bank Charges and Interest + value: 0 + items: [] + - accountId: '411' + name: Depreciation + value: 0 + items: [] + - accountId: '412' + name: Bad Debts + value: 0 + items: [] + - accountId: '413' + name: General Expenses + value: 0 + items: [] + - accountId: '414' + name: Suspense & Mispostings + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: + - accountId: '10,1001' + name: Taxation + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2020-12-01T00:00:00' + earliestAvailableMonth: '2015-01-01T00:00:00' + Sage 50 (UK): + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2023-02-01T00:00:00' + toDate: '2023-02-28T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + reportBasis: Unknown + currency: GBP + mostRecentAvailableMonth: '2023-03-01T00:00:00' + earliestAvailableMonth: '2021-04-01T00:00:00' + Sage Business Cloud Accounting: + value: + reports: + - fromDate: '2022-10-01T00:00:00' + toDate: '2022-10-31T00:00:00' + income: + name: Income + value: -7749 + items: + - accountId: 9a994b92267a11e797950a57719b2edb + name: 4000 - Sales Type A + value: -7740 + items: [] + - accountId: 9a994e06267a11e797950a57719b2edb + name: 4009 - Sales Discounts + value: -9 + items: [] + costOfSales: + name: Cost of Sales + value: 11602000 + items: + - accountId: 9a995955267a11e797950a57719b2edb + name: 5000 - Cost of sales - goods + value: 11602000 + items: [] + grossProfit: -11609749 + expenses: + name: Expenses + value: -1.83 + items: + - accountId: 9a99a91c267a11e797950a57719b2edb + name: 8211 - Exchange rate gain/(loss) + value: -1.83 + items: [] + netOperatingProfit: -11609747.17 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -11609747.17 + - fromDate: '2022-09-01T00:00:00' + toDate: '2022-09-30T00:00:00' + income: + name: Income + value: 501 + items: + - accountId: 9a994b92267a11e797950a57719b2edb + name: 4000 - Sales Type A + value: 511 + items: [] + - accountId: 9a994e06267a11e797950a57719b2edb + name: 4009 - Sales Discounts + value: -10 + items: [] + costOfSales: + name: Cost of Sales + value: 13220073.7 + items: + - accountId: 9a995955267a11e797950a57719b2edb + name: 5000 - Cost of sales - goods + value: 13220073.7 + items: [] + grossProfit: -13219572.7 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: -13219572.7 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: -148.34 + items: + - accountId: 9a995491267a11e797950a57719b2edb + name: 4900 - Other income + value: -148.34 + items: [] + netOtherIncome: -148.34 + netProfit: -13219721.04 + reportBasis: Unknown + currency: GBP + mostRecentAvailableMonth: '2022-10-01T00:00:00' + earliestAvailableMonth: '2020-11-01T00:00:00' + Wave: + value: + reports: + - fromDate: '2022-11-01T00:00:00' + toDate: '2022-11-30T00:00:00' + income: + name: Income + value: 7.01 + items: + - name: Unrealized Gain on Foreign Exchange + value: 7.01 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 0 + items: [] + grossProfit: 7.01 + expenses: + name: Operating Expenses + value: 555 + items: + - name: Office Supplies + value: 555 + items: [] + netOperatingProfit: -547.99 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -547.99 + - fromDate: '2022-10-01T00:00:00' + toDate: '2022-10-31T00:00:00' + income: + name: Income + value: 8.36 + items: + - name: Unrealized Gain on Foreign Exchange + value: 8.36 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 0 + items: [] + grossProfit: 8.36 + expenses: + name: Operating Expenses + value: 0 + items: [] + netOperatingProfit: 8.36 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 8.36 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2022-11-01T00:00:00' + earliestAvailableMonth: '2020-12-01T00:00:00' + Xero: + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2023-02-01T00:00:00' + toDate: '2023-02-28T00:00:00' + income: + name: Income + value: 14496.51 + items: + - accountId: c563b607-fb0e-4d06-9ddb-76fdeef20ae3 + name: Sales + value: 14496.51 + items: [] + costOfSales: + name: Cost of Sales + value: 700 + items: + - accountId: 127f3b99-8dc2-4b7e-854c-91ef9bd2757b + name: Purchases + value: 700 + items: [] + grossProfit: 13796.51 + expenses: + name: Expenses + value: 2026.92 + items: + - accountId: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + value: 215.87 + items: [] + - accountId: d50842c3-af67-4233-b8c9-df3180f5b7bd + name: 'Light, Power, Heating' + value: 103.43 + items: [] + - accountId: 0be1631e-cc7e-4c27-951f-308c3307c0fe + name: Motor Vehicle Expenses + value: 342.79 + items: [] + - accountId: a49cc958-968e-4b54-96d6-8853c036009e + name: 'Postage, Freight & Courier' + value: 94.19 + items: [] + - accountId: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + value: 24.58 + items: [] + - accountId: dae8e236-24bb-4a7a-9787-c5fd89385e03 + name: Rent + value: 984.38 + items: [] + - accountId: a40f43e2-c7b0-4187-919a-04ccdc14a630 + name: Subscriptions + value: 14.9 + items: [] + - accountId: f3c73c3d-9887-4377-b18b-0374ab62e4aa + name: Telephone & Internet + value: 45.11 + items: [] + - accountId: c7b73345-7f25-428a-bb97-7b20a1470a53 + name: Travel - National + value: 201.67 + items: [] + netOperatingProfit: 11769.59 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 11769.59 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-03-01T00:00:00' + earliestAvailableMonth: '2021-04-01T00:00:00' + Zoho Books: + value: + reports: + - fromDate: '2022-10-01T00:00:00' + toDate: '2022-10-31T00:00:00' + income: + name: Operating Income + value: 0 + items: + - accountId: '104957000000000394' + name: Discount + value: 0 + items: [] + - accountId: '104957000000000379' + name: General Income + value: 0 + items: [] + - accountId: '104957000000099070' + name: General Income Child Test + value: 0 + items: [] + - accountId: '104957000000000382' + name: Interest Income + value: 0 + items: [] + - accountId: '104957000000000385' + name: Late Fee Income + value: 0 + items: [] + - accountId: '104957000000000503' + name: Other Charges + value: 0 + items: [] + - accountId: '104957000000000376' + name: Sales + value: 0 + items: [] + - accountId: '104957000000000506' + name: Shipping Charge + value: 0 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 0 + items: + - accountId: '104957000000000509' + name: Cost of Goods Sold + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Operating Expense + value: 0 + items: + - accountId: '104957000000000391' + name: Advertising And Marketing + value: 0 + items: [] + - accountId: '104957000000000406' + name: Air Travel Expense + value: 0 + items: [] + - accountId: '104957000000000412' + name: Automobile Expense + value: 0 + items: [] + - accountId: '104957000000000427' + name: Bad Debt + value: 0 + items: [] + - accountId: '104957000000000397' + name: Bank Fees and Charges + value: 0 + items: [] + - accountId: '104957000000000442' + name: Consultant Expense + value: 0 + items: [] + - accountId: '104957000000000400' + name: Credit Card Charges + value: 0 + items: [] + - accountId: '104957000000000439' + name: Depreciation Expense + value: 0 + items: [] + - accountId: '104957000000243027' + name: Fuel/Mileage Expenses + value: 0 + items: [] + - accountId: '104957000000000415' + name: IT and Internet Expenses + value: 0 + items: [] + - accountId: '104957000000000421' + name: Janitorial Expense + value: 0 + items: [] + - accountId: '104957000000000454' + name: Lodging + value: 0 + items: [] + - accountId: '104957000000000436' + name: Meals and Entertainment + value: 0 + items: [] + - accountId: '104957000000000388' + name: Office Supplies + value: 0 + items: [] + - accountId: '104957000000000448' + name: Other Expenses + value: 0 + items: [] + - accountId: '104957000000000424' + name: Postage + value: 0 + items: [] + - accountId: '104957000000000430' + name: Printing and Stationery + value: 0 + items: [] + - accountId: '104957000000639102' + name: Purchase Discounts + value: 0 + items: [] + - accountId: '104957000000000418' + name: Rent Expense + value: 0 + items: [] + - accountId: '104957000000000445' + name: Repairs and Maintenance + value: 0 + items: [] + - accountId: '104957000000000433' + name: Salaries and Employee Wages + value: 0 + items: [] + - accountId: '104957000000000409' + name: Telephone Expense + value: 0 + items: [] + - accountId: '104957000000000463' + name: Uncategorized + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Non Operating Expense + value: 0 + items: + - accountId: '104957000000000403' + name: Exchange Gain or Loss + value: 0 + items: [] + - accountId: '104957000000099003' + name: Insurance Expenses (Test Other Expense) + value: 0 + items: [] + otherIncome: + name: Non Operating Income + value: 0 + items: + - accountId: '104957000000054032' + name: Flat Rate Profit + value: 0 + items: [] + - accountId: '104957000000099009' + name: Interest Earned (Test Other Income) + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2022-09-01T00:00:00' + toDate: '2022-09-30T00:00:00' + income: + name: Operating Income + value: 69 + items: + - accountId: '104957000000000394' + name: Discount + value: 0 + items: [] + - accountId: '104957000000000379' + name: General Income + value: 0 + items: [] + - accountId: '104957000000099070' + name: General Income Child Test + value: 0 + items: [] + - accountId: '104957000000000382' + name: Interest Income + value: 0 + items: [] + - accountId: '104957000000000385' + name: Late Fee Income + value: 0 + items: [] + - accountId: '104957000000000503' + name: Other Charges + value: 0 + items: [] + - accountId: '104957000000000376' + name: Sales + value: 69 + items: [] + - accountId: '104957000000000506' + name: Shipping Charge + value: 0 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 35 + items: + - accountId: '104957000000000509' + name: Cost of Goods Sold + value: 35 + items: [] + grossProfit: 34 + expenses: + name: Operating Expense + value: 69 + items: + - accountId: '104957000000000391' + name: Advertising And Marketing + value: 0 + items: [] + - accountId: '104957000000000406' + name: Air Travel Expense + value: 0 + items: [] + - accountId: '104957000000000412' + name: Automobile Expense + value: 0 + items: [] + - accountId: '104957000000000427' + name: Bad Debt + value: 69 + items: [] + - accountId: '104957000000000397' + name: Bank Fees and Charges + value: 0 + items: [] + - accountId: '104957000000000442' + name: Consultant Expense + value: 0 + items: [] + - accountId: '104957000000000400' + name: Credit Card Charges + value: 0 + items: [] + - accountId: '104957000000000439' + name: Depreciation Expense + value: 0 + items: [] + - accountId: '104957000000243027' + name: Fuel/Mileage Expenses + value: 0 + items: [] + - accountId: '104957000000000415' + name: IT and Internet Expenses + value: 0 + items: [] + - accountId: '104957000000000421' + name: Janitorial Expense + value: 0 + items: [] + - accountId: '104957000000000454' + name: Lodging + value: 0 + items: [] + - accountId: '104957000000000436' + name: Meals and Entertainment + value: 0 + items: [] + - accountId: '104957000000000388' + name: Office Supplies + value: 0 + items: [] + - accountId: '104957000000000448' + name: Other Expenses + value: 0 + items: [] + - accountId: '104957000000000424' + name: Postage + value: 0 + items: [] + - accountId: '104957000000000430' + name: Printing and Stationery + value: 0 + items: [] + - accountId: '104957000000639102' + name: Purchase Discounts + value: 0 + items: [] + - accountId: '104957000000000418' + name: Rent Expense + value: 0 + items: [] + - accountId: '104957000000000445' + name: Repairs and Maintenance + value: 0 + items: [] + - accountId: '104957000000000433' + name: Salaries and Employee Wages + value: 0 + items: [] + - accountId: '104957000000000409' + name: Telephone Expense + value: 0 + items: [] + - accountId: '104957000000000463' + name: Uncategorized + value: 0 + items: [] + netOperatingProfit: -35 + otherExpenses: + name: Non Operating Expense + value: 0 + items: + - accountId: '104957000000000403' + name: Exchange Gain or Loss + value: 0 + items: [] + - accountId: '104957000000099003' + name: Insurance Expenses (Test Other Expense) + value: 0 + items: [] + otherIncome: + name: Non Operating Income + value: 0 + items: + - accountId: '104957000000054032' + name: Flat Rate Profit + value: 0 + items: [] + - accountId: '104957000000099009' + name: Interest Earned (Test Other Income) + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -35 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2022-10-01T00:00:00' + earliestAvailableMonth: '2020-11-01T00:00:00' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/financials/cashFlowStatement': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Financial statements + summary: Get cash flow statement + description: Gets the latest cash flow statement for a company. + operationId: get-accounting-cash-flow-statement + x-speakeasy-group: financial-statements.cash-flow + parameters: + - $ref: '#/components/parameters/accountingPeriodLength' + - $ref: '#/components/parameters/accountingPeriodsToCompare' + - $ref: '#/components/parameters/accountingStartMonth' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCashFlowStatement' + examples: + Clear Books: + value: + reports: + - fromDate: '2021-02-01T00:00:00' + toDate: '2021-02-28T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 18377.72 + items: + - accountId: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + name: Accounts Receivable + value: 11417.63 + items: [] + - accountId: 72df89d2-512b-4455-af51-a6b563733842 + name: Income + value: 6960.09 + items: [] + - accountId: 68794a8f-b22d-4520-b97b-025b7cb10f94 + name: Other Income + value: 0 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: 12377.81 + items: + - accountId: 53bf27a7-7497-4c61-9887-dfaad5c6d80a + name: Accounts Payable + value: 7479.21 + items: [] + - accountId: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Cost of Sales + value: 700 + items: [] + - accountId: e6f7e297-59d6-4bd5-9353-478ee9b39685 + name: Expenses + value: 4198.6 + items: [] + - accountId: b5e801e8-8dbc-4390-ac99-3b0fff54a89f + name: Other Expenses + value: 0 + items: [] + - fromDate: '2021-01-01T00:00:00' + toDate: '2021-01-31T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 14508.56 + items: + - accountId: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + name: Accounts Receivable + value: 3055.53 + items: [] + - accountId: 72df89d2-512b-4455-af51-a6b563733842 + name: Income + value: 11453.03 + items: [] + - accountId: 68794a8f-b22d-4520-b97b-025b7cb10f94 + name: Other Income + value: 0 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: 18902.85 + items: + - accountId: 53bf27a7-7497-4c61-9887-dfaad5c6d80a + name: Accounts Payable + value: 9673.66 + items: [] + - accountId: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Cost of Sales + value: 1250 + items: [] + - accountId: e6f7e297-59d6-4bd5-9353-478ee9b39685 + name: Expenses + value: 7979.19 + items: [] + - accountId: b5e801e8-8dbc-4390-ac99-3b0fff54a89f + name: Other Expenses + value: 0 + items: [] + reportBasis: Cash + reportInput: Direct + currency: GBP + mostRecentAvailableMonth: '2021-02-28T00:00:00' + earliestAvailableMonth: '2019-03-01T00:00:00' + FreshBooks: + value: + reports: + - fromDate: '2023-04-01T00:00:00' + toDate: '2023-04-30T00:00:00' + cashReceipts: + accountId: CashReceipts + name: CashReceipts + value: 0 + items: [] + cashPayments: + accountId: CashPayments + name: CashPayments + value: 0 + items: [] + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + cashReceipts: + accountId: CashReceipts + name: CashReceipts + value: 0 + items: [] + cashPayments: + accountId: CashPayments + name: CashPayments + value: 0 + items: [] + reportBasis: Cash + reportInput: Indirect + currency: GBP + mostRecentAvailableMonth: '2023-04-30T00:00:00' + earliestAvailableMonth: '2021-05-01T00:00:00' + QuickBooks Online Sandbox: + value: + reports: + - fromDate: '2023-04-01T00:00:00' + toDate: '2023-04-30T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 754.59 + items: + - accountId: income + name: Income + value: 729.59 + items: [] + - accountId: accountsReceivable + name: Accounts Receivable + value: 25 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: -987.94 + items: + - accountId: costOfSales + name: Cost of Sales + value: 24.06 + items: [] + - accountId: expenses + name: Expenses + value: -1012 + items: [] + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 1776.25 + items: + - accountId: income + name: Income + value: 1652.12 + items: [] + - accountId: accountsReceivable + name: Accounts Receivable + value: 124.13 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: 2494.43 + items: + - accountId: costOfSales + name: Cost of Sales + value: 2562 + items: [] + - accountId: accountsPayable + name: Accounts Payable + value: 38.02 + items: [] + - accountId: expenses + name: Expenses + value: -105.59 + items: [] + reportBasis: Cash + reportInput: Direct + currency: GBP + mostRecentAvailableMonth: '2023-04-30T00:00:00' + earliestAvailableMonth: '2021-05-01T00:00:00' + QuickBooks Online: + value: + reports: + - fromDate: '2023-01-01T00:00:00' + toDate: '2023-01-31T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 0 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: 4300 + items: + - accountId: expenses + name: Expenses + value: 4300 + items: [] + - fromDate: '2022-12-01T00:00:00' + toDate: '2022-12-31T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 0 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: 10 + items: + - accountId: expenses + name: Expenses + value: 10 + items: [] + reportBasis: Cash + reportInput: Direct + currency: GBP + mostRecentAvailableMonth: '2023-01-31T00:00:00' + earliestAvailableMonth: '2021-02-01T00:00:00' + Xero: + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T23:59:59.9999999' + cashReceipts: + accountId: cashReceipt + name: Cash Receipts + value: 0 + items: [] + cashPayments: + accountId: cashPayment + name: Cash Payments + value: 0 + items: [] + - fromDate: '2023-02-01T00:00:00' + toDate: '2023-02-28T23:59:59.9999999' + cashReceipts: + accountId: cashReceipt + name: Cash Receipts + value: 0 + items: [] + cashPayments: + accountId: cashPayment + name: Cash Payments + value: 0 + items: [] + reportBasis: Cash + reportInput: Direct + currency: GBP + mostRecentAvailableMonth: '2023-03-31T00:00:00' + earliestAvailableMonth: '2021-04-01T00:00:00' + Zoho Books: + value: + reports: + - fromDate: '2022-10-01T00:00:00' + toDate: '2022-10-31T00:00:00' + cashReceipts: + accountId: receipts + name: Cash Receipts + value: 0 + items: + - accountId: income + name: Net Income + value: 0 + items: [] + - accountId: '104957000000000352' + name: Accounts Receivable + value: 0 + items: [] + - accountId: '104957000000000358' + name: Advance Tax + value: 0 + items: [] + - accountId: '104957000000618001' + name: Creadit Card - BA Company + value: 0 + items: [] + - accountId: '104957000000183010' + name: Credit Card + value: 0 + items: [] + - accountId: '104957000000000460' + name: Employee Reimbursements + value: 0 + items: [] + - accountId: '104957000000033015' + name: Input VAT + value: 0 + items: [] + - accountId: '104957000000000511' + name: Inventory Asset + value: 0 + items: [] + - accountId: '104957000000033017' + name: Output VAT + value: 0 + items: [] + - accountId: '104957000000032010' + name: Prepaid Expenses + value: 0 + items: [] + - accountId: '104957000000006001' + name: Tag Adjustments + value: 0 + items: [] + - accountId: '104957000000085001' + name: Test stock account + value: 0 + items: [] + - accountId: '104957000000000501' + name: Unearned Revenue + value: 0 + items: [] + cashPayments: + accountId: payments + name: Cash Payments + value: 0 + items: + - accountId: '104957000000000361' + name: Accounts Payable + value: 0 + items: [] + - fromDate: '2022-09-01T00:00:00' + toDate: '2022-09-30T00:00:00' + cashReceipts: + accountId: receipts + name: Cash Receipts + value: -5 + items: + - accountId: income + name: Net Income + value: -35 + items: [] + - accountId: '104957000000000352' + name: Accounts Receivable + value: 30 + items: [] + - accountId: '104957000000000358' + name: Advance Tax + value: 0 + items: [] + - accountId: '104957000000618001' + name: Creadit Card - BA Company + value: 0 + items: [] + - accountId: '104957000000183010' + name: Credit Card + value: 0 + items: [] + - accountId: '104957000000000460' + name: Employee Reimbursements + value: 0 + items: [] + - accountId: '104957000000000511' + name: Inventory Asset + value: 0 + items: [] + - accountId: '104957000000033017' + name: Output VAT + value: 0 + items: [] + - accountId: '104957000000032010' + name: Prepaid Expenses + value: 0 + items: [] + - accountId: '104957000000006001' + name: Tag Adjustments + value: 0 + items: [] + - accountId: '104957000000085001' + name: Test stock account + value: 0 + items: [] + - accountId: '104957000000000501' + name: Unearned Revenue + value: 0 + items: [] + cashPayments: + accountId: payments + name: Cash Payments + value: 7 + items: + - accountId: '104957000000000361' + name: Accounts Payable + value: 0 + items: [] + - accountId: '104957000000033015' + name: Input VAT + value: 7 + items: [] + reportBasis: Accrual + reportInput: Indirect + currency: GBP + mostRecentAvailableMonth: '2022-10-31T00:00:00' + earliestAvailableMonth: '2019-11-01T00:00:00' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/banking-accountBalances': + get: + tags: + - Bank statements + summary: List account balances + operationId: list-banking-account-balances + x-speakeasy-group: banking.account-balances + description: |- + The *List account balances* endpoint returns a list of [account balances](https://docs.codat.io/lending-api#/schemas/AccountBalance) for a given company's connection. + + [Account balances](https://docs.codat.io/lending-api#/schemas/AccountBalance) are balances for a bank account, including end-of-day batch balance or running balances per transaction. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingAccountBalances' + examples: + Basiq: + value: + results: + - accountId: 4811e776-6187-48d9-afee-635fb0d89d93 + balance: + current: 11389.85 + date: '2017-12-31T00:00:00Z' + modifiedDate: '2022-10-28T07:15:07Z' + - accountId: 4811e776-6187-48d9-afee-635fb0d89d93 + balance: + current: 8002.09 + date: '2018-01-01T00:00:00Z' + modifiedDate: '2022-10-28T07:15:07Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3103 + _links: + current: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accountBalances?page=1&pageSize=2 + self: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accountBalances + next: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accountBalances?page=2&pageSize=2 + Plaid: + value: + results: + - accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + balance: + current: 205.78 + date: '2022-10-13T00:00:00' + modifiedDate: '2022-10-27T10:50:16Z' + - accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + balance: + current: 205.78 + date: '2022-10-14T00:00:00' + modifiedDate: '2022-10-27T10:50:16Z' + pageNumber: 1 + pageSize: 2 + totalResults: 14 + _links: + current: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accountBalances?page=1&pageSize=2 + self: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accountBalances + next: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accountBalances?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/banking-accounts': + get: + tags: + - Bank statements + summary: List accounts + operationId: list-banking-accounts + x-speakeasy-group: banking.accounts + description: |- + The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/lending-api#/schemas/Account) for a given company's connection. + + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) 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/lending-api#/operations/refresh-company-data). + + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingAccounts' + examples: + Basiq: + value: + results: + - id: 4811e776-6187-48d9-afee-635fb0d89d93 + name: Hooli Saver + holder: david smith + type: Debit + balance: + available: 2932.85 + current: 2932.85 + identifiers: + type: Account + number: '14293919644182' + bankCode: 416-982 + currency: AUD + institution: + id: AU00000 + name: Hooli Bank + modifiedDate: '2022-10-28T07:14:48Z' + sourceModifiedDate: '2022-10-27T13:00:00Z' + accountName: Hooli Saver + accountHolder: david smith + accountType: Debit + accountNumbers: + type: Account + number: '14293919644182' + bankCode: 416-982 + - id: 736d90a5-f836-4ae0-a161-1e8056f39701 + name: Standard Variable Rate Home Loan + holder: david smith + type: Credit + balance: + available: 6940.31 + current: 6940.31 + identifiers: + type: Loan + number: '14293919644183' + bankCode: 416-982 + currency: AUD + institution: + id: AU00000 + name: Hooli Bank + modifiedDate: '2022-10-28T07:14:48Z' + sourceModifiedDate: '2022-10-27T13:00:00Z' + accountName: Standard Variable Rate Home Loan + accountHolder: david smith + accountType: Credit + accountNumbers: + type: Loan + number: '14293919644183' + bankCode: 416-982 + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accounts?page=1&pageSize=2 + self: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accounts + next: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accounts?page=2&pageSize=2 + Plaid: + value: + results: + - id: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + name: Plaid Silver Standard 0.1% Interest Saving + informalName: Plaid Saving + type: Debit + balance: + available: 200 + current: 210 + identifiers: + type: Depository + number: '1111222233331111' + bankCode: '00021' + maskedAccountNumber: '1111' + currency: CAD + institution: + id: ins_100533 + name: American Express (CA) + modifiedDate: '2022-10-27T10:50:16Z' + accountName: Plaid Silver Standard 0.1% Interest Saving + accountType: Debit + accountNumbers: + type: Depository + number: '1111222233331111' + bankCode: '00021' + maskedAccountNumber: '1111' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accounts?page=1&pageSize=2 + self: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accounts + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/banking-accounts/{accountId}': + get: + tags: + - Bank statements + summary: Get account + operationId: get-banking-account + x-speakeasy-group: banking.accounts + description: |- + The *Get account* endpoint returns a single account for a given accountId. + + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) 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/lending-api#/operations/refresh-company-data). + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingAccountId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingAccount' + examples: + Basiq: + value: + id: 4811e776-6187-48d9-afee-635fb0d89d93 + name: Hooli Saver + holder: david smith + type: Debit + balance: + available: 2932.85 + current: 2932.85 + identifiers: + type: Account + number: '14293919644182' + bankCode: 416-982 + currency: AUD + institution: + id: AU00000 + name: Hooli Bank + modifiedDate: '2022-10-28T07:14:48Z' + sourceModifiedDate: '2022-10-27T13:00:00Z' + accountName: Hooli Saver + accountHolder: david smith + accountType: Debit + accountNumbers: + type: Account + number: '14293919644182' + bankCode: 416-982 + Plaid: + value: + id: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + name: Plaid Silver Standard 0.1% Interest Saving + informalName: Plaid Saving + type: Debit + balance: + available: 200 + current: 210 + identifiers: + type: Depository + number: '1111222233331111' + bankCode: '00021' + maskedAccountNumber: '1111' + currency: CAD + institution: + id: ins_100533 + name: American Express (CA) + modifiedDate: '2022-10-27T10:50:16Z' + accountName: Plaid Silver Standard 0.1% Interest Saving + accountType: Debit + accountNumbers: + type: Depository + number: '1111222233331111' + bankCode: '00021' + maskedAccountNumber: '1111' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/banking-transactions': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Bank statements + operationId: list-banking-transactions + x-speakeasy-group: banking.transactions + summary: List transactions + description: |- + The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/lending-api#/schemas/Transaction) for a given company's connection. + + [Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + x-speakeasy-usage-example: true + schema: + $ref: '#/components/schemas/BankingTransactions' + examples: + Basiq: + value: + results: + - id: 00017a94-c681-448d-ba8d-585a81b4128f + accountId: feb76128-7650-4b02-a323-e1606146be0c + description: 'RENTALCARTOLLPH131865 PARRAMATTA AU Card xx0399 Value Date: 25/07/2019' + amount: -14.26 + currency: AUD + postedDate: '2019-07-31T00:00:00Z' + code: Unknown + merchantName: '' + transactionCategoryRef: + id: payment + name: Payment + modifiedDate: '2022-10-28T07:15:10Z' + - id: 0023c431-35c8-41f5-b75e-9239413cde7e + accountId: 4811e776-6187-48d9-afee-635fb0d89d93 + description: Transfer from xx9263 CommBank app Shop + amount: 191 + currency: AUD + postedDate: '2018-07-31T00:00:00Z' + code: Unknown + merchantName: '' + transactionCategoryRef: + id: transfer + name: Transfer + modifiedDate: '2022-10-28T07:15:10Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3319 + _links: + current: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactions?page=1&pageSize=2 + self: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactions + next: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactions?page=2&pageSize=2 + Plaid: + value: + results: + - id: 1514wvMMajumgG7xWA1Bt8o15xP5k3fmeo9Bg_EC6E0DC820E1F9D1A2300BF4A5B80513 + accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + description: CREDIT CARD 3333 PAYMENT *// + amount: -25 + currency: CAD + postedDate: '2021-05-10T00:00:00' + authorizedDate: '2021-05-09T00:00:00' + code: Unknown + transactionCategoryRef: + id: TRANSFER_OUT.TRANSFER_OUT_ACCOUNT_TRANSFER + name: TRANSFER_OUT_ACCOUNT_TRANSFER + modifiedDate: '2022-10-27T10:50:25Z' + - id: 1514wvMMajumgG7xWA1Bt8oDLxlpm3i3zraD7_6DB63D1DACF6F5824C80F8BE2E066DB5 + accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + description: CREDIT CARD 3333 PAYMENT *// + amount: -25 + currency: CAD + postedDate: '2022-10-02T00:00:00' + authorizedDate: '2022-10-01T00:00:00' + code: Unknown + transactionCategoryRef: + id: TRANSFER_OUT.TRANSFER_OUT_ACCOUNT_TRANSFER + name: TRANSFER_OUT_ACCOUNT_TRANSFER + modifiedDate: '2022-10-27T10:50:25Z' + pageNumber: 1 + pageSize: 2 + totalResults: 49 + _links: + current: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactions?page=1&pageSize=2 + self: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactions + next: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactions?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/banking-transactions/{transactionId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - schema: + type: string + name: transactionId + in: path + required: true + description: The unique identifier for a transaction + get: + summary: Get bank transaction + tags: + - Bank statements + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingTransaction' + examples: + Basiq: + value: + id: 00017a94-c681-448d-ba8d-585a81b4128f + accountId: feb76128-7650-4b02-a323-e1606146be0c + description: 'RENTALCARTOLLPH131865 PARRAMATTA AU Card xx0399 Value Date: 25/07/2019' + amount: -14.26 + currency: AUD + postedDate: '2019-07-31T00:00:00Z' + code: Unknown + merchantName: '' + transactionCategoryRef: + id: payment + name: Payment + modifiedDate: '2022-10-28T07:15:10Z' + Plaid: + value: + id: 1514wvMMajumgG7xWA1Bt8o15xP5k3fmeo9Bg_EC6E0DC820E1F9D1A2300BF4A5B80513 + accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + description: CREDIT CARD 3333 PAYMENT *// + amount: -25 + currency: CAD + postedDate: '2021-05-10T00:00:00' + authorizedDate: '2021-05-09T00:00:00' + code: Unknown + transactionCategoryRef: + id: TRANSFER_OUT.TRANSFER_OUT_ACCOUNT_TRANSFER + name: TRANSFER_OUT_ACCOUNT_TRANSFER + modifiedDate: '2022-10-27T10:50:25Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get transaction* endpoint returns a single transaction for a given transactionId. + + [Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-banking-transaction + x-speakeasy-group: banking.transactions + '/companies/{companyId}/connections/{connectionId}/data/banking-transactionCategories': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Bank statements + operationId: list-banking-transaction-categories + x-speakeasy-group: banking.transaction-categories + summary: List transaction categories + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingTransactionCategories' + examples: + Basiq: + value: + results: + - id: bank-fee + name: Bank Fee + hasChildren: false + status: Active + modifiedDate: '2022-10-28T07:14:46' + - id: cash-withdrawal + name: Cash Withdrawal + hasChildren: false + status: Active + modifiedDate: '2022-10-28T07:14:46' + pageNumber: 1 + pageSize: 2 + totalResults: 9 + _links: + current: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactionCategories?page=1&pageSize=2 + self: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactionCategories + next: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactionCategories?page=2&pageSize=2 + Plaid: + value: + results: + - id: BANK_FEES + name: BANK_FEES + hasChildren: true + status: Active + modifiedDate: '2022-10-27T10:50:17' + - id: BANK_FEES.BANK_FEES_ATM_FEES + name: BANK_FEES_ATM_FEES + parentId: BANK_FEES + hasChildren: false + status: Active + modifiedDate: '2022-10-27T10:50:17' + pageNumber: 1 + pageSize: 2 + totalResults: 120 + _links: + current: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactionCategories?page=1&pageSize=2 + self: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactionCategories + next: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactionCategories?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List transaction categories* endpoint returns a list of [transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) for a given company's connection. + + [Transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + '/companies/{companyId}/connections/{connectionId}/data/banking-transactionCategories/{transactionCategoryId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - schema: + type: string + name: transactionCategoryId + in: path + required: true + description: The unique identifier for a banking transaction category + get: + tags: + - Bank statements + operationId: get-banking-transaction-category + x-speakeasy-group: banking.transaction-categories + summary: Get transaction category + description: | + The *Get transaction category* endpoint returns a single transaction category for a given transactionCategoryId. + + [Transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingTransactionCategory' + examples: + Basiq: + value: + id: bank-fee + name: Bank Fee + hasChildren: false + status: Active + modifiedDate: '2022-10-28T07:14:46' + Plaid: + value: + id: BANK_FEES + name: BANK_FEES + hasChildren: true + status: Active + modifiedDate: '2022-10-27T10:50:17' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/commerce-customers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Sales + summary: List customers + operationId: list-commerce-customers + x-speakeasy-group: sales.customers + description: |- + The *List customers* endpoint returns a list of [customers](https://docs.codat.io/lending-api#/schemas/Customer) for a given company's connection. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that place orders, make payments and recieve goods and/or services from the SMB. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + parameters: + - $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/CommerceCustomers' + examples: + BigCommerce: + value: + results: + - id: '1' + customerName: Amy Jones + emailAddress: a.jackson@email.me + defaultCurrency: XXX + phone: 07770 666777 + addresses: + - type: Unknown + line1: My Billing Address ./*drop table + city: Portsmouth + region: '' + country: United Kingdom + postalCode: PS13HJ + - type: Unknown + line1: 'This is my address, I cant hit enter.' + city: Portsmouth + region: '' + country: United Kingdom + postalCode: PS13HJ + createdDate: '2022-06-15T15:54:15Z' + modifiedDate: '2023-04-11T10:33:49Z' + sourceModifiedDate: '2022-06-15T15:54:15Z' + - id: '2' + customerName: Cust001 Cust001 + emailAddress: Cust001@example.com + defaultCurrency: XXX + phone: 05442 203941 + addresses: [] + createdDate: '2023-04-11T15:49:25Z' + modifiedDate: '2023-04-17T15:42:55Z' + sourceModifiedDate: '2023-04-11T15:49:25Z' + pageNumber: 1 + pageSize: 2 + totalResults: 201 + _links: + current: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-customers + next: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-customers?page=2&pageSize=2 + Clover: + value: + results: + - id: 2CBJ8R898ZJAR + customerName: '' + addresses: [] + createdDate: '2021-09-22T13:10:12Z' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '0001-01-01T00:00:00' + - id: 511JV0FRN2QYC + customerName: '' + addresses: [] + createdDate: '2021-09-21T14:54:38Z' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '0001-01-01T00:00:00' + pageNumber: 1 + pageSize: 2 + totalResults: 9 + _links: + current: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-customers + next: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-customers?page=2&pageSize=2 + Mollie: + value: + results: + - id: cst_NUkBHQmekz + customerName: Frod Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:41:54' + modifiedDate: '2022-03-17T15:47:28Z' + - id: cst_BvBxwuwfvH + customerName: Frodo Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:42:05' + modifiedDate: '2022-03-17T15:47:28Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-customers + next: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-customers?page=2&pageSize=2 + Mollie Test: + value: + results: + - id: cst_NUkBHQmekz + customerName: Frod Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:41:54' + modifiedDate: '2022-08-17T11:33:19Z' + - id: cst_BvBxwuwfvH + customerName: Frodo Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:42:05' + modifiedDate: '2022-08-17T11:33:19Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-customers + next: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-customers?page=2&pageSize=2 + PrestaShop: + value: + results: + - id: '2' + customerName: Bob Smith + emailAddress: bob.smith@example.com + addresses: + - type: Unknown + line1: 1 test street + city: City Test + region: Virginia + country: US + postalCode: '55678' + createdDate: '2021-09-02T07:54:26' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T07:54:26' + - id: '3' + customerName: Fake Name + emailAddress: bob@bob.com + addresses: [] + createdDate: '2021-09-03T01:55:13' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-03T01:55:13' + pageNumber: 1 + pageSize: 2 + totalResults: 5 + _links: + current: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-customers + next: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-customers?page=2&pageSize=2 + Shopify: + value: + results: + - id: '5839032287390' + customerName: AL A + emailAddress: a.macra@codat.io + addresses: + - type: Unknown + line1: '301 Ink Rooms, 28 Easton St, Farringdon' + line2: '28 Easton St, Farringdon' + city: London + region: England + country: United Kingdom + postalCode: WC1X 0BE + createdDate: '2021-11-18T15:24:03' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2021-11-18T15:24:03' + - id: '5097398534302' + customerName: Qa Test + phone: '+445593368390' + addresses: + - type: Unknown + line1: Look Street + city: London + postalCode: PO16 7GZ + - type: Unknown + line1: Look Street + city: London + region: England + country: United Kingdom + postalCode: PO16 7GZ + note: '' + createdDate: '2021-03-19T10:12:37' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2022-08-01T13:07:59' + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-customers + next: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-customers?page=2&pageSize=2 + Square: + value: + results: + - id: FT9948H3VD6GF8MPDD5438KY1M + emailAddress: fake@name.com + phone: '+441234567890' + addresses: + - type: Unknown + line1: 1 Main Street + line2: Flat 20 + city: London + region: London + postalCode: W1A 1AA + createdDate: '2021-03-08T11:21:11Z' + modifiedDate: '2022-08-02T10:27:32Z' + sourceModifiedDate: '2021-03-08T11:21:11Z' + - id: GXQDPSZSMN6C58270SZN4YJZ8R + emailAddress: s.shandil+square@codat.io + phone: '+447729946295' + addresses: [] + createdDate: '2020-11-19T14:56:00Z' + modifiedDate: '2022-08-02T10:27:32Z' + sourceModifiedDate: '2020-11-19T14:56:00Z' + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-customers + Stripe Test: + value: + results: + - id: cus_LXdjls7KY5ZHaz + customerName: Barry Smith + emailAddress: barry@example.com + defaultCurrency: gbp + addresses: [] + note: Test Subscription + createdDate: '2022-04-20T07:59:52Z' + modifiedDate: '2022-09-30T11:18:27Z' + - id: cus_LXdFFgHqqVURIv + customerName: David Dunlow + emailAddress: david@example.com + defaultCurrency: gbp + phone: '+447545309714' + addresses: + - type: Billing + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + country: GB + postalCode: WC1X 0BE + - type: Delivery + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + country: GB + postalCode: WC1X 0BE + note: Test Subscriptions + createdDate: '2022-04-20T07:30:01Z' + modifiedDate: '2022-09-30T11:18:27Z' + pageNumber: 1 + pageSize: 2 + totalResults: 14 + _links: + current: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-customers + next: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-customers?page=2&pageSize=2 + WooCommerce: + value: + results: + - id: '201694267' + customerName: Qa Test + emailAddress: a.macra@codat.io + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + createdDate: '2021-03-11T09:04:27' + modifiedDate: '2021-07-13T16:19:00Z' + sourceModifiedDate: '2021-03-11T09:07:00' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-customers + Zettle: + value: + results: + - id: firstname.lastname@example.com + customerName: Firstname Lastname + emailAddress: firstname.lastname@example.com + addresses: + - type: Unknown + line1: Line1 + city: City + country: GB + postalCode: TT1 1TT + createdDate: '2021-01-07T16:17:34' + modifiedDate: '2021-01-27T13:08:51Z' + sourceModifiedDate: '2021-01-08T09:57:56' + - id: joe@bloggs.com + customerName: Joe Bloggs + emailAddress: joe@bloggs.com + phone: 02012 345678 + addresses: + - type: Unknown + line1: Flat 1 + line2: 1 High Street + city: London + region: London + country: GB + - type: Unknown + line1: Flat 2 + line2: 2 High Street + city: London + region: London + country: GB + createdDate: '2020-12-21T14:52:15' + modifiedDate: '2021-01-27T13:08:51Z' + sourceModifiedDate: '2020-12-21T14:52:15' + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/fe8e3158-47e6-4367-9537-7d5001295500/connections/d60b15e7-7db9-459b-92a0-9557f7ebdeea/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/fe8e3158-47e6-4367-9537-7d5001295500/connections/d60b15e7-7db9-459b-92a0-9557f7ebdeea/data/commerce-customers + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/commerce-customers/{customerId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/customerId' + get: + tags: + - Sales + summary: Get customer + operationId: get-commerce-customer + x-speakeasy-group: sales.customers + description: | + The *Get customer* endpoint returns a single customer for a given customerId. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that place orders, make payments and receive goods and/or services from the SMB. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceCustomer' + examples: + BigCommerce: + value: + id: '1' + customerName: Amy Jones + emailAddress: a.durbanjackson+amy@codat.io + defaultCurrency: XXX + phone: '07770666777' + addresses: + - type: Unknown + line1: My Billing Address ./*drop table + city: Portsmouth + region: '' + country: United Kingdom + postalCode: PS13HJ + - type: Unknown + line1: 'This is my address, I cant hit enter.' + city: Portsmouth + region: '' + country: United Kingdom + postalCode: PS13HJ + createdDate: '2022-06-15T15:54:15Z' + modifiedDate: '2023-04-11T10:33:49Z' + sourceModifiedDate: '2022-06-15T15:54:15Z' + Clover: + value: + id: 2CBJ8R898ZJAR + customerName: '' + addresses: [] + createdDate: '2021-09-22T13:10:12Z' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '0001-01-01T00:00:00' + Mollie: + value: + id: cst_NUkBHQmekz + customerName: Frod Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:41:54' + modifiedDate: '2022-03-17T15:47:28Z' + Mollie Test: + value: + id: cst_NUkBHQmekz + customerName: Frod Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:41:54' + modifiedDate: '2022-08-17T11:33:19Z' + PrestaShop: + value: + id: '2' + customerName: Bob Smith + emailAddress: bob.smith@example.com + addresses: + - type: Unknown + line1: 1 test street + city: City Test + region: Virginia + country: US + postalCode: '55678' + createdDate: '2021-09-02T07:54:26' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T07:54:26' + Shopify: + value: + id: '5839032287390' + customerName: AL A + emailAddress: a.macra@codat.io + addresses: + - type: Unknown + line1: '301 Ink Rooms, 28 Easton St, Farringdon' + line2: '28 Easton St, Farringdon' + city: London + region: England + country: United Kingdom + postalCode: WC1X 0BE + createdDate: '2021-11-18T15:24:03' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2021-11-18T15:24:03' + Square: + value: + id: FT9948H3VD6GF8MPDD5438KY1M + emailAddress: fake@name.com + phone: '+441234567890' + addresses: + - type: Unknown + line1: 1 Main Street + line2: Flat 20 + city: London + region: London + postalCode: W1A 1AA + createdDate: '2021-03-08T11:21:11Z' + modifiedDate: '2022-08-02T10:27:32Z' + sourceModifiedDate: '2021-03-08T11:21:11Z' + Stripe Test: + value: + id: cus_LXdjls7KY5ZHaz + customerName: Barry Smith + emailAddress: barry@example.com + defaultCurrency: gbp + addresses: [] + note: Test Subscription + createdDate: '2022-04-20T07:59:52Z' + modifiedDate: '2022-09-30T11:18:27Z' + WooCommerce: + value: + id: '201694267' + customerName: Qa Test + emailAddress: a.macra@codat.io + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + createdDate: '2021-03-11T09:04:27' + modifiedDate: '2021-07-13T16:19:00Z' + sourceModifiedDate: '2021-03-11T09:07:00' + Zettle: + value: + id: firstname.lastname@example.com + customerName: Firstname Lastname + emailAddress: firstname.lastname@example.com + addresses: + - type: Unknown + line1: Line1 + city: City + country: GB + postalCode: TT1 1TT + createdDate: '2021-01-07T16:17:34' + modifiedDate: '2021-01-27T13:08:51Z' + sourceModifiedDate: '2021-01-08T09:57:56' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/commerce-disputes': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List disputes + tags: + - Sales + operationId: list-commerce-disputes + x-speakeasy-group: sales.disputes + parameters: + - $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/CommerceDisputes' + examples: + Shopify: + value: + results: + - id: '8502411422' + disputedTransactions: + - id: '3684116791454' + type: Order + totalAmount: 175 + currency: GBP + status: Processing + reason: fraudulent + dueDate: '2021-03-28T00:00:00' + createdDate: '2021-03-19T13:16:27' + modifiedDate: '2023-02-10T15:18:22Z' + sourceModifiedDate: '2021-03-28T11:00:17' + - id: '8502444190' + disputedTransactions: + - id: '3684119445662' + type: Order + totalAmount: 600 + currency: GBP + status: Processing + reason: fraudulent + dueDate: '2021-03-28T00:00:00' + createdDate: '2021-03-19T13:18:31' + modifiedDate: '2023-02-10T15:18:22Z' + sourceModifiedDate: '2021-03-28T11:00:18' + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-disputes?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-disputes + Stripe Test: + value: + results: + - id: dp_1Hqhl8A8m8S1Gh7OJrvF3gsK + disputedTransactions: + - id: txn_1Hqhl8A8m8S1Gh7OtmAPNr9e + type: Payment + totalAmount: 25 + currency: GBP + status: Processing + reason: fraudulent + dueDate: '2020-12-02T23:59:59Z' + createdDate: '2020-11-23T16:19:22Z' + modifiedDate: '2022-09-30T11:18:27Z' + - id: dp_1HqiwVA8m8S1Gh7OpS3ozlcd + disputedTransactions: + - id: txn_1HqiwVA8m8S1Gh7O0IVelTQ5 + type: Payment + totalAmount: 55 + currency: GBP + status: Lost + reason: product_not_received + dueDate: '2020-12-02T23:59:59Z' + createdDate: '2020-11-23T17:35:11Z' + modifiedDate: '2022-09-30T11:18:27Z' + pageNumber: 1 + pageSize: 2 + totalResults: 5 + _links: + current: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-disputes?page=1&pageSize=2 + self: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-disputes + next: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-disputes?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List disputes* endpoint returns a list of [disputes](https://docs.codat.io/lending-api#/schemas/Dispute) for a given company's connection. + + [Disputes](https://docs.codat.io/lending-api#/schemas/Dispute) are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + '/companies/{companyId}/connections/{connectionId}/data/commerce-disputes/{disputeId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: disputeId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a dispute. + get: + summary: Get dispute + tags: + - Sales + operationId: get-commerce-dispute + x-speakeasy-group: sales.disputes + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceDispute' + examples: + Shopify: + value: + id: '8502411422' + disputedTransactions: + - id: '3684116791454' + type: Order + totalAmount: 175 + currency: GBP + status: Processing + reason: fraudulent + dueDate: '2021-03-28T00:00:00' + createdDate: '2021-03-19T13:16:27' + modifiedDate: '2023-02-10T15:18:22Z' + sourceModifiedDate: '2021-03-28T11:00:17' + Stripe Test: + value: + id: dp_1Hqhl8A8m8S1Gh7OJrvF3gsK + disputedTransactions: + - id: txn_1Hqhl8A8m8S1Gh7OtmAPNr9e + type: Payment + totalAmount: 25 + currency: GBP + status: Processing + reason: fraudulent + dueDate: '2020-12-02T23:59:59Z' + createdDate: '2020-11-23T16:19:22Z' + modifiedDate: '2022-09-30T11:18:27Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get dispute* endpoint returns a single dispute for a given disputeId. + + [Disputes](https://docs.codat.io/lending-api#/schemas/Dispute) are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-info': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get company commerce profile + tags: + - Company info + operationId: get-commerce-profile + x-speakeasy-name-override: get-commerce-profile + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceCompanyInfo' + examples: + Example 1: + value: + companyName: Codat + companyLegalName: Codat Ltd + addresses: + - type: Billing + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + region: England + country: United Kingdom + postalCode: WC1X 0BE + - type: Delivery + line1: 28 Easton Street + city: London + country: UK + postalCode: WC1X 0BE + phoneNumbers: + - number: 02012 345678 + type: Landline + - number: 07123 456789 + type: Mobile + - number: 02012 345678 + type: Fax + webLinks: + - type: Website + url: 'https://www.codat.io/' + - type: Social + url: 'https://www.linkedin.com/company/codat-limited/' + registrationNumber: '5590111724' + baseCurrency: GBP + accountBalances: + - available: 20053.23 + pending: 2034.23 + reserved: 517.23 + currency: GBP + sourceUrls: + Api: 'https://api.codat.io' + createdDate: '2019-03-07T16:50:49' + modifiedDate: '2022-03-10T15:42:13' + sourceModifiedDate: '2021-06-10T01:48:49' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + Retrieve information about the company, as seen in the commerce + platform. + + This may include information like addresses, tax registration details and + social media or website information." + '/companies/{companyId}/connections/{connectionId}/data/commerce-locations': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List locations + tags: + - Sales + operationId: list-commerce-locations + x-speakeasy-group: sales.locations + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceLocations' + examples: + Clover: + value: + results: + - id: GA3WP1ZC3ZFK1 + name: Codat + address: + type: Inventory + line1: '301 Ink Rooms, 28 Easton Street' + city: London + region: London + country: GB + postalCode: WC1X 0BE + modifiedDate: '2023-01-09T11:01:03Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-locations?page=1&pageSize=2 + self: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-locations + Lightspeed K Trial: + value: + results: + - id: '647208621834538' + name: QA Shared - New Test Site + address: + type: Unknown + country: AU + modifiedDate: '2023-03-02T09:48:48Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-locations?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-locations + Shopify: + value: + results: + - id: '61375348894' + name: '301 Ink Rooms, 28 Easton St' + address: + type: Inventory + line1: '301 Ink Rooms, 28 Easton St' + city: London + region: London + country: GB + postalCode: WC1X 0BE + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2021-03-19T10:06:06' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-locations?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-locations + Square: + value: + results: + - id: D8DVHD1G6NT2J + name: Codat Limited + address: + type: Inventory + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + country: GB + postalCode: WC1X0BE + modifiedDate: '2022-08-02T10:27:32Z' + sourceModifiedDate: '2020-01-17T14:07:30Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-locations?page=1&pageSize=2 + self: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-locations + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List locations* endpoint returns a list of [locations](https://docs.codat.io/lending-api#/schemas/Location) for a given company's connection. + + [Locations](https://docs.codat.io/lending-api#/schemas/Location) hold information on the geographic location at which stocks of [products](https://docs.codat.io/lending-api#/schemas/Product) may be held or where [orders](https://docs.codat.io/lending-api#/schemas/Order) were placed. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + '/companies/{companyId}/connections/{connectionId}/data/commerce-locations/{locationId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: locationId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a location. + get: + summary: Get location + tags: + - Sales + operationId: get-commerce-location + x-speakeasy-group: sales.locations + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceLocation' + examples: + Clover: + value: + id: GA3WP1ZC3ZFK1 + name: Codat + address: + type: Inventory + line1: '301 Ink Rooms, 28 Easton Street' + city: London + region: London + country: GB + postalCode: WC1X 0BE + modifiedDate: '2023-01-09T11:01:03Z' + Lightspeed K Trial: + value: + id: '647208621834538' + name: QA Shared - New Test Site + address: + type: Unknown + country: AU + modifiedDate: '2023-03-02T09:48:48Z' + Shopify: + value: + id: '61375348894' + name: '301 Ink Rooms, 28 Easton St' + address: + type: Inventory + line1: '301 Ink Rooms, 28 Easton St' + city: London + region: London + country: GB + postalCode: WC1X 0BE + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2021-03-19T10:06:06' + Square: + value: + id: D8DVHD1G6NT2J + name: Codat Limited + address: + type: Inventory + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + country: GB + postalCode: WC1X0BE + modifiedDate: '2022-08-02T10:27:32Z' + sourceModifiedDate: '2020-01-17T14:07:30Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get location* endpoint returns a single location for a given locationId. + + [Locations](https://docs.codat.io/lending-api#/schemas/Location) hold information on the geographic location at which stocks of [products](https://docs.codat.io/lending-api#/schemas/Product) may be held or where [orders](https://docs.codat.io/lending-api#/schemas/Order) were placed. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-orders': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List orders + tags: + - Sales + operationId: list-commerce-orders + x-speakeasy-group: sales.orders + responses: + '200': + description: OK + content: + application/json: + x-speakeasy-usage-example: true + schema: + $ref: '#/components/schemas/CommerceOrders' + examples: + Amazon Seller Central: + value: + results: + - id: 902-1845936-5435065 + orderNumber: 902-1845936-5435065 + country: 'US ' + currency: USD + createdDate: '1970-01-19T03:58:30Z' + totalAmount: 10 + totalRefund: 0 + totalTaxAmount: 1.01 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: O05015851154158 + quantity: 1 + taxPercentage: 11.23 + totalAmount: 10 + totalTaxAmount: 1.01 + unitPrice: 8.99 + taxes: [] + productVariantRef: + id: NABetaASINB00551Q3CS + discountAllocations: [] + payments: [] + serviceCharges: [] + modifiedDate: '2023-01-09T09:12:12Z' + sourceModifiedDate: '1970-01-19T03:58:32Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-orders + BigCommerce: + value: + results: + - id: '100' + orderNumber: '100' + country: GBR + currency: GBP + createdDate: '2022-06-15T15:48:18Z' + totalAmount: 675 + totalRefund: 0 + totalTaxAmount: 112.5 + totalDiscount: 10 + totalGratuity: 0 + orderLineItems: + - id: '1' + quantity: 1 + taxPercentage: 20 + totalAmount: 221.64 + totalTaxAmount: 36.94 + unitPrice: 187.5 + taxes: [] + productRef: + id: '86' + name: '[Sample] Able Brewing System' + productVariantRef: + id: '66' + name: '[Sample] Able Brewing System' + discountAllocations: + - name: Manual Discount + totalAmount: 3.36 + - id: '2' + quantity: 5 + taxPercentage: 19.9999 + totalAmount: 438.36 + totalTaxAmount: 73.06 + unitPrice: 74.1667 + taxes: [] + productRef: + id: '81' + name: '[Sample] Orbit Terrarium - Small' + productVariantRef: + id: '65' + name: '[Sample] Orbit Terrarium - Small' + discountAllocations: + - name: Manual Discount + totalAmount: 6.64 + payments: [] + serviceCharges: + - description: Shipping Charge + totalAmount: 15 + taxPercentage: 20 + taxAmount: 2.5 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '0' + modifiedDate: '2023-04-11T10:33:56Z' + sourceModifiedDate: '2022-06-15T15:48:18Z' + - id: '101' + orderNumber: '101' + country: GBR + currency: GBP + createdDate: '2022-06-15T15:49:02Z' + totalAmount: 675 + totalRefund: 0 + totalTaxAmount: 112.5 + totalDiscount: 10 + totalGratuity: 0 + orderLineItems: + - id: '3' + quantity: 1 + taxPercentage: 20 + totalAmount: 221.64 + totalTaxAmount: 36.94 + unitPrice: 187.5 + taxes: [] + productRef: + id: '86' + name: '[Sample] Able Brewing System' + productVariantRef: + id: '66' + name: '[Sample] Able Brewing System' + discountAllocations: + - name: Manual Discount + totalAmount: 3.36 + - id: '4' + quantity: 5 + taxPercentage: 19.9999 + totalAmount: 438.36 + totalTaxAmount: 73.06 + unitPrice: 74.1667 + taxes: [] + productRef: + id: '81' + name: '[Sample] Orbit Terrarium - Small' + productVariantRef: + id: '65' + name: '[Sample] Orbit Terrarium - Small' + discountAllocations: + - name: Manual Discount + totalAmount: 6.64 + payments: [] + serviceCharges: + - description: Shipping Charge + totalAmount: 15 + taxPercentage: 20 + taxAmount: 2.5 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '0' + modifiedDate: '2023-04-11T10:33:56Z' + sourceModifiedDate: '2022-06-15T15:49:02Z' + pageNumber: 1 + pageSize: 2 + totalResults: 14 + _links: + current: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-orders + next: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-orders?page=2&pageSize=2 + Clover: + value: + results: + - id: 0BCZPWGFC3M16 + orderNumber: 0BCZPWGFC3M16 + country: 'GB ' + currency: GBP + createdDate: '2021-05-24T10:33:41Z' + totalAmount: 1200 + totalRefund: 0 + totalTaxAmount: 200 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: 985WY5J4H12XY + quantity: 1 + taxPercentage: 20 + totalAmount: 1200 + totalTaxAmount: 200 + unitPrice: 1000 + taxes: + - taxComponentRef: + id: KAWQTPZP3R9VT + name: VAT 20% + taxAmount: 200 + productRef: + id: NMZHKK6FKF6ZJ + name: Laptop + discountAllocations: [] + payments: + - id: S2D924NX13T2G + serviceCharges: [] + locationRef: + id: GA3WP1ZC3ZFK1 + name: Codat + modifiedDate: '2022-09-08T15:47:43Z' + sourceModifiedDate: '2021-05-24T10:33:45Z' + - id: 0G22TXMYQQE54 + orderNumber: 0G22TXMYQQE54 + country: 'GB ' + currency: GBP + createdDate: '2021-05-24T11:24:48Z' + totalAmount: 1340 + totalRefund: 0 + totalTaxAmount: 240 + totalDiscount: 100 + totalGratuity: 0 + orderLineItems: + - id: GZ73TPFAV6NTP + quantity: 1 + taxPercentage: 20 + totalAmount: 1440 + totalTaxAmount: 240 + unitPrice: 1200 + taxes: + - taxComponentRef: + id: KAWQTPZP3R9VT + name: VAT 20% + taxAmount: 240 + productRef: + id: QVAV6KM1457B0 + name: Desktop + discountAllocations: [] + - id: 'Discount: �10 off' + quantity: 1 + taxPercentage: 0 + totalAmount: -100 + totalTaxAmount: 0 + unitPrice: 0 + taxes: [] + discountAllocations: + - name: �10 off + totalAmount: 100 + payments: + - id: H726AAJQYE3SP + serviceCharges: [] + locationRef: + id: GA3WP1ZC3ZFK1 + name: Codat + modifiedDate: '2022-09-08T15:47:43Z' + sourceModifiedDate: '2021-05-24T11:24:52Z' + pageNumber: 1 + pageSize: 2 + totalResults: 76 + _links: + current: + href: /companies/1535235d-5efb-4d17-9d94-491c1f35ff92/connections/ed802898-f920-486b-b553-d7b4c1ac6c8d/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/1535235d-5efb-4d17-9d94-491c1f35ff92/connections/ed802898-f920-486b-b553-d7b4c1ac6c8d/data/commerce-orders + next: + href: /companies/1535235d-5efb-4d17-9d94-491c1f35ff92/connections/ed802898-f920-486b-b553-d7b4c1ac6c8d/data/commerce-orders?page=2&pageSize=2 + Lightspeed K Trial: + value: + results: + - id: A61465.1 + orderNumber: A61465.1 + country: 'AU ' + currency: AUD + createdDate: '2022-12-09T02:27:14Z' + closedDate: '2022-12-09T02:27:46Z' + totalAmount: 5 + totalRefund: 0 + totalTaxAmount: 0.45 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: S61465.1 + quantity: 1 + taxPercentage: 10 + totalAmount: 5 + totalTaxAmount: 0.45 + unitPrice: 4.5455 + taxes: + - taxComponentRef: + id: GST10 + name: 10% GST + taxAmount: 0.45 + productRef: + id: '647208621834617' + name: Hot Chocolate + discountAllocations: [] + payments: + - id: 'R61465.1_1_A61465.1_2022-12-09T02:27:46.273Z' + amount: 5 + currency: AUD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-12-09T02:27:46' + modifiedDate: '2023-03-02T09:50:43' + serviceCharges: [] + locationRef: + id: '647208621834538' + name: QA Shared - New Test Site + modifiedDate: '2023-03-08T13:49:34Z' + - id: A61465.2 + orderNumber: A61465.2 + country: 'AU ' + currency: AUD + createdDate: '2022-12-12T23:20:12Z' + closedDate: '2022-12-12T23:21:29Z' + totalAmount: 10 + totalRefund: 0 + totalTaxAmount: 0.91 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: S61465.2 + quantity: 1 + taxPercentage: 10 + totalAmount: 5 + totalTaxAmount: 0.46 + unitPrice: 4.5455 + taxes: + - taxComponentRef: + id: GST10 + name: 10% GST + taxAmount: 0.46 + productRef: + id: '647208621834663' + name: Royal + discountAllocations: [] + - id: S61465.3 + quantity: 1 + taxPercentage: 10 + totalAmount: 5 + totalTaxAmount: 0.45 + unitPrice: 4.5455 + taxes: + - taxComponentRef: + id: GST10 + name: 10% GST + taxAmount: 0.45 + productRef: + id: '647208621834623' + name: Mocha + discountAllocations: [] + payments: + - id: 'R61465.2_1_A61465.2_2022-12-12T23:21:29.006Z' + amount: 10 + currency: AUD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-12-12T23:21:29' + modifiedDate: '2023-03-02T09:50:43' + serviceCharges: [] + locationRef: + id: '647208621834538' + name: QA Shared - New Test Site + modifiedDate: '2023-03-08T13:49:34Z' + pageNumber: 1 + pageSize: 2 + totalResults: 24 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-orders + next: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-orders?page=2&pageSize=2 + Mollie: + value: + results: + - id: ord_2at3ck + orderNumber: '1337' + country: NLD + currency: EUR + createdDate: '2022-01-20T09:28:32' + totalAmount: 1027.99 + totalRefund: 0 + totalTaxAmount: 178.41 + totalDiscount: 100 + totalGratuity: 0 + orderLineItems: + - id: odl_1.3tvc32 + quantity: 1 + taxPercentage: 21 + totalAmount: 329.99 + totalTaxAmount: 57.27 + unitPrice: 329.99 + taxes: [] + discountAllocations: [] + - id: odl_1.x95vuk + quantity: 2 + taxPercentage: 21 + totalAmount: 698 + totalTaxAmount: 121.14 + unitPrice: 399 + taxes: [] + discountAllocations: + - name: Discount + totalAmount: 100 + payments: + - id: tr_GpHuaqHrca + amount: 1027.99 + currency: EUR + type: OnlineCard + status: Failed + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-02-08T15:44:22' + modifiedDate: '2022-03-17T15:47:28' + sourceModifiedDate: '2022-02-08T16:02:02' + - id: tr_w7RGQc3k3V + amount: 1027.99 + currency: EUR + type: OnlineCard + status: Failed + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-01-20T09:28:32' + modifiedDate: '2022-03-17T15:47:28' + sourceModifiedDate: '2022-01-20T09:46:02' + serviceCharges: [] + modifiedDate: '2022-03-17T15:47:28Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-orders + Mollie Test: + value: + results: + - id: ord_2at3ck + orderNumber: '1337' + country: NLD + currency: EUR + createdDate: '2022-01-20T09:28:32' + totalAmount: 1027.99 + totalRefund: 0 + totalTaxAmount: 178.41 + totalDiscount: 100 + totalGratuity: 0 + orderLineItems: + - id: odl_1.x95vuk + quantity: 2 + taxPercentage: 21 + totalAmount: 698 + totalTaxAmount: 121.14 + unitPrice: 338.43 + taxes: [] + discountAllocations: + - name: Discount + totalAmount: 100 + - id: odl_1.3tvc32 + quantity: 1 + taxPercentage: 21 + totalAmount: 329.99 + totalTaxAmount: 57.27 + unitPrice: 272.72 + taxes: [] + discountAllocations: [] + payments: + - id: tr_GpHuaqHrca + - id: tr_w7RGQc3k3V + serviceCharges: [] + modifiedDate: '2022-08-17T11:33:19Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-orders + Partner Commerce: + value: + results: + - id: 6d135134-2f77-45f7-af3d-ee873e42da45 + orderNumber: '93128704' + country: 'GM ' + currency: CAD + createdDate: '2021-02-10T01:37:23' + totalAmount: 203.82 + totalRefund: 0 + totalTaxAmount: 40.77 + totalDiscount: 25.63 + totalGratuity: 80.81 + orderLineItems: + - id: 89f5e83a-c87d-4b60-a009-0ea9065867aa + quantity: 3 + taxPercentage: 20 + totalAmount: 85.44 + totalTaxAmount: 17.09 + unitPrice: 28.48 + taxes: [] + productRef: + id: 98ef828e-33e1-4c23-9383-a029f1d6a3a6 + productVariantRef: + id: dffcd99e-13bb-4b89-89ef-719b3b0777e6 + discountAllocations: + - name: Discount + totalAmount: 8.54 + - name: Discount + totalAmount: 17.09 + - id: 4c65f0d9-05c8-48eb-9c4a-1774f5073e66 + quantity: 3 + taxPercentage: 20 + totalAmount: 118.38 + totalTaxAmount: 23.68 + unitPrice: 39.46 + taxes: [] + productRef: + id: 561f8efb-3429-4c1f-a014-1fa595f9b3c6 + productVariantRef: + id: e0715a7a-0179-4a2e-b40d-800fd2f36764 + discountAllocations: [] + payments: + - id: 3ec3d4c4-8003-4f77-a44e-08b3e17057bf + serviceCharges: [] + locationRef: + id: d84a8ce0-d7e4-400a-b07a-d4bddd9c1873 + customerRef: + id: 0dc0206d-f22f-48c9-a4e5-79f8383c3426 + modifiedDate: '2022-05-12T07:22:02Z' + sourceModifiedDate: '2021-02-10T01:37:23' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/4342cb7d-d7b1-492f-851e-4aa5084933c1/connections/9e5422fa-f03f-4d58-bcf4-161b574ab350/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/4342cb7d-d7b1-492f-851e-4aa5084933c1/connections/9e5422fa-f03f-4d58-bcf4-161b574ab350/data/commerce-orders + PrestaShop: + value: + results: + - id: '1' + orderNumber: XKBKNABJK + country: 'US ' + currency: USD + createdDate: '2021-09-02T06:00:54' + totalAmount: 61.8 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '1' + quantity: 1 + taxPercentage: 0 + totalAmount: 23.9 + totalTaxAmount: 0 + unitPrice: 23.9 + taxes: [] + productRef: + id: '1' + name: Hummingbird printed t-shirt + discountAllocations: [] + - id: '2' + quantity: 1 + taxPercentage: 0 + totalAmount: 35.9 + totalTaxAmount: 0 + unitPrice: 35.9 + taxes: [] + productRef: + id: '2' + name: Hummingbird printed sweater + discountAllocations: [] + payments: [] + serviceCharges: + - description: Shipping + totalAmount: 2 + taxPercentage: 0 + taxAmount: 0 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '1' + name: John DOE + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T06:00:54' + - id: '10' + orderNumber: UFQZXPGQU + country: 'US ' + currency: USD + createdDate: '2021-09-28T08:09:46' + totalAmount: 19.12 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 4.78 + totalGratuity: 0 + orderLineItems: + - id: '14' + quantity: 1 + taxPercentage: 0 + totalAmount: 19.12 + totalTaxAmount: 0 + unitPrice: 23.9 + taxes: [] + productRef: + id: '1' + name: Hummingbird printed t-shirt + discountAllocations: + - name: 20% Discount + totalAmount: 4.78 + payments: [] + serviceCharges: [] + customerRef: + id: '5' + name: Tobi Yinusa + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-28T08:09:46' + pageNumber: 1 + pageSize: 2 + totalResults: 10 + _links: + current: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-orders + next: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-orders?page=2&pageSize=2 + Shopify: + value: + results: + - id: '3684119445662' + orderNumber: '1007' + country: XXX + currency: GBP + createdDate: '2021-03-19T13:18:33' + totalAmount: 600 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '9670458146974' + quantity: 4 + taxPercentage: 0 + totalAmount: 600 + totalTaxAmount: 0 + unitPrice: 150 + taxes: [] + productRef: + id: '6595494117534' + name: Monitor + productVariantRef: + id: '39444526694558' + name: Monitor + discountAllocations: [] + payments: + - id: '4630233579678' + amount: 600 + currency: GBP + type: OnlineCard + status: Failed + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:17:49' + modifiedDate: '2023-02-10T15:18:24' + sourceModifiedDate: '2021-03-19T13:17:49' + - id: '4630234497182' + amount: 600 + currency: GBP + type: OnlineCard + status: Paid + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:18:29' + modifiedDate: '2023-02-10T15:18:24' + sourceModifiedDate: '2021-03-19T13:18:29' + serviceCharges: [] + customerRef: + id: '5097398534302' + name: Qa Test + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2022-08-01T13:12:35' + - id: '3684180361374' + orderNumber: '1011' + country: XXX + currency: GBP + createdDate: '2021-03-19T13:57:30' + totalAmount: 105 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '9670570901662' + quantity: 3 + taxPercentage: 0 + totalAmount: 105 + totalTaxAmount: 0 + unitPrice: 35 + taxes: [] + productRef: + id: '6595497787550' + name: Keyboard + productVariantRef: + id: '39444537213086' + name: Keyboard + discountAllocations: [] + payments: + - id: '4630311108766' + amount: 105 + currency: GBP + type: Unknown + status: Paid + paymentProvider: Manual + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:57:30' + modifiedDate: '2023-02-10T15:18:24' + sourceModifiedDate: '2021-03-19T13:57:30' + serviceCharges: [] + customerRef: + id: '5097398534302' + name: Qa Test + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2022-08-01T13:12:35' + pageNumber: 1 + pageSize: 2 + totalResults: 30 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-orders + next: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-orders?page=2&pageSize=2 + Square: + value: + results: + - id: BDYNvtIYyWClkTjnh99CFR3fPwKZY + orderNumber: BDYNvtIYyWClkTjnh99CFR3fPwKZY + country: 'GB ' + currency: GBP + createdDate: '2021-02-14T19:38:28Z' + closedDate: '0001-01-01T00:00:00' + totalAmount: 50 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: lLJpgArKQbBEn9nTvLRHP + quantity: 1 + taxPercentage: 0 + totalAmount: 50 + totalTaxAmount: 0 + unitPrice: 50 + taxes: [] + discountAllocations: [] + payments: [] + serviceCharges: [] + locationRef: + id: D8DVHD1G6NT2J + name: Codat Limited + modifiedDate: '2022-08-02T10:27:33Z' + sourceModifiedDate: '2021-02-14T19:38:28Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-orders + SumUp: + value: + results: + - id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + orderNumber: TECXTU2KT6 + country: XXX + currency: GBP + createdDate: '2021-03-30T12:20:40Z' + totalAmount: 200 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: Product undefined by SumUp + quantity: 1 + taxPercentage: 0 + totalAmount: 200 + totalTaxAmount: 0 + unitPrice: 200 + taxes: [] + discountAllocations: [] + payments: + - id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + serviceCharges: [] + modifiedDate: '2022-09-14T10:58:04Z' + - id: 46d36a64-ea48-4e37-9340-3548cbf3ca2f + orderNumber: TNEU7333HZ + country: XXX + currency: GBP + createdDate: '2021-03-26T21:09:59Z' + totalAmount: 15 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: Sale of some product + quantity: 1 + taxPercentage: 0 + totalAmount: 15 + totalTaxAmount: 0 + unitPrice: 15 + taxes: [] + discountAllocations: [] + payments: + - id: 46d36a64-ea48-4e37-9340-3548cbf3ca2f + serviceCharges: [] + modifiedDate: '2022-09-14T10:58:04Z' + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-orders + next: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-orders?page=2&pageSize=2 + WooCommerce: + value: + results: + - id: '111' + orderNumber: '111' + country: 'GB ' + currency: GBP + createdDate: '2021-03-27T23:29:38Z' + totalAmount: 39.5 + totalRefund: 0 + totalTaxAmount: 6 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '53' + quantity: 2 + taxPercentage: 20 + totalAmount: 12 + totalTaxAmount: 2 + unitPrice: 5 + taxes: [] + productRef: + id: '82' + discountAllocations: [] + - id: '54' + quantity: 2 + taxPercentage: 20 + totalAmount: 24 + totalTaxAmount: 4 + unitPrice: 10 + taxes: [] + productRef: + id: '81' + discountAllocations: [] + payments: [] + serviceCharges: + - description: Royal Mail + totalAmount: 3.5 + taxPercentage: 0 + taxAmount: 0 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '200585744' + modifiedDate: '2022-07-11T15:35:48Z' + sourceModifiedDate: '2021-04-01T13:34:59Z' + - id: '145' + orderNumber: '145' + country: 'GB ' + currency: GBP + createdDate: '2021-09-24T12:15:29Z' + totalAmount: 27.5 + totalRefund: 0 + totalTaxAmount: 5.5 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '59' + quantity: 2 + taxPercentage: 25 + totalAmount: 27.5 + totalTaxAmount: 5.5 + unitPrice: 11 + taxes: [] + productRef: + id: '87' + discountAllocations: [] + payments: [] + serviceCharges: [] + modifiedDate: '2022-07-11T15:35:48Z' + sourceModifiedDate: '2022-03-24T16:01:23Z' + pageNumber: 1 + pageSize: 2 + totalResults: 25 + _links: + current: + href: /companies/00396b78-7113-4b1f-996f-4c561b00573a/connections/b39ed7d6-5eda-44c5-85bb-647d03edd649/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/00396b78-7113-4b1f-996f-4c561b00573a/connections/b39ed7d6-5eda-44c5-85bb-647d03edd649/data/commerce-orders + next: + href: /companies/00396b78-7113-4b1f-996f-4c561b00573a/connections/b39ed7d6-5eda-44c5-85bb-647d03edd649/data/commerce-orders?page=2&pageSize=2 + Zettle: + value: + results: + - id: 7TunRi2XEeueVK3fSQEQIw + orderNumber: '3' + country: 'GB ' + currency: GBP + createdDate: '2020-11-23T14:27:20Z' + totalAmount: 45 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '0' + quantity: 1 + taxPercentage: 0 + totalAmount: 45 + totalTaxAmount: 0 + unitPrice: 45 + taxes: [] + productRef: + id: 7f9f31e4-2d97-11eb-9f55-acde48001122 + productVariantRef: + id: 7f9f35ea-2d97-11eb-9f55-acde48001122 + discountAllocations: [] + payments: + - id: ed97bcde-2d97-11eb-a42e-25130f2dd258 + amount: 45 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:27:19' + modifiedDate: '2021-10-27T15:22:37' + serviceCharges: [] + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2020-11-23T14:27:20Z' + - id: CV5TJC2YEeueVK3fSQEQIw + orderNumber: '4' + country: 'GB ' + currency: GBP + createdDate: '2020-11-23T14:28:05Z' + totalAmount: 25 + totalRefund: 0 + totalTaxAmount: 1.19 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '0' + quantity: 1 + taxPercentage: 5 + totalAmount: 25 + totalTaxAmount: 1.19 + unitPrice: 23.81 + taxes: [] + productRef: + id: 89570bee-2d97-11eb-9f55-acde48001122 + productVariantRef: + id: 89570c52-2d97-11eb-9f55-acde48001122 + discountAllocations: [] + payments: + - id: 09b94cfc-2d98-11eb-8021-0e1b9dcbeca1 + amount: 25 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:28:04' + modifiedDate: '2021-10-27T15:22:37' + serviceCharges: [] + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2020-11-23T14:28:05Z' + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-orders + next: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-orders?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List orders* endpoint returns a list of [orders](https://docs.codat.io/lending-api#/schemas/Order) for a given company's connection. + + [Orders](https://docs.codat.io/lending-api#/schemas/Order) contain the transaction details for all products sold by the company. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + '/companies/{companyId}/connections/{connectionId}/data/commerce-orders/{orderId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: orderId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for an order. + get: + summary: Get order + tags: + - Sales + operationId: get-commerce-order + x-speakeasy-group: sales.orders + responses: + '200': + description: OK + content: + application/json: + x-speakeasy-usage-example: true + schema: + $ref: '#/components/schemas/CommerceOrder' + examples: + Amazon Seller Central: + value: + id: 902-1845936-5435065 + orderNumber: 902-1845936-5435065 + country: 'US ' + currency: USD + createdDate: '1970-01-19T03:58:30Z' + totalAmount: 10 + totalRefund: 0 + totalTaxAmount: 1.01 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: O05015851154158 + quantity: 1 + taxPercentage: 11.23 + totalAmount: 10 + totalTaxAmount: 1.01 + unitPrice: 8.99 + taxes: [] + productVariantRef: + id: NABetaASINB00551Q3CS + discountAllocations: [] + payments: [] + serviceCharges: [] + modifiedDate: '2023-01-09T09:12:12Z' + sourceModifiedDate: '1970-01-19T03:58:32Z' + BigCommerce: + value: + id: '100' + orderNumber: '100' + country: GBR + currency: GBP + createdDate: '2022-06-15T15:48:18Z' + totalAmount: 675 + totalRefund: 0 + totalTaxAmount: 112.5 + totalDiscount: 10 + totalGratuity: 0 + orderLineItems: + - id: '1' + quantity: 1 + taxPercentage: 20 + totalAmount: 221.64 + totalTaxAmount: 36.94 + unitPrice: 187.5 + taxes: [] + productRef: + id: '86' + name: '[Sample] Able Brewing System' + productVariantRef: + id: '66' + name: '[Sample] Able Brewing System' + discountAllocations: + - name: Manual Discount + totalAmount: 3.36 + - id: '2' + quantity: 5 + taxPercentage: 19.9999 + totalAmount: 438.36 + totalTaxAmount: 73.06 + unitPrice: 74.1667 + taxes: [] + productRef: + id: '81' + name: '[Sample] Orbit Terrarium - Small' + productVariantRef: + id: '65' + name: '[Sample] Orbit Terrarium - Small' + discountAllocations: + - name: Manual Discount + totalAmount: 6.64 + payments: [] + serviceCharges: + - description: Shipping Charge + totalAmount: 15 + taxPercentage: 20 + taxAmount: 2.5 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '0' + modifiedDate: '2023-04-11T10:33:56Z' + sourceModifiedDate: '2022-06-15T15:48:18Z' + Clover: + value: + id: 0BCZPWGFC3M16 + orderNumber: 0BCZPWGFC3M16 + country: 'GB ' + currency: GBP + createdDate: '2021-05-24T10:33:41Z' + totalAmount: 1200 + totalRefund: 0 + totalTaxAmount: 200 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: 985WY5J4H12XY + quantity: 1 + taxPercentage: 20 + totalAmount: 1200 + totalTaxAmount: 200 + unitPrice: 1000 + taxes: + - taxComponentRef: + id: KAWQTPZP3R9VT + name: VAT 20% + taxAmount: 200 + productRef: + id: NMZHKK6FKF6ZJ + name: Laptop + discountAllocations: [] + payments: + - id: S2D924NX13T2G + serviceCharges: [] + locationRef: + id: GA3WP1ZC3ZFK1 + name: Codat + modifiedDate: '2022-09-08T15:47:43Z' + sourceModifiedDate: '2021-05-24T10:33:45Z' + Lightspeed K Trial: + value: + id: A61465.1 + orderNumber: A61465.1 + country: 'AU ' + currency: AUD + createdDate: '2022-12-09T02:27:14Z' + closedDate: '2022-12-09T02:27:46Z' + totalAmount: 5 + totalRefund: 0 + totalTaxAmount: 0.45 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: S61465.1 + quantity: 1 + taxPercentage: 10 + totalAmount: 5 + totalTaxAmount: 0.45 + unitPrice: 4.5455 + taxes: + - taxComponentRef: + id: GST10 + name: 10% GST + taxAmount: 0.45 + productRef: + id: '647208621834617' + name: Hot Chocolate + discountAllocations: [] + payments: + - id: 'R61465.1_1_A61465.1_2022-12-09T02:27:46.273Z' + amount: 5 + currency: AUD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-12-09T02:27:46' + modifiedDate: '2023-03-02T09:50:43' + serviceCharges: [] + locationRef: + id: '647208621834538' + name: QA Shared - New Test Site + modifiedDate: '2023-03-08T13:49:34Z' + Mollie: + value: + id: ord_2at3ck + orderNumber: '1337' + country: NLD + currency: EUR + createdDate: '2022-01-20T09:28:32' + totalAmount: 1027.99 + totalRefund: 0 + totalTaxAmount: 178.41 + totalDiscount: 100 + totalGratuity: 0 + orderLineItems: + - id: odl_1.3tvc32 + quantity: 1 + taxPercentage: 21 + totalAmount: 329.99 + totalTaxAmount: 57.27 + unitPrice: 329.99 + taxes: [] + discountAllocations: [] + - id: odl_1.x95vuk + quantity: 2 + taxPercentage: 21 + totalAmount: 698 + totalTaxAmount: 121.14 + unitPrice: 399 + taxes: [] + discountAllocations: + - name: Discount + totalAmount: 100 + payments: + - id: tr_GpHuaqHrca + amount: 1027.99 + currency: EUR + type: OnlineCard + status: Failed + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-02-08T15:44:22' + modifiedDate: '2022-03-17T15:47:28' + sourceModifiedDate: '2022-02-08T16:02:02' + - id: tr_w7RGQc3k3V + amount: 1027.99 + currency: EUR + type: OnlineCard + status: Failed + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-01-20T09:28:32' + modifiedDate: '2022-03-17T15:47:28' + sourceModifiedDate: '2022-01-20T09:46:02' + serviceCharges: [] + modifiedDate: '2022-03-17T15:47:28Z' + Mollie Test: + value: + id: ord_2at3ck + orderNumber: '1337' + country: NLD + currency: EUR + createdDate: '2022-01-20T09:28:32' + totalAmount: 1027.99 + totalRefund: 0 + totalTaxAmount: 178.41 + totalDiscount: 100 + totalGratuity: 0 + orderLineItems: + - id: odl_1.x95vuk + quantity: 2 + taxPercentage: 21 + totalAmount: 698 + totalTaxAmount: 121.14 + unitPrice: 338.43 + taxes: [] + discountAllocations: + - name: Discount + totalAmount: 100 + - id: odl_1.3tvc32 + quantity: 1 + taxPercentage: 21 + totalAmount: 329.99 + totalTaxAmount: 57.27 + unitPrice: 272.72 + taxes: [] + discountAllocations: [] + payments: + - id: tr_GpHuaqHrca + - id: tr_w7RGQc3k3V + serviceCharges: [] + modifiedDate: '2022-08-17T11:33:19Z' + Partner Commerce: + value: + id: 6d135134-2f77-45f7-af3d-ee873e42da45 + orderNumber: '93128704' + country: 'GM ' + currency: CAD + createdDate: '2021-02-10T01:37:23' + totalAmount: 203.82 + totalRefund: 0 + totalTaxAmount: 40.77 + totalDiscount: 25.63 + totalGratuity: 80.81 + orderLineItems: + - id: 89f5e83a-c87d-4b60-a009-0ea9065867aa + quantity: 3 + taxPercentage: 20 + totalAmount: 85.44 + totalTaxAmount: 17.09 + unitPrice: 28.48 + taxes: [] + productRef: + id: 98ef828e-33e1-4c23-9383-a029f1d6a3a6 + productVariantRef: + id: dffcd99e-13bb-4b89-89ef-719b3b0777e6 + discountAllocations: + - name: Discount + totalAmount: 8.54 + - name: Discount + totalAmount: 17.09 + - id: 4c65f0d9-05c8-48eb-9c4a-1774f5073e66 + quantity: 3 + taxPercentage: 20 + totalAmount: 118.38 + totalTaxAmount: 23.68 + unitPrice: 39.46 + taxes: [] + productRef: + id: 561f8efb-3429-4c1f-a014-1fa595f9b3c6 + productVariantRef: + id: e0715a7a-0179-4a2e-b40d-800fd2f36764 + discountAllocations: [] + payments: + - id: 3ec3d4c4-8003-4f77-a44e-08b3e17057bf + serviceCharges: [] + locationRef: + id: d84a8ce0-d7e4-400a-b07a-d4bddd9c1873 + customerRef: + id: 0dc0206d-f22f-48c9-a4e5-79f8383c3426 + modifiedDate: '2022-05-12T07:22:02Z' + sourceModifiedDate: '2021-02-10T01:37:23' + PrestaShop: + value: + id: '1' + orderNumber: XKBKNABJK + country: 'US ' + currency: USD + createdDate: '2021-09-02T06:00:54' + totalAmount: 61.8 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '1' + quantity: 1 + taxPercentage: 0 + totalAmount: 23.9 + totalTaxAmount: 0 + unitPrice: 23.9 + taxes: [] + productRef: + id: '1' + name: Hummingbird printed t-shirt + discountAllocations: [] + - id: '2' + quantity: 1 + taxPercentage: 0 + totalAmount: 35.9 + totalTaxAmount: 0 + unitPrice: 35.9 + taxes: [] + productRef: + id: '2' + name: Hummingbird printed sweater + discountAllocations: [] + payments: [] + serviceCharges: + - description: Shipping + totalAmount: 2 + taxPercentage: 0 + taxAmount: 0 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '1' + name: John DOE + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T06:00:54' + Shopify: + value: + id: '3684119445662' + orderNumber: '1007' + country: XXX + currency: GBP + createdDate: '2021-03-19T13:18:33' + totalAmount: 600 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '9670458146974' + quantity: 4 + taxPercentage: 0 + totalAmount: 600 + totalTaxAmount: 0 + unitPrice: 150 + taxes: [] + productRef: + id: '6595494117534' + name: Monitor + productVariantRef: + id: '39444526694558' + name: Monitor + discountAllocations: [] + payments: + - id: '4630233579678' + amount: 600 + currency: GBP + type: OnlineCard + status: Failed + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:17:49' + modifiedDate: '2023-02-10T15:18:24' + sourceModifiedDate: '2021-03-19T13:17:49' + - id: '4630234497182' + amount: 600 + currency: GBP + type: OnlineCard + status: Paid + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:18:29' + modifiedDate: '2023-02-10T15:18:24' + sourceModifiedDate: '2021-03-19T13:18:29' + serviceCharges: [] + customerRef: + id: '5097398534302' + name: Qa Test + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2022-08-01T13:12:35' + Square: + value: + id: BDYNvtIYyWClkTjnh99CFR3fPwKZY + orderNumber: BDYNvtIYyWClkTjnh99CFR3fPwKZY + country: 'GB ' + currency: GBP + createdDate: '2021-02-14T19:38:28Z' + closedDate: '0001-01-01T00:00:00' + totalAmount: 50 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: lLJpgArKQbBEn9nTvLRHP + quantity: 1 + taxPercentage: 0 + totalAmount: 50 + totalTaxAmount: 0 + unitPrice: 50 + taxes: [] + discountAllocations: [] + payments: [] + serviceCharges: [] + locationRef: + id: D8DVHD1G6NT2J + name: Codat Limited + modifiedDate: '2022-08-02T10:27:33Z' + sourceModifiedDate: '2021-02-14T19:38:28Z' + SumUp: + value: + id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + orderNumber: TECXTU2KT6 + country: XXX + currency: GBP + createdDate: '2021-03-30T12:20:40Z' + totalAmount: 200 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: Product undefined by SumUp + quantity: 1 + taxPercentage: 0 + totalAmount: 200 + totalTaxAmount: 0 + unitPrice: 200 + taxes: [] + discountAllocations: [] + payments: + - id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + serviceCharges: [] + modifiedDate: '2022-09-14T10:58:04Z' + WooCommerce: + value: + id: '111' + orderNumber: '111' + country: 'GB ' + currency: GBP + createdDate: '2021-03-27T23:29:38Z' + totalAmount: 39.5 + totalRefund: 0 + totalTaxAmount: 6 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '53' + quantity: 2 + taxPercentage: 20 + totalAmount: 12 + totalTaxAmount: 2 + unitPrice: 5 + taxes: [] + productRef: + id: '82' + discountAllocations: [] + - id: '54' + quantity: 2 + taxPercentage: 20 + totalAmount: 24 + totalTaxAmount: 4 + unitPrice: 10 + taxes: [] + productRef: + id: '81' + discountAllocations: [] + payments: [] + serviceCharges: + - description: Royal Mail + totalAmount: 3.5 + taxPercentage: 0 + taxAmount: 0 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '200585744' + modifiedDate: '2022-07-11T15:35:48Z' + sourceModifiedDate: '2021-04-01T13:34:59Z' + Zettle: + value: + id: 7TunRi2XEeueVK3fSQEQIw + orderNumber: '3' + country: 'GB ' + currency: GBP + createdDate: '2020-11-23T14:27:20Z' + totalAmount: 45 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '0' + quantity: 1 + taxPercentage: 0 + totalAmount: 45 + totalTaxAmount: 0 + unitPrice: 45 + taxes: [] + productRef: + id: 7f9f31e4-2d97-11eb-9f55-acde48001122 + productVariantRef: + id: 7f9f35ea-2d97-11eb-9f55-acde48001122 + discountAllocations: [] + payments: + - id: ed97bcde-2d97-11eb-a42e-25130f2dd258 + amount: 45 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:27:19' + modifiedDate: '2021-10-27T15:22:37' + serviceCharges: [] + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2020-11-23T14:27:20Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get order* endpoint returns a single order for a given orderId. + + [Orders](https://docs.codat.io/lending-api#/schemas/Order) contain the transaction details for all products sold by the company. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-paymentMethods': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List payment methods + tags: + - Sales + operationId: list-commerce-payment-methods + x-speakeasy-group: sales.payment-methods + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommercePaymentMethods' + examples: + Amazon Seller Central: + value: + results: + - id: COD + name: Cash On Delivery + status: Active + modifiedDate: '2023-01-09T09:12:03Z' + - id: GC + name: Gift Card + status: Active + modifiedDate: '2023-01-09T09:12:03Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-paymentMethods + next: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-paymentMethods?page=2&pageSize=2 + BigCommerce: + value: + results: + - id: bigcommerce_gift_certificate + name: Gift Certificate + status: Active + modifiedDate: '2023-04-11T10:33:48Z' + - id: bigcommerce_store_credit + name: Store Credit + status: Active + modifiedDate: '2023-04-11T10:33:48Z' + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-paymentMethods + Clover: + value: + results: + - id: 0DPQ6QP48YYHW + name: TapMango Wallet + status: Active + modifiedDate: '2023-01-09T11:01:04Z' + - id: 24H1ANYP1BNXG + name: MyTab + status: Active + modifiedDate: '2023-01-09T11:01:04Z' + pageNumber: 1 + pageSize: 2 + totalResults: 13 + _links: + current: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-paymentMethods + next: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-paymentMethods?page=2&pageSize=2 + Lightspeed K Trial: + value: + results: + - id: '647208621834260' + name: Cash + status: Active + modifiedDate: '2023-03-02T09:48:56Z' + - id: '647208621834261' + name: Credit Card + status: Active + modifiedDate: '2023-03-02T09:48:56Z' + pageNumber: 1 + pageSize: 2 + totalResults: 11 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-paymentMethods + next: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-paymentMethods?page=2&pageSize=2 + Mollie: + value: + results: + - id: applepay + name: Apple Pay + status: Unknown + modifiedDate: '2022-08-09T15:08:19Z' + - id: bancontact + name: Bancontact + status: Unknown + modifiedDate: '2022-08-09T15:08:19Z' + pageNumber: 1 + pageSize: 2 + totalResults: 19 + _links: + current: + href: /companies/a2503b54-143c-4705-8bec-9ef84f51ca86/connections/4c8df852-f1b3-4642-939b-c33d6f34a312/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/a2503b54-143c-4705-8bec-9ef84f51ca86/connections/4c8df852-f1b3-4642-939b-c33d6f34a312/data/commerce-paymentMethods + next: + href: /companies/a2503b54-143c-4705-8bec-9ef84f51ca86/connections/4c8df852-f1b3-4642-939b-c33d6f34a312/data/commerce-paymentMethods?page=2&pageSize=2 + Mollie Test: + value: + results: + - id: applepay + name: Apple Pay + status: Unknown + modifiedDate: '2022-08-17T11:33:19Z' + - id: bancontact + name: Bancontact + status: Unknown + modifiedDate: '2022-08-17T11:33:19Z' + pageNumber: 1 + pageSize: 2 + totalResults: 19 + _links: + current: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-paymentMethods + next: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-paymentMethods?page=2&pageSize=2 + Square: + value: + results: + - id: BANK_ACCOUNT + name: Bank Account + status: Unknown + modifiedDate: '2022-08-02T10:27:32Z' + - id: BUY_NOW_PAY_LATER + name: Buy Now Pay Later + status: Unknown + modifiedDate: '2022-08-02T10:27:32Z' + pageNumber: 1 + pageSize: 2 + totalResults: 20 + _links: + current: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-paymentMethods + next: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-paymentMethods?page=2&pageSize=2 + SumUp: + value: + results: + - id: CASH + name: Cash + status: Active + modifiedDate: '2022-09-14T10:58:03Z' + - id: CC_CUSTOMER_ENTERED + name: Credit Card + status: Active + modifiedDate: '2022-09-14T10:58:03Z' + pageNumber: 1 + pageSize: 2 + totalResults: 8 + _links: + current: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-paymentMethods + next: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-paymentMethods?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List payment methods* endpoint returns a list of [payment methods](https://docs.codat.io/lending-api#/schemas/PaymentMethod) for a given company's connection. + + [Payment methods](https://docs.codat.io/lending-api#/schemas/PaymentMethod) represent the payment method(s) used to make payments. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + '/companies/{companyId}/connections/{connectionId}/data/commerce-paymentMethods/{paymentMethodId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: paymentMethodId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a payment method. + get: + summary: Get payment method + tags: + - Sales + operationId: get-commerce-payment-method + x-speakeasy-group: sales.payment-methods + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommercePaymentMethod' + examples: + Amazon Seller Central: + value: + id: COD + name: Cash On Delivery + status: Active + modifiedDate: '2023-01-09T09:12:03Z' + BigCommerce: + value: + id: bigcommerce_gift_certificate + name: Gift Certificate + status: Active + modifiedDate: '2023-04-11T10:33:48Z' + Clover: + value: + id: 0DPQ6QP48YYHW + name: TapMango Wallet + status: Active + modifiedDate: '2023-01-09T11:01:04Z' + Lightspeed K Trial: + value: + id: '647208621834260' + name: Cash + status: Active + modifiedDate: '2023-03-02T09:48:56Z' + Mollie: + value: + id: applepay + name: Apple Pay + status: Unknown + modifiedDate: '2022-08-09T15:08:19Z' + Mollie Test: + value: + id: applepay + name: Apple Pay + status: Unknown + modifiedDate: '2022-08-17T11:33:19Z' + Square: + value: + id: BANK_ACCOUNT + name: Bank Account + status: Unknown + modifiedDate: '2022-08-02T10:27:32Z' + SumUp: + value: + id: CASH + name: Cash + status: Active + modifiedDate: '2022-09-14T10:58:03Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get payment method* endpoint returns a single payment method for a given paymentMethodId. + + [Payment methods](https://docs.codat.io/lending-api#/schemas/PaymentMethod) represent the payment method(s) used to make payments. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-payments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List payments + tags: + - Sales + operationId: list-commerce-payments + x-speakeasy-group: sales.payments + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommercePayments' + examples: + BigCommerce: + value: + results: + - id: 103_1_1_refund + amount: -64 + currency: GBP + type: Unknown + status: Paid + paymentProvider: bigpaypay + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-06-15T17:13:13Z' + modifiedDate: '2023-04-11T10:33:52Z' + - id: 105_2_2_refund + amount: -33.95 + currency: GBP + type: Unknown + status: Paid + paymentProvider: bigpaypay + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-06-24T13:57:01Z' + modifiedDate: '2023-04-11T10:33:52Z' + pageNumber: 1 + pageSize: 2 + totalResults: 20 + _links: + current: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-payments + next: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-payments?page=2&pageSize=2 + Clover: + value: + results: + - id: 01J7HV88GT6B8 + amount: 1000 + currency: USD + paymentMethodRef: + id: BR5M17TG091SP + name: Credit Card + type: Card + status: Paid + paymentProvider: clover + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-05-24T10:35:08Z' + modifiedDate: '2023-01-09T11:01:02Z' + sourceModifiedDate: '2021-05-24T10:35:08Z' + - id: 0A8ZMPG40Q9AM + amount: 1000 + currency: USD + paymentMethodRef: + id: BR5M17TG091SP + name: Credit Card + type: Card + status: Paid + paymentProvider: clover + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-05-24T10:35:31Z' + modifiedDate: '2023-01-09T11:01:02Z' + sourceModifiedDate: '2021-05-24T10:35:31Z' + pageNumber: 1 + pageSize: 2 + totalResults: 77 + _links: + current: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-payments + next: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-payments?page=2&pageSize=2 + Lightspeed K Trial: + value: + results: + - id: '1_A62084.1_2023-01-05T03:34:50.296Z' + amount: 0 + currency: AUD + paymentMethodRef: + id: '0' + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2023-01-05T03:34:50Z' + modifiedDate: '2023-03-02T09:50:43Z' + - id: 'R61465.1_1_A61465.1_2022-12-09T02:27:46.273Z' + amount: 5 + currency: AUD + paymentMethodRef: + id: '647208621834714' + name: LSPay - Mary + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-12-09T02:27:46Z' + modifiedDate: '2023-03-02T09:50:43Z' + pageNumber: 1 + pageSize: 2 + totalResults: 26 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-payments + next: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-payments?page=2&pageSize=2 + Mollie: + value: + results: + - id: re_Azhe8TzfUK + amount: -20 + currency: EUR + type: OnlineCard + status: Paid + paymentProvider: mollie + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-03-17T16:15:23Z' + - id: re_NPKEJhQveu + amount: -60 + currency: EUR + type: OnlineCard + status: Paid + paymentProvider: mollie + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-01-17T16:00:05' + modifiedDate: '2022-03-17T16:15:23Z' + pageNumber: 1 + pageSize: 2 + totalResults: 16 + _links: + current: + href: /companies/65fe5864-16d7-41f4-8823-87ae1cf3a283/connections/1dbbf0ab-a27a-45b0-982a-ae0d8985affc/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/65fe5864-16d7-41f4-8823-87ae1cf3a283/connections/1dbbf0ab-a27a-45b0-982a-ae0d8985affc/data/commerce-payments + next: + href: /companies/65fe5864-16d7-41f4-8823-87ae1cf3a283/connections/1dbbf0ab-a27a-45b0-982a-ae0d8985affc/data/commerce-payments?page=2&pageSize=2 + PrestaShop: + value: + results: + - id: '1' + amount: 20.9 + currency: USD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-09-08T01:52:55' + modifiedDate: '2022-01-26T15:09:42Z' + - id: '2' + amount: 20.9 + currency: USD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-09-08T01:53:28' + modifiedDate: '2022-01-26T15:09:42Z' + pageNumber: 1 + pageSize: 2 + totalResults: 5 + _links: + current: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-payments + next: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-payments?page=2&pageSize=2 + Shopify: + value: + results: + - id: '4630233579678' + amount: 600 + currency: GBP + type: OnlineCard + status: Failed + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:17:49Z' + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2021-03-19T13:17:49Z' + - id: '4630234497182' + amount: 600 + currency: GBP + type: OnlineCard + status: Paid + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:18:29Z' + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2021-03-19T13:18:29Z' + pageNumber: 1 + pageSize: 2 + totalResults: 46 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-payments + next: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-payments?page=2&pageSize=2 + SumUp: + value: + results: + - id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + amount: 200 + currency: GBP + type: OnlineCard + status: Cancelled + paymentProvider: sumup + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-30T12:20:40Z' + modifiedDate: '2022-03-17T16:13:46Z' + - id: 46d36a64-ea48-4e37-9340-3548cbf3ca2f + amount: 15 + currency: GBP + type: Cash + status: Paid + paymentProvider: sumup + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-26T21:09:59Z' + modifiedDate: '2022-03-17T16:13:46Z' + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/d9e78460-7ee5-4a34-a3f4-9652a5946b1f/connections/60959ebe-8491-4368-bf0a-f715c3ce2e53/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/d9e78460-7ee5-4a34-a3f4-9652a5946b1f/connections/60959ebe-8491-4368-bf0a-f715c3ce2e53/data/commerce-payments + next: + href: /companies/d9e78460-7ee5-4a34-a3f4-9652a5946b1f/connections/60959ebe-8491-4368-bf0a-f715c3ce2e53/data/commerce-payments?page=2&pageSize=2 + WooCommerce: + value: + results: + - id: '33' + amount: 0 + currency: GBP + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-11T09:07:00Z' + modifiedDate: '2021-07-13T16:19:00Z' + - id: '35' + amount: 30 + currency: GBP + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-11T09:08:56Z' + modifiedDate: '2021-07-13T16:19:00Z' + pageNumber: 1 + pageSize: 2 + totalResults: 5 + _links: + current: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-payments + next: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-payments?page=2&pageSize=2 + Zettle: + value: + results: + - id: 09b94cfc-2d98-11eb-8021-0e1b9dcbeca1 + amount: 25 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:28:04Z' + modifiedDate: '2021-10-27T15:22:37Z' + - id: 226580d6-2d98-11eb-a35c-fed5e63de507 + amount: 58.5 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:28:47Z' + modifiedDate: '2021-10-27T15:22:37Z' + pageNumber: 1 + pageSize: 2 + totalResults: 8 + _links: + current: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-payments + next: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-payments?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List payments* endpoint returns a list of [payments](https://docs.codat.io/lending-api#/schemas/Payment) for a given company's connection. + + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) contain details of all payments made by customers to the company. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + '/companies/{companyId}/connections/{connectionId}/data/commerce-payments/{paymentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/paymentId' + get: + summary: Get payment + tags: + - Sales + operationId: get-commerce-payment + x-speakeasy-group: sales.payments + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommercePayment' + examples: + BigCommerce: + value: + id: 103_1_1_refund + amount: -64 + currency: GBP + type: Unknown + status: Paid + paymentProvider: bigpaypay + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-06-15T17:13:13Z' + modifiedDate: '2023-04-11T10:33:52Z' + Clover: + value: + id: 01J7HV88GT6B8 + amount: 1000 + currency: USD + paymentMethodRef: + id: BR5M17TG091SP + name: Credit Card + type: Card + status: Paid + paymentProvider: clover + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-05-24T10:35:08Z' + modifiedDate: '2023-01-09T11:01:02Z' + sourceModifiedDate: '2021-05-24T10:35:08Z' + Lightspeed K Trial: + value: + id: '1_A62084.1_2023-01-05T03:34:50.296Z' + amount: 0 + currency: AUD + paymentMethodRef: + id: '0' + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2023-01-05T03:34:50Z' + modifiedDate: '2023-03-02T09:50:43Z' + Mollie: + value: + id: re_Azhe8TzfUK + amount: -20 + currency: EUR + type: OnlineCard + status: Paid + paymentProvider: mollie + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-03-17T16:15:23Z' + PrestaShop: + value: + id: '1' + amount: 20.9 + currency: USD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-09-08T01:52:55' + modifiedDate: '2022-01-26T15:09:42Z' + Shopify: + value: + id: '4630233579678' + amount: 600 + currency: GBP + type: OnlineCard + status: Failed + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:17:49Z' + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2021-03-19T13:17:49Z' + SumUp: + value: + id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + amount: 200 + currency: GBP + type: OnlineCard + status: Cancelled + paymentProvider: sumup + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-30T12:20:40Z' + modifiedDate: '2022-03-17T16:13:46Z' + WooCommerce: + value: + id: '33' + amount: 0 + currency: GBP + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-11T09:07:00Z' + modifiedDate: '2021-07-13T16:19:00Z' + Zettle: + value: + id: 09b94cfc-2d98-11eb-8021-0e1b9dcbeca1 + amount: 25 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:28:04Z' + modifiedDate: '2021-10-27T15:22:37Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get payment* endpoint returns a single payment for a given paymentId. + + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) contain details of all payments made by customers to the company. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-productCategories': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List product categories + tags: + - Sales + operationId: list-commerce-product-categories + x-speakeasy-group: sales.product-categories + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceProductCategories' + examples: + Lightspeed K Trial: + value: + results: + - id: '647208621834281' + name: Alcoholic beverages + ancestorRefs: [] + hasChildren: false + modifiedDate: '2023-03-02T09:49:11Z' + - id: '647208621834282' + name: NA beverages + ancestorRefs: [] + hasChildren: false + modifiedDate: '2023-03-02T09:49:11Z' + pageNumber: 1 + pageSize: 2 + totalResults: 8 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-productCategories?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-productCategories + next: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-productCategories?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + description: |- + The *List product categories* endpoint returns a list of [product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) for a given company's connection. + + [Product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + '/companies/{companyId}/connections/{connectionId}/data/commerce-productCategories/{productId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/productId' + get: + summary: Get product category + tags: + - Sales + operationId: get-commerce-product-category + x-speakeasy-group: sales.product-categories + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceProductCategory' + examples: + Lightspeed K Trial: + value: + id: '647208621834281' + name: Alcoholic beverages + ancestorRefs: [] + hasChildren: false + modifiedDate: '2023-03-02T09:49:11Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get product* endpoint returns a single product for a given productId. + + [Product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-products': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List products + tags: + - Sales + operationId: list-commerce-products + x-speakeasy-group: sales.products + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceProducts' + examples: + Amazon Seller Central: + value: + results: + - id: Chromecast + categorization: DEVICE + name: Chromecast + description: Cast from your phone to your TV with this all new chromecast. + productCategoryRefs: [] + isGiftCard: false + variants: + - id: packaging_asin_gating + name: Chromecast in a cardboard box + quantity: 0 + isTaxEnabled: false + sku: packaging_asin_gating + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 50 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-07T12:30:01Z' + createdDate: '2021-02-07T12:30:01Z' + modifiedDate: '2023-01-09T09:12:11Z' + sourceModifiedDate: '2022-08-17T09:07:07Z' + status: Published + - id: vb554a-bl1915 + categorization: COAT + name: Waterproof Jacket + description: 'Wind and rainproof, keeping you dry all year round.' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: 'ARRIS,SB6141' + name: Waterproof Jacket (Black) + quantity: 0 + isTaxEnabled: false + sku: 'ARRIS,SB6141' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-07T12:30:01Z' + - id: RTN66U-N9000 + name: Waterproof Jacket (Blue) + quantity: 0 + isTaxEnabled: false + sku: RTN66U-N9000 + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-07T12:30:01Z' + - id: TLWR841N + name: Waterproof Jacket (Red) + quantity: 0 + isTaxEnabled: false + sku: TLWR841N + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-07T12:30:01Z' + createdDate: '2021-02-07T12:30:01Z' + modifiedDate: '2023-01-09T09:12:11Z' + sourceModifiedDate: '2022-08-17T09:07:07Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-products + next: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-products?page=2&pageSize=2 + BigCommerce: + value: + results: + - id: '103' + categorization: 'Shop All, Utility' + name: '[Sample] Canvas Laundry Cart' + description: 'The last laundry cart you''ll ever buy. This industrial non-collapsable cart is constructed with a steel framed body using heavyweight canvas capped with a soft leather rim sitting on four smooth rolling casters. Keeps the grubby garments off the floor and almost makes laundry enjoyable. Can also be used as the ideal storage solution: many people find it ideal for children''s toys or a load of chopped firewood. Load it up and wheel it away. Natural Heavyweight Canvas with Vegetable Tanned Leather Rim Measure�' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '71' + name: '[Sample] Canvas Laundry Cart' + quantity: 0 + isTaxEnabled: false + sku: CLC + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2015-07-03T18:48:07Z' + modifiedDate: '2023-04-11T10:33:49Z' + sourceModifiedDate: '2022-06-16T07:59:46Z' + status: Published + - id: '104' + categorization: 'Shop All, Utility' + name: '[Sample] Utility Caddy' + description: 'This powder coated steel utility caddy ensures your cleaning essentials are stowed away in one spot ready for your household chores. Brushes, cloths, liquid soaps can all easily be stashed away. Also ideal to be used as a garden caddy to easily grab from the shed for a days work. Works well as a mop bucket too. The wood carrying handle ensures a comfortable grip when toting it from room to room. Measures 19 h x 36 w x 20 dia cm/7.5 h x 14.1 w x 7.8 dia in' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '72' + name: '[Sample] Utility Caddy' + quantity: 0 + isTaxEnabled: false + sku: OFSUC + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 45.95 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2015-07-03T18:49:26Z' + modifiedDate: '2023-04-11T10:33:49Z' + sourceModifiedDate: '2015-07-03T20:45:54Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 18 + _links: + current: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-products + next: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-products?page=2&pageSize=2 + Clover: + value: + results: + - id: DJANHKK2AVEYY + name: Coffee + description: Coffee + productCategoryRefs: [] + isGiftCard: false + variants: + - id: DJANHKK2AVEYY + name: Coffee + quantity: 0 + isTaxEnabled: true + sku: '12222' + barcode: '1234' + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 3 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '2021-05-24T15:50:55Z' + status: Published + - id: NMZHKK6FKF6ZJ + name: Laptop + description: Cool Laptop + productCategoryRefs: [] + isGiftCard: false + variants: + - id: NMZHKK6FKF6ZJ + name: Laptop + quantity: 0 + isTaxEnabled: true + sku: '111' + barcode: '123' + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 1000 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '2021-05-24T08:19:14Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-products + next: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-products?page=2&pageSize=2 + Lightspeed K Trial: + value: + results: + - id: '647208621834539' + categorization: Alcoholic beverages + name: Alcoholic beverages + description: Alcoholic beverages + productCategoryRefs: + - id: '647208621834281' + name: Alcoholic beverages + isGiftCard: false + variants: [] + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-03-02T09:50:32Z' + status: Published + - id: '647208621834542' + categorization: NA beverages + name: NA beverages + description: NA beverages + productCategoryRefs: + - id: '647208621834282' + name: NA beverages + isGiftCard: false + variants: [] + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-03-02T09:50:32Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 39 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-products + next: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-products?page=2&pageSize=2 + PrestaShop: + value: + results: + - id: '1' + categorization: Home - Clothes - Men + name: Hummingbird printed t-shirt + description: 'Symbol of lightness and delicacy, the hummingbird evokes curiosity and joy. Studio Design'' PolyFaune collection features classic products with colorful patterns, inspired by the traditional japanese origamis. To wear with a chino or jeans. The sublimation textile printing process provides an exceptional color rendering and a color, guaranteed overtime.' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '8' + name: 'Hummingbird printed t-shirt (Size = XL, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '4' + name: 'Hummingbird printed t-shirt (Size = M, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '5' + name: 'Hummingbird printed t-shirt (Size = L, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '3' + name: 'Hummingbird printed t-shirt (Size = M, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '6' + name: 'Hummingbird printed t-shirt (Size = L, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '1' + name: 'Hummingbird printed t-shirt (Size = S, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '2' + name: 'Hummingbird printed t-shirt (Size = S, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '7' + name: 'Hummingbird printed t-shirt (Size = XL, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-09-02T06:00:49' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T06:00:49' + status: Published + - id: '10' + categorization: Home - Accessories - Home Accessories + name: Brown bear cushion + description: 'The brown bear cushion will add a graphic and colorful touch to your sofa, armchair or bed. Create a modern and zen atmosphere that inspires relaxation. Cover 100% cotton, machine washable at 60� / Filling 100% hypoallergenic polyester.' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '24' + name: Brown bear cushion (Color = White) + quantity: 0 + isTaxEnabled: true + sku: demo_16 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 18.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '25' + name: Brown bear cushion (Color = Black) + quantity: 0 + isTaxEnabled: true + sku: demo_16 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 18.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-09-02T06:00:49' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T06:00:49' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 22 + _links: + current: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-products + next: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-products?page=2&pageSize=2 + Shopify: + value: + results: + - id: '6595494117534' + categorization: Asus + name: Monitor + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '39444526694558' + name: Monitor + quantity: 0 + isTaxEnabled: true + sku: '' + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 150 + inventory: + totalQuantity: 91 + locations: [] + shippingRequired: true + createdDate: '2021-03-19T10:13:22Z' + createdDate: '2021-03-19T10:13:22Z' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2022-08-01T13:05:22Z' + status: Published + - id: '6595497066654' + categorization: Logitech + name: Mouse + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '39444533706910' + name: Mouse + quantity: 0 + isTaxEnabled: false + sku: '' + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 25 + inventory: + totalQuantity: 71 + locations: [] + shippingRequired: true + createdDate: '2021-03-19T10:14:01Z' + createdDate: '2021-03-19T10:14:01Z' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2022-08-01T13:05:22Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-products + next: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-products?page=2&pageSize=2 + Square: + value: + results: + - id: AX54KZQ3UAVCVPUMNEGFEU35 + categorization: Hardware + name: Monitor + productCategoryRefs: [] + isGiftCard: false + variants: + - id: A5BUT6SYUNYRSQ2R7GZ6UKN6 + name: Regular + quantity: 0 + isTaxEnabled: true + vatPercentage: 10 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-18T15:47:31Z' + createdDate: '2021-02-18T15:47:31Z' + modifiedDate: '2021-06-17T14:23:02Z' + sourceModifiedDate: '2021-02-18T15:47:31Z' + status: Unknown + - id: FYRIQNFTFRGQNQZGZG66MJWI + categorization: Furniture + name: Desk + productCategoryRefs: [] + isGiftCard: false + variants: + - id: VMKSQEABA3WIYGXNAV63JOTZ + name: Regular + quantity: 0 + isTaxEnabled: true + vatPercentage: 10 + prices: + - currency: GBP + unitPrice: 70 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-18T15:47:45Z' + createdDate: '2021-02-18T15:47:45Z' + modifiedDate: '2021-06-17T14:23:02Z' + sourceModifiedDate: '2021-02-18T15:47:45Z' + status: Unknown + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/25debd39-e024-41a1-a86c-4fd47f29c853/connections/d5071fdf-a769-48f3-b39e-e588d515bb83/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/25debd39-e024-41a1-a86c-4fd47f29c853/connections/d5071fdf-a769-48f3-b39e-e588d515bb83/data/commerce-products + next: + href: /companies/25debd39-e024-41a1-a86c-4fd47f29c853/connections/d5071fdf-a769-48f3-b39e-e588d515bb83/data/commerce-products?page=2&pageSize=2 + Stripe Test: + value: + results: + - id: prod_IaSbzLnxOHmC0i + name: Blue T Shirt + description: Nice cozy cotton t shirt + productCategoryRefs: [] + isGiftCard: false + variants: + - id: price_1ICJVEA8m8S1Gh7OIOCDOG8j + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 15 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-01-22T06:52:16Z' + - id: price_1ICJQgA8m8S1Gh7OfErQdx5R + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: USD + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-01-22T06:47:34Z' + - id: price_1HzHiCA8m8S1Gh7OXZVa6r3F + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 15 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2020-12-17T08:19:48Z' + createdDate: '2020-12-17T08:17:48Z' + modifiedDate: '2022-09-30T11:18:27Z' + sourceModifiedDate: '2021-01-22T06:52:17Z' + status: Published + - id: prod_IQ6G1MDsvUb87Y + name: Laptop + productCategoryRefs: [] + isGiftCard: false + variants: + - id: price_1HpG3tA8m8S1Gh7Oa6bGLvVD + name: Laptop - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 100 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2020-11-19T16:32:45Z' + createdDate: '2020-11-19T16:32:45Z' + modifiedDate: '2022-09-30T11:18:27Z' + sourceModifiedDate: '2022-05-12T23:31:33Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-products + next: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-products?page=2&pageSize=2 + WooCommerce: + value: + results: + - id: '27' + categorization: Hardware + name: Monitor + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '27' + name: Monitor + quantity: 0 + isTaxEnabled: true + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 150 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-03-11T08:55:22' + createdDate: '2021-03-11T08:55:22' + modifiedDate: '2021-07-13T16:19:00Z' + sourceModifiedDate: '2021-03-11T09:03:15' + status: Published + - id: '28' + categorization: Hardware + name: Keyboard + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '28' + name: Keyboard + quantity: 0 + isTaxEnabled: true + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-03-11T09:02:58' + createdDate: '2021-03-11T09:02:58' + modifiedDate: '2021-07-13T16:19:00Z' + sourceModifiedDate: '2021-03-11T09:02:58' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-products + next: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-products?page=2&pageSize=2 + Zettle: + value: + results: + - id: 9d21fd90-a34a-11eb-b574-ad6abe469b61 + categorization: Clothing + name: T-Shirt + productCategoryRefs: [] + isGiftCard: false + variants: + - id: bb9bcf30-a34a-11eb-b574-ad6abe469b61 + name: Medium + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: b919df40-a34a-11eb-b574-ad6abe469b61 + name: Large + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: bcb5cab0-a34a-11eb-b574-ad6abe469b61 + name: Small + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-04-22T09:12:09Z' + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2021-08-04T14:32:20Z' + status: Published + - id: e02c2930-a34a-11eb-b9db-8f5efc0924aa + categorization: Clothing + name: Hoodie + productCategoryRefs: [] + isGiftCard: false + variants: + - id: fa180e40-a34a-11eb-b9db-8f5efc0924aa + name: Medium + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: fc412fd0-a34a-11eb-b9db-8f5efc0924aa + name: Extra Large + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: f8a03b50-a34a-11eb-b9db-8f5efc0924aa + name: Small + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: fac1bbc0-a34a-11eb-b9db-8f5efc0924aa + name: Large + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-04-22T09:13:26Z' + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2021-08-04T14:31:58Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-products + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + description: |- + The *List products* endpoint returns a list of [products](https://docs.codat.io/lending-api#/schemas/Product) for a given company's connection. + + [Products](https://docs.codat.io/lending-api#/schemas/Product) are items in the company's inventory that are available for sale. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + '/companies/{companyId}/connections/{connectionId}/data/commerce-products/{productId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/productId' + get: + summary: Get product + tags: + - Sales + operationId: get-commerce-product + x-speakeasy-group: sales.products + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceProduct' + examples: + Amazon Seller Central: + value: + id: Chromecast + categorization: DEVICE + name: Chromecast + description: Cast from your phone to your TV with this all new chromecast. + productCategoryRefs: [] + isGiftCard: false + variants: + - id: packaging_asin_gating + name: Chromecast in a cardboard box + quantity: 0 + isTaxEnabled: false + sku: packaging_asin_gating + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 50 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-07T12:30:01Z' + createdDate: '2021-02-07T12:30:01Z' + modifiedDate: '2023-01-09T09:12:11Z' + sourceModifiedDate: '2022-08-17T09:07:07Z' + status: Published + BigCommerce: + value: + id: '103' + categorization: 'Shop All, Utility' + name: '[Sample] Canvas Laundry Cart' + description: 'The last laundry cart you''ll ever buy. This industrial non-collapsable cart is constructed with a steel framed body using heavyweight canvas capped with a soft leather rim sitting on four smooth rolling casters. Keeps the grubby garments off the floor and almost makes laundry enjoyable. Can also be used as the ideal storage solution: many people find it ideal for children''s toys or a load of chopped firewood. Load it up and wheel it away. Natural Heavyweight Canvas with Vegetable Tanned Leather Rim Measure�' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '71' + name: '[Sample] Canvas Laundry Cart' + quantity: 0 + isTaxEnabled: false + sku: CLC + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2015-07-03T18:48:07Z' + modifiedDate: '2023-04-11T10:33:49Z' + sourceModifiedDate: '2022-06-16T07:59:46Z' + status: Published + Clover: + value: + id: DJANHKK2AVEYY + name: Coffee + description: Coffee + productCategoryRefs: [] + isGiftCard: false + variants: + - id: DJANHKK2AVEYY + name: Coffee + quantity: 0 + isTaxEnabled: true + sku: '12222' + barcode: '1234' + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 3 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '2021-05-24T15:50:55Z' + status: Published + Lightspeed K Trial: + value: + id: '647208621834539' + categorization: Alcoholic beverages + name: Alcoholic beverages + description: Alcoholic beverages + productCategoryRefs: + - id: '647208621834281' + name: Alcoholic beverages + isGiftCard: false + variants: [] + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-03-02T09:50:32Z' + status: Published + PrestaShop: + value: + id: '1' + categorization: Home - Clothes - Men + name: Hummingbird printed t-shirt + description: 'Symbol of lightness and delicacy, the hummingbird evokes curiosity and joy. Studio Design'' PolyFaune collection features classic products with colorful patterns, inspired by the traditional japanese origamis. To wear with a chino or jeans. The sublimation textile printing process provides an exceptional color rendering and a color, guaranteed overtime.' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '8' + name: 'Hummingbird printed t-shirt (Size = XL, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '4' + name: 'Hummingbird printed t-shirt (Size = M, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '5' + name: 'Hummingbird printed t-shirt (Size = L, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '3' + name: 'Hummingbird printed t-shirt (Size = M, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '6' + name: 'Hummingbird printed t-shirt (Size = L, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '1' + name: 'Hummingbird printed t-shirt (Size = S, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '2' + name: 'Hummingbird printed t-shirt (Size = S, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '7' + name: 'Hummingbird printed t-shirt (Size = XL, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-09-02T06:00:49' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T06:00:49' + status: Published + Shopify: + value: + id: '6595494117534' + categorization: Asus + name: Monitor + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '39444526694558' + name: Monitor + quantity: 0 + isTaxEnabled: true + sku: '' + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 150 + inventory: + totalQuantity: 91 + locations: [] + shippingRequired: true + createdDate: '2021-03-19T10:13:22Z' + createdDate: '2021-03-19T10:13:22Z' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2022-08-01T13:05:22Z' + status: Published + Square: + value: + id: AX54KZQ3UAVCVPUMNEGFEU35 + categorization: Hardware + name: Monitor + productCategoryRefs: [] + isGiftCard: false + variants: + - id: A5BUT6SYUNYRSQ2R7GZ6UKN6 + name: Regular + quantity: 0 + isTaxEnabled: true + vatPercentage: 10 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-18T15:47:31Z' + createdDate: '2021-02-18T15:47:31Z' + modifiedDate: '2021-06-17T14:23:02Z' + sourceModifiedDate: '2021-02-18T15:47:31Z' + status: Unknown + Stripe Test: + value: + id: prod_IaSbzLnxOHmC0i + name: Blue T Shirt + description: Nice cozy cotton t shirt + productCategoryRefs: [] + isGiftCard: false + variants: + - id: price_1ICJVEA8m8S1Gh7OIOCDOG8j + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 15 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-01-22T06:52:16Z' + - id: price_1ICJQgA8m8S1Gh7OfErQdx5R + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: USD + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-01-22T06:47:34Z' + - id: price_1HzHiCA8m8S1Gh7OXZVa6r3F + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 15 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2020-12-17T08:19:48Z' + createdDate: '2020-12-17T08:17:48Z' + modifiedDate: '2022-09-30T11:18:27Z' + sourceModifiedDate: '2021-01-22T06:52:17Z' + status: Published + WooCommerce: + value: + id: '27' + categorization: Hardware + name: Monitor + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '27' + name: Monitor + quantity: 0 + isTaxEnabled: true + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 150 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-03-11T08:55:22' + createdDate: '2021-03-11T08:55:22' + modifiedDate: '2021-07-13T16:19:00Z' + sourceModifiedDate: '2021-03-11T09:03:15' + status: Published + Zettle: + value: + id: 9d21fd90-a34a-11eb-b574-ad6abe469b61 + categorization: Clothing + name: T-Shirt + productCategoryRefs: [] + isGiftCard: false + variants: + - id: bb9bcf30-a34a-11eb-b574-ad6abe469b61 + name: Medium + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: b919df40-a34a-11eb-b574-ad6abe469b61 + name: Large + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: bcb5cab0-a34a-11eb-b574-ad6abe469b61 + name: Small + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-04-22T09:12:09Z' + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2021-08-04T14:32:20Z' + status: Published + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get product* endpoint returns a single product for a given productId. + + [Products](https://docs.codat.io/lending-api#/schemas/Product) are items in the company's inventory that are available for sale. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-transactions': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List transactions + tags: + - Sales + operationId: list-commerce-transactions + x-speakeasy-group: sales.transactions + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceTransactions' + examples: + Mollie: + value: + results: + - id: re_Azhe8TzfUK + totalAmount: -20 + currency: EUR + type: Refund + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-03-17T15:47:28Z' + - id: re_NPKEJhQveu + totalAmount: -60 + currency: EUR + type: Refund + createdDate: '2022-01-17T16:00:05' + modifiedDate: '2022-03-17T15:47:28Z' + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-transactions + next: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-transactions?page=2&pageSize=2 + Mollie Test: + value: + results: + - id: re_Azhe8TzfUK + totalAmount: -20 + currency: EUR + type: Refund + subType: PaymentRefund + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-08-17T11:33:19Z' + - id: re_NPKEJhQveu + totalAmount: -60 + currency: EUR + type: Refund + subType: PaymentRefund + createdDate: '2022-01-17T16:00:05' + modifiedDate: '2022-08-17T11:33:19Z' + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-transactions + next: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-transactions?page=2&pageSize=2 + Shopify: + value: + results: + - id: ShopifyPayment-1633176289438 + totalAmount: 175 + currency: GBP + type: Payment + subType: charge + transactionSourceRef: + id: '3684116791454' + type: Order + createdDate: '2021-03-19T13:16:26' + modifiedDate: '2023-02-10T15:18:23Z' + sourceModifiedDate: '2021-03-19T13:16:26' + - id: 'ShopifyPayment-1633176289438:Fee' + totalAmount: -4.05 + currency: GBP + type: PaymentFee + subType: charge + transactionSourceRef: + id: '3684116791454' + type: Order + createdDate: '2021-03-19T13:16:26' + modifiedDate: '2023-02-10T15:18:23Z' + sourceModifiedDate: '2021-03-19T13:16:26' + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-transactions + next: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-transactions?page=2&pageSize=2 + Stripe Test: + value: + results: + - id: txn_1HpGQUA8m8S1Gh7OR21pB0Yj + totalAmount: 50 + currency: GBP + type: Payment + subType: charge + transactionSourceRef: + id: ch_1HpGQUA8m8S1Gh7Ot4WDTus5 + type: Payment + createdDate: '2020-11-19T16:56:06Z' + modifiedDate: '2022-09-30T11:18:28Z' + - id: 'txn_1HpGQUA8m8S1Gh7OR21pB0Yj:Stripe processing fees' + totalAmount: -0.9 + currency: GBP + type: PaymentFee + subType: stripe_fee + transactionSourceRef: + id: ch_1HpGQUA8m8S1Gh7Ot4WDTus5 + type: Payment + createdDate: '2020-11-19T16:56:06Z' + modifiedDate: '2022-09-30T11:18:28Z' + pageNumber: 1 + pageSize: 2 + totalResults: 70 + _links: + current: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-transactions + next: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-transactions?page=2&pageSize=2 + SumUp: + value: + results: + - id: 46d36a64-ea48-4e37-9340-3548cbf3ca2f + totalAmount: 15 + currency: GBP + type: Payment + subType: PAYMENT + createdDate: '2021-03-26T21:09:59Z' + modifiedDate: '2022-09-14T10:58:03Z' + - id: 471914a4-a82f-4fc4-b39b-9986fd706d26 + totalAmount: 215 + currency: GBP + type: Payment + subType: PAYMENT + createdDate: '2021-03-30T12:22:14Z' + modifiedDate: '2022-09-14T10:58:03Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-transactions + next: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-transactions?page=2&pageSize=2 + Zettle: + value: + results: + - id: 'PAYMENT:09b94cfc-2d98-11eb-8021-0e1b9dcbeca1' + totalAmount: 25 + currency: GBP + type: Payment + transactionSourceRef: + id: 09b94cfc-2d98-11eb-8021-0e1b9dcbeca1 + type: Unknown + createdDate: '2020-11-23T14:27:38Z' + modifiedDate: '2021-10-27T15:23:04Z' + sourceModifiedDate: '2020-11-25T23:10:01Z' + - id: 'PAYMENT:226580d6-2d98-11eb-a35c-fed5e63de507' + totalAmount: 58.5 + currency: GBP + type: Payment + transactionSourceRef: + id: 226580d6-2d98-11eb-a35c-fed5e63de507 + type: Unknown + createdDate: '2020-11-23T14:28:20Z' + modifiedDate: '2021-10-27T15:23:04Z' + sourceModifiedDate: '2020-11-25T23:10:02Z' + pageNumber: 1 + pageSize: 2 + totalResults: 16 + _links: + current: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-transactions + next: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-transactions?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/lending-api#/schemas/Transaction) for a given company's connection. + + [Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) detail all financial affairs recorded in the commerce or point of sale system. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + '/companies/{companyId}/connections/{connectionId}/data/commerce-transactions/{transactionId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: transactionId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a transaction. + get: + summary: Get transaction + tags: + - Sales + operationId: get-commerce-transaction + x-speakeasy-group: sales.transactions + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceTransaction' + examples: + Mollie: + value: + id: re_Azhe8TzfUK + totalAmount: -20 + currency: EUR + type: Refund + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-03-17T15:47:28Z' + Mollie Test: + value: + id: re_Azhe8TzfUK + totalAmount: -20 + currency: EUR + type: Refund + subType: PaymentRefund + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-08-17T11:33:19Z' + Shopify: + value: + id: ShopifyPayment-1633176289438 + totalAmount: 175 + currency: GBP + type: Payment + subType: charge + transactionSourceRef: + id: '3684116791454' + type: Order + createdDate: '2021-03-19T13:16:26' + modifiedDate: '2023-02-10T15:18:23Z' + sourceModifiedDate: '2021-03-19T13:16:26' + Stripe Test: + value: + id: txn_1HpGQUA8m8S1Gh7OR21pB0Yj + totalAmount: 50 + currency: GBP + type: Payment + subType: charge + transactionSourceRef: + id: ch_1HpGQUA8m8S1Gh7Ot4WDTus5 + type: Payment + createdDate: '2020-11-19T16:56:06Z' + modifiedDate: '2022-09-30T11:18:28Z' + SumUp: + value: + id: 46d36a64-ea48-4e37-9340-3548cbf3ca2f + totalAmount: 15 + currency: GBP + type: Payment + subType: PAYMENT + createdDate: '2021-03-26T21:09:59Z' + modifiedDate: '2022-09-14T10:58:03Z' + Zettle: + value: + id: 'PAYMENT:09b94cfc-2d98-11eb-8021-0e1b9dcbeca1' + totalAmount: 25 + currency: GBP + type: Payment + transactionSourceRef: + id: 09b94cfc-2d98-11eb-8021-0e1b9dcbeca1 + type: Unknown + createdDate: '2020-11-23T14:27:38Z' + modifiedDate: '2021-10-27T15:23:04Z' + sourceModifiedDate: '2020-11-25T23:10:01Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get transaction* endpoint returns a single transaction for a given transactionId. + + [Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) detail all financial affairs recorded in the commerce or point of sale system. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/files': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - File upload + summary: List all files uploaded by a company + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Files' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "\uFEFFThe *List files* endpoint returns a list of all files uploaded to Codat by the SMB. " + operationId: list-files + x-speakeasy-name-override: list-uploaded + '/companies/{companyId}/files/download': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - File upload + summary: Download all files for a company + parameters: + - name: date + in: query + schema: + $ref: '#/components/schemas/DateTime' + description: Only download files uploaded on this date. + responses: + '200': + description: Success + content: + application/octet-stream: + x-speakeasy-usage-example: true + schema: + title: Data + type: string + format: binary + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: The *Download files* endpoint downloads all files that have been uploaded by to SMB to Codat. A `date` may be specified to download any files uploaded on the date provided. + operationId: download-files + x-speakeasy-name-override: download + '/companies/{companyId}/connections/{connectionId}/files': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - File upload + summary: Upload files for a company + responses: + '200': + description: Success + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/FileUpload' + description: |- + The *Upload files* endpoint uploads multiple files provided by the SMB to Codat. This may include personal identity documents, pitch decks, contracts, or files with accounting and banking data. + + Uploaded files must meet the following requirements: + + - Up to 20 files can be uploaded at a time. + - PDF, XLS, XLSX, XLSB, CSV, DOC, DOCX, PPT, PPTX, JPEG, JPG, and PNG files can be uploaded. + - Each file can be up to 10MB in size. + operationId: upload-files + x-speakeasy-name-override: upload + '/companies/{companyId}/connections/{connectionId}/options/bankAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create/update bank account model + tags: + - Loan writeback + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + Dynamics 365 Business Central: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + validation: + warnings: [] + information: + - field: AccountName + details: 'Needs to be of the format ''{No.}-{Name}''' + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: false + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: Bank Account Posting Group with Nominal Account must exist + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: [] + information: + - field: SortCode + details: Must have a length between 0 and 20 characters + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: false + overdraftLimit: + type: Number + displayName: Overdraft Limit + description: The pre-arranged overdraft limit of the account + required: false + validation: + warnings: [] + information: + - field: OverdraftLimit + details: Default value is 0 + required: true + Exact (Netherlands): + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: true + validation: + warnings: + - field: AccountNumber + details: Should not exceed the maximum length of 14 characters if the specified currency is GBP. + information: [] + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: + - field: SortCode + details: Must be 6 characters long if the specified currency is GBP. + - field: SortCode + details: Must be provided if the specified currency is GBP. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: false + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + required: true + Exact (UK): + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: true + validation: + warnings: + - field: AccountNumber + details: Should not exceed the maximum length of 14 characters if the specified currency is GBP. + information: [] + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: + - field: SortCode + details: Must be 6 characters long if the specified currency is GBP. + - field: SortCode + details: Must be provided if the specified currency is GBP. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: false + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + required: true + FreeAgent: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: + - field: SortCode + details: Must have a length between 0 and 8 characters + information: [] + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: false + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: false + currency: + type: String + displayName: Currency + description: The currency of the bank account + options: + - value: AED + type: String + displayName: AED + required: false + - value: AMD + type: String + displayName: AMD + required: false + - value: AOA + type: String + displayName: AOA + required: false + - value: ARS + type: String + displayName: ARS + required: false + - value: AUD + type: String + displayName: AUD + required: false + - value: AWG + type: String + displayName: AWG + required: false + - value: AZN + type: String + displayName: AZN + required: false + - value: BBD + type: String + displayName: BBD + required: false + - value: BDT + type: String + displayName: BDT + required: false + - value: BGN + type: String + displayName: BGN + required: false + - value: BRL + type: String + displayName: BRL + required: false + - value: BWP + type: String + displayName: BWP + required: false + - value: CAD + type: String + displayName: CAD + required: false + - value: CHF + type: String + displayName: CHF + required: false + - value: CLP + type: String + displayName: CLP + required: false + - value: CNY + type: String + displayName: CNY + required: false + - value: COP + type: String + displayName: COP + required: false + - value: CRC + type: String + displayName: CRC + required: false + - value: CUC + type: String + displayName: CUC + required: false + - value: CUP + type: String + displayName: CUP + required: false + - value: CZK + type: String + displayName: CZK + required: false + - value: DKK + type: String + displayName: DKK + required: false + - value: DOP + type: String + displayName: DOP + required: false + - value: EGP + type: String + displayName: EGP + required: false + - value: EUR + type: String + displayName: EUR + required: false + - value: FJD + type: String + displayName: FJD + required: false + - value: GBP + type: String + displayName: GBP + required: false + - value: GEL + type: String + displayName: GEL + required: false + - value: GHS + type: String + displayName: GHS + required: false + - value: GTQ + type: String + displayName: GTQ + required: false + - value: GYD + type: String + displayName: GYD + required: false + - value: HKD + type: String + displayName: HKD + required: false + - value: HNL + type: String + displayName: HNL + required: false + - value: HRK + type: String + displayName: HRK + required: false + - value: HUF + type: String + displayName: HUF + required: false + - value: IDR + type: String + displayName: IDR + required: false + - value: ILS + type: String + displayName: ILS + required: false + - value: INR + type: String + displayName: INR + required: false + - value: ISK + type: String + displayName: ISK + required: false + - value: JMD + type: String + displayName: JMD + required: false + - value: JPY + type: String + displayName: JPY + required: false + - value: KES + type: String + displayName: KES + required: false + - value: KRW + type: String + displayName: KRW + required: false + - value: KWD + type: String + displayName: KWD + required: false + - value: KYD + type: String + displayName: KYD + required: false + - value: KZT + type: String + displayName: KZT + required: false + - value: LAK + type: String + displayName: LAK + required: false + - value: LBP + type: String + displayName: LBP + required: false + - value: LKR + type: String + displayName: LKR + required: false + - value: LTL + type: String + displayName: LTL + required: false + - value: LVL + type: String + displayName: LVL + required: false + - value: MAD + type: String + displayName: MAD + required: false + - value: MDL + type: String + displayName: MDL + required: false + - value: MGA + type: String + displayName: MGA + required: false + - value: MUR + type: String + displayName: MUR + required: false + - value: MVR + type: String + displayName: MVR + required: false + - value: MWK + type: String + displayName: MWK + required: false + - value: MXN + type: String + displayName: MXN + required: false + - value: MYR + type: String + displayName: MYR + required: false + - value: MZN + type: String + displayName: MZN + required: false + - value: NAD + type: String + displayName: NAD + required: false + - value: NGN + type: String + displayName: NGN + required: false + - value: NOK + type: String + displayName: NOK + required: false + - value: NPR + type: String + displayName: NPR + required: false + - value: NZD + type: String + displayName: NZD + required: false + - value: OMR + type: String + displayName: OMR + required: false + - value: PEN + type: String + displayName: PEN + required: false + - value: PHP + type: String + displayName: PHP + required: false + - value: PKR + type: String + displayName: PKR + required: false + - value: PLN + type: String + displayName: PLN + required: false + - value: QAR + type: String + displayName: QAR + required: false + - value: RON + type: String + displayName: RON + required: false + - value: RSD + type: String + displayName: RSD + required: false + - value: RUB + type: String + displayName: RUB + required: false + - value: RWF + type: String + displayName: RWF + required: false + - value: SAR + type: String + displayName: SAR + required: false + - value: SCR + type: String + displayName: SCR + required: false + - value: SEK + type: String + displayName: SEK + required: false + - value: SGD + type: String + displayName: SGD + required: false + - value: THB + type: String + displayName: THB + required: false + - value: TND + type: String + displayName: TND + required: false + - value: TRY + type: String + displayName: TRY + required: false + - value: TTD + type: String + displayName: TTD + required: false + - value: TWD + type: String + displayName: TWD + required: false + - value: TZS + type: String + displayName: TZS + required: false + - value: UAH + type: String + displayName: UAH + required: false + - value: UGX + type: String + displayName: UGX + required: false + - value: USD + type: String + displayName: USD + required: false + - value: UYU + type: String + displayName: UYU + required: false + - value: VEF + type: String + displayName: VEF + required: false + - value: VND + type: String + displayName: VND + required: false + - value: VUV + type: String + displayName: VUV + required: false + - value: XAF + type: String + displayName: XAF + required: false + - value: XCD + type: String + displayName: XCD + required: false + - value: XOF + type: String + displayName: XOF + required: false + - value: ZAR + type: String + displayName: ZAR + required: false + - value: ZMK + type: String + displayName: ZMK + required: false + required: true + balance: + type: Number + displayName: Balance + description: The balance of the bank account + required: false + validation: + warnings: [] + information: + - field: Balance + details: 'The opening balance, in the account currency' + institution: + type: String + displayName: Institution + description: The institution of the bank account + required: false + required: true + KashFlow: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Account Name + description: Name of the bank account as it appears in Kashflow. + required: true + balance: + type: Number + displayName: Balance + description: 'The opening balance, in the account currency.' + required: false + currency: + type: String + displayName: Currency + description: The currency of the bank account. + required: true + required: true + QuickBooks Desktop: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: Max length of 7 characters. + information: [] + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + validation: + warnings: + - field: AccountName + details: Max length of 31 characters. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: false + validation: + warnings: + - field: Currency + details: 'The currency must match the base currency of the QuickBooks Desktop company unless the FullyQualifiedCategory is ''Asset.AccountsReceivable'',''Liability.AccountsPayable'' or ''Liability.CreditCard''' + - field: Currency + details: Must be a three letter ISO code that matches an existing active currency in the QuickBooks Desktop company + - field: Currency + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + information: + - field: Currency + details: 'If not set, will default to the base currency of the QuickBooks Desktop company' + balance: + type: Number + displayName: Balance + description: The balance of the bank account + required: false + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Account Name + description: Name of account as it appears in the chart of accounts or general ledger. + required: true + accountNumber: + type: String + displayName: Account Number + description: User-defined account number to help the user in identifying the account within the chart-of-accounts and in deciding what should be posted to the account. + required: true + currency: + type: String + displayName: Currency + description: Currency of the bank account. + required: true + required: true + Sage Business Cloud Accounting: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + validation: + warnings: [] + information: + - field: AccountName + details: Must be provided. + - field: AccountName + details: Should not be longer than 50 characters. + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: true + validation: + warnings: [] + information: + - field: Currency + details: Must be provided. + - field: Currency + details: Must match the company's base currency. + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: [] + information: + - field: SortCode + details: Should be a 6 digit number. + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: false + validation: + warnings: [] + information: + - field: AccountNumber + details: Should not be longer than 25 characters. + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: false + validation: + warnings: [] + information: + - field: IBan + details: Should be in the international bank account number format. + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: Should be a number between 1 and 99999999. + required: true + Sandbox: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + accountType: + type: String + displayName: Account Type + description: The type of account + required: true + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: true + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: true + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: true + balance: + type: Number + displayName: Balance + description: The balance of the bank account + required: true + availableBalance: + type: Number + displayName: Available Balance + description: The available balance of the bank account + required: true + overdraftLimit: + type: Number + displayName: Overdraft Limit + description: The pre-arranged overdraft limit of the account + required: true + institution: + type: String + displayName: Institution + description: The institution of the bank account + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-update-bankAccounts-model + x-speakeasy-group: loan-writeback.bank-accounts + 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/lending-api#/schemas/BankAccount) for a given company and integration.\r\n\r\n[Bank accounts](https://docs.codat.io/lending-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': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + summary: Create bank account + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBankAccount' + examples: {} + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateBankAccountResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *Create bank account* endpoint creates a new [bank account](https://docs.codat.io/lending-api#/schemas/BankAccount) for a given company's connection.\r\n\r\n[Bank accounts](https://docs.codat.io/lending-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/lending-api#/operations/get-create-update-bankAccounts-model)." + operationId: create-bank-account + x-speakeasy-group: loan-writeback.bank-accounts + '/companies/{companyId}/connections/{connectionId}/options/chartOfAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create account model + tags: + - Loan writeback + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + Exact (Netherlands): + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: [] + information: + - field: NominalCode + details: Must be provided. + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: [] + information: + - field: Name + details: Must be provided. + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Assets.Cash + type: String + displayName: Asset.Assets.Cash + required: false + - value: Asset.Assets.Bank + type: String + displayName: Asset.Assets.Bank + required: false + - value: Asset.Assets.PaymentServices + type: String + displayName: Asset.Assets.PaymentServices + required: false + - value: Asset.Assets.AccountsReceivable + type: String + displayName: Asset.Assets.AccountsReceivable + required: false + - value: Liability.EquityAndLiabilities.AccountsPayable + type: String + displayName: Liability.EquityAndLiabilities.AccountsPayable + required: false + - value: Asset.Assets.VAT + type: String + displayName: Asset.Assets.VAT + required: false + - value: Liability.EquityAndLiabilities.EmployeesPayable + type: String + displayName: Liability.EquityAndLiabilities.EmployeesPayable + required: false + - value: Asset.Assets.PrepaidExpenses + type: String + displayName: Asset.Assets.PrepaidExpenses + required: false + - value: Liability.EquityAndLiabilities.AccruedExpenses + type: String + displayName: Liability.EquityAndLiabilities.AccruedExpenses + required: false + - value: Liability.EquityAndLiabilities.IncomeTaxesPayable + type: String + displayName: Liability.EquityAndLiabilities.IncomeTaxesPayable + required: false + - value: Asset.Assets.FixedAssets + type: String + displayName: Asset.Assets.FixedAssets + required: false + - value: Asset.Assets.OtherAssets + type: String + displayName: Asset.Assets.OtherAssets + required: false + - value: Asset.Assets.AccumulatedDeprecation + type: String + displayName: Asset.Assets.AccumulatedDeprecation + required: false + - value: Asset.Assets.Inventory + type: String + displayName: Asset.Assets.Inventory + required: false + - value: Equity.EquityAndLiabilities.CapitalStock + type: String + displayName: Equity.EquityAndLiabilities.CapitalStock + required: false + - value: Equity.EquityAndLiabilities.RetainedEarnings + type: String + displayName: Equity.EquityAndLiabilities.RetainedEarnings + required: false + - value: Liability.EquityAndLiabilities.LongTermDebt + type: String + displayName: Liability.EquityAndLiabilities.LongTermDebt + required: false + - value: Liability.EquityAndLiabilities.CurrentPortionOfDebt + type: String + displayName: Liability.EquityAndLiabilities.CurrentPortionOfDebt + required: false + - value: Unknown.EquityAndLiabilities.Intercompany + type: String + displayName: Unknown.EquityAndLiabilities.Intercompany + required: false + - value: Unknown.General.General + type: String + displayName: Unknown.General.General + required: false + - value: Income.NetIncome.Revenue + type: String + displayName: Income.NetIncome.Revenue + required: false + - value: Expense.NetIncome.CostOfGoods + type: String + displayName: Expense.NetIncome.CostOfGoods + required: false + - value: Expense.NetIncome.OtherCosts + type: String + displayName: Expense.NetIncome.OtherCosts + required: false + - value: Expense.NetIncome.SalesGeneralAdministrativeExpenses + type: String + displayName: Expense.NetIncome.SalesGeneralAdministrativeExpenses + required: false + - value: Expense.NetIncome.DeprecationCosts + type: String + displayName: Expense.NetIncome.DeprecationCosts + required: false + - value: Expense.NetIncome.ResearchAndDevelopment + type: String + displayName: Expense.NetIncome.ResearchAndDevelopment + required: false + - value: Expense.NetIncome.EmployeeCosts + type: String + displayName: Expense.NetIncome.EmployeeCosts + required: false + - value: Expense.NetIncome.EmploymentCosts + type: String + displayName: Expense.NetIncome.EmploymentCosts + required: false + - value: Expense.ExceptionalIncome.ExceptionalCosts + type: String + displayName: Expense.ExceptionalIncome.ExceptionalCosts + required: false + - value: Income.ExceptionalIncome.ExceptionalIncome + type: String + displayName: Income.ExceptionalIncome.ExceptionalIncome + required: false + - value: Expense.ExceptionalIncome.IncomeTaxes + type: String + displayName: Expense.ExceptionalIncome.IncomeTaxes + required: false + - value: Income.ExceptionalIncome.InterestIncome + type: String + displayName: Income.ExceptionalIncome.InterestIncome + required: false + required: true + validation: + warnings: [] + information: + - field: FullyQualifiedCategory + details: Must be provided. + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Pending + type: String + displayName: Pending + required: false + - value: Unknown + type: String + displayName: Unknown + required: false + required: true + validation: + warnings: [] + information: + - field: Status + details: Must be provided. + required: true + Exact (UK): + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: [] + information: + - field: NominalCode + details: Must be provided. + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: [] + information: + - field: Name + details: Must be provided. + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Assets.Cash + type: String + displayName: Asset.Assets.Cash + required: false + - value: Asset.Assets.Bank + type: String + displayName: Asset.Assets.Bank + required: false + - value: Asset.Assets.PaymentServices + type: String + displayName: Asset.Assets.PaymentServices + required: false + - value: Asset.Assets.AccountsReceivable + type: String + displayName: Asset.Assets.AccountsReceivable + required: false + - value: Liability.EquityAndLiabilities.AccountsPayable + type: String + displayName: Liability.EquityAndLiabilities.AccountsPayable + required: false + - value: Asset.Assets.VAT + type: String + displayName: Asset.Assets.VAT + required: false + - value: Liability.EquityAndLiabilities.EmployeesPayable + type: String + displayName: Liability.EquityAndLiabilities.EmployeesPayable + required: false + - value: Asset.Assets.PrepaidExpenses + type: String + displayName: Asset.Assets.PrepaidExpenses + required: false + - value: Liability.EquityAndLiabilities.AccruedExpenses + type: String + displayName: Liability.EquityAndLiabilities.AccruedExpenses + required: false + - value: Liability.EquityAndLiabilities.IncomeTaxesPayable + type: String + displayName: Liability.EquityAndLiabilities.IncomeTaxesPayable + required: false + - value: Asset.Assets.FixedAssets + type: String + displayName: Asset.Assets.FixedAssets + required: false + - value: Asset.Assets.OtherAssets + type: String + displayName: Asset.Assets.OtherAssets + required: false + - value: Asset.Assets.AccumulatedDeprecation + type: String + displayName: Asset.Assets.AccumulatedDeprecation + required: false + - value: Asset.Assets.Inventory + type: String + displayName: Asset.Assets.Inventory + required: false + - value: Equity.EquityAndLiabilities.CapitalStock + type: String + displayName: Equity.EquityAndLiabilities.CapitalStock + required: false + - value: Equity.EquityAndLiabilities.RetainedEarnings + type: String + displayName: Equity.EquityAndLiabilities.RetainedEarnings + required: false + - value: Liability.EquityAndLiabilities.LongTermDebt + type: String + displayName: Liability.EquityAndLiabilities.LongTermDebt + required: false + - value: Liability.EquityAndLiabilities.CurrentPortionOfDebt + type: String + displayName: Liability.EquityAndLiabilities.CurrentPortionOfDebt + required: false + - value: Unknown.EquityAndLiabilities.Intercompany + type: String + displayName: Unknown.EquityAndLiabilities.Intercompany + required: false + - value: Unknown.General.General + type: String + displayName: Unknown.General.General + required: false + - value: Income.NetIncome.Revenue + type: String + displayName: Income.NetIncome.Revenue + required: false + - value: Expense.NetIncome.CostOfGoods + type: String + displayName: Expense.NetIncome.CostOfGoods + required: false + - value: Expense.NetIncome.OtherCosts + type: String + displayName: Expense.NetIncome.OtherCosts + required: false + - value: Expense.NetIncome.SalesGeneralAdministrativeExpenses + type: String + displayName: Expense.NetIncome.SalesGeneralAdministrativeExpenses + required: false + - value: Expense.NetIncome.DeprecationCosts + type: String + displayName: Expense.NetIncome.DeprecationCosts + required: false + - value: Expense.NetIncome.ResearchAndDevelopment + type: String + displayName: Expense.NetIncome.ResearchAndDevelopment + required: false + - value: Expense.NetIncome.EmployeeCosts + type: String + displayName: Expense.NetIncome.EmployeeCosts + required: false + - value: Expense.NetIncome.EmploymentCosts + type: String + displayName: Expense.NetIncome.EmploymentCosts + required: false + - value: Expense.ExceptionalIncome.ExceptionalCosts + type: String + displayName: Expense.ExceptionalIncome.ExceptionalCosts + required: false + - value: Income.ExceptionalIncome.ExceptionalIncome + type: String + displayName: Income.ExceptionalIncome.ExceptionalIncome + required: false + - value: Expense.ExceptionalIncome.IncomeTaxes + type: String + displayName: Expense.ExceptionalIncome.IncomeTaxes + required: false + - value: Income.ExceptionalIncome.InterestIncome + type: String + displayName: Income.ExceptionalIncome.InterestIncome + required: false + required: true + validation: + warnings: [] + information: + - field: FullyQualifiedCategory + details: Must be provided. + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Pending + type: String + displayName: Pending + required: false + - value: Unknown + type: String + displayName: Unknown + required: false + required: true + validation: + warnings: [] + information: + - field: Status + details: Must be provided. + required: true + MYOB AccountRight and Essentials: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: 'If alphanumeric is supported, must be between 1 and 10 characters. Otherwise format is x-xxxx' + information: [] + name: + type: String + displayName: Name + description: Name of the account + required: false + validation: + warnings: + - field: Name + details: Must have a length between 1 and 60 characters + information: [] + description: + type: String + displayName: Description + description: Description of the account + required: false + validation: + warnings: + - field: Description + details: Must have a length between 1 and 255 characters + information: [] + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Bank + type: String + displayName: Bank + required: false + - value: Asset.AccountReceivable + type: String + displayName: Accounts Receivable + required: false + - value: Asset.OtherCurrentAsset + type: String + displayName: Other Current Asset + required: false + - value: Asset.FixedAsset + type: String + displayName: Fixed Asset + required: false + - value: Asset.OtherAsset + type: String + displayName: Other Asset + required: false + - value: Asset.CashAndBank + type: String + displayName: Cash + required: false + - value: Asset.Property Plant and Equipment + type: String + displayName: Equipment Machinery + required: false + - value: Liability.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.OtherCurrentLiability + type: String + displayName: Other Current Liability + required: false + - value: Liability.LongTermLiability + type: String + displayName: Long Term Liability + required: false + - value: Liability.OtherLiability + type: String + displayName: Other Liability + required: false + - value: Equity + type: String + displayName: Equity + required: false + - value: Equity.Equity + type: String + displayName: Retained Earnings + required: false + - value: Equity.Equity.RetainedEarnings + type: String + displayName: Retained Earnings + required: false + - value: Equity.Owner's Equity + type: String + displayName: Retained Earnings + required: false + - value: Income + type: String + displayName: Income + required: false + - value: OtherIncome + type: String + displayName: Other Income + required: false + - value: Expense + type: String + displayName: Expense + required: false + - value: Expense.Expense + type: String + displayName: Sales Marketing + required: false + - value: Expense.Expense.Insurance + type: String + displayName: General Administrative + required: false + - value: Expense.Overhead + type: String + displayName: General Administrative + required: false + - value: Expense.Expense.RepairMaintenance + type: String + displayName: Repairs Maintenance + required: false + - value: OtherExpense + type: String + displayName: Other Expense + required: false + - value: CostOfSales + type: String + displayName: Cost of Sales + required: false + - value: Cost Of Goods Sold.Cost of Sales + type: String + displayName: Other + required: false + required: true + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + required: true + QuickBooks Desktop: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: Max length of 7 characters. + information: [] + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: + - field: Name + details: Max length of 31 characters. + information: [] + description: + type: String + displayName: Description + description: Description of the account + required: false + validation: + warnings: + - field: Description + details: Max length of 200 characters. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the account + required: false + validation: + warnings: + - field: Currency + details: 'The currency must match the base currency of the QuickBooks Desktop company unless the FullyQualifiedCategory is ''Asset.AccountsReceivable'',''Liability.AccountsPayable'' or ''Liability.CreditCard''' + - field: Currency + details: Must be a three letter ISO code that matches an existing active currency in the QuickBooks Desktop company + - field: Currency + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + information: + - field: Currency + details: 'If not set, will default to the base currency of the QuickBooks Desktop company' + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.AccountsReceivable + type: String + displayName: Account Receivable + required: false + - value: Asset.FixedAsset + type: String + displayName: Fixed Asset + required: false + - value: Asset.OtherCurrentAsset + type: String + displayName: Other Current Asset + required: false + - value: Asset.OtherAsset + type: String + displayName: Other Asset + required: false + - value: Income.Income + type: String + displayName: Income + required: false + - value: Income.OtherIncome + type: String + displayName: Other Income + required: false + - value: Liability.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.LongTermLiability + type: String + displayName: Long Term Liability + required: false + - value: Liability.OtherCurrentLiability + type: String + displayName: Other Current Liability + required: false + - value: Liability.CostOfGoodsSold + type: String + displayName: Cost Of Goods Sold + required: false + - value: Equity.Equity + type: String + displayName: Equity + required: false + - value: Expense.Expense + type: String + displayName: Expense + required: false + - value: Expense.OtherExpense + type: String + displayName: Other Expense + required: false + required: true + currentBalance: + type: Number + displayName: Current Balance + description: The current balance in the account + required: false + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: If included must have a length between 1 and 7 characters + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: + - field: Name + details: Must have a length between 1 and 100 characters + information: [] + currency: + type: String + displayName: Currency + description: The currency of the account + required: false + validation: + warnings: [] + information: + - field: Currency + details: When not specified company base currency will be used + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Bank.CashOnHand + type: String + displayName: Cash On Hand + required: false + - value: Asset.Bank.Checking + type: String + displayName: Checking + required: false + - value: Asset.Bank.MoneyMarket + type: String + displayName: Money Market + required: false + - value: Asset.Bank.RentsHeldInTrust + type: String + displayName: Rents Held In Trust + required: false + - value: Asset.Bank.Savings + type: String + displayName: Savings + required: false + - value: Asset.Bank.TrustAccounts + type: String + displayName: Trust Accounts + required: false + - value: Asset.Bank.CashAndCashEquivalents + type: String + displayName: Cash And Cash Equivalents + required: false + - value: Asset.Bank.OtherEarmarkedBankAccounts + type: String + displayName: Other Earmarked Bank Accounts + required: false + - value: Asset.Other Current Asset.AllowanceForBadDebts + type: String + displayName: Allowance For Bad Debts + required: false + - value: Asset.Other Current Asset.DevelopmentCosts + type: String + displayName: Development Costs + required: false + - value: Asset.Other Current Asset.EmployeeCashAdvances + type: String + displayName: Employee Cash Advances + required: false + - value: Asset.Other Current Asset.OtherCurrentAssets + type: String + displayName: Other Current Assets + required: false + - value: Asset.Other Current Asset.Inventory + type: String + displayName: Inventory + required: false + - value: Asset.Other Current Asset.Investment_MortgageRealEstateLoans + type: String + displayName: Investment Mortgage Real Estate Loans + required: false + - value: Asset.Other Current Asset.Investment_Other + type: String + displayName: Investment Other + required: false + - value: Asset.Other Current Asset.Investment_TaxExemptSecurities + type: String + displayName: Investment Tax Exempt Securities + required: false + - value: Asset.Other Current Asset.Investment_USGovernmentObligations + type: String + displayName: Investment US Government Obligations + required: false + - value: Asset.Other Current Asset.LoansToOfficers + type: String + displayName: Loans To Officers + required: false + - value: Asset.Other Current Asset.LoansToOthers + type: String + displayName: Loans To Others + required: false + - value: Asset.Other Current Asset.LoansToStockholders + type: String + displayName: Loans To Stockholders + required: false + - value: Asset.Other Current Asset.PrepaidExpenses + type: String + displayName: Prepaid Expenses + required: false + - value: Asset.Other Current Asset.Retainage + type: String + displayName: Retainage + required: false + - value: Asset.Other Current Asset.UndepositedFunds + type: String + displayName: Undeposited Funds + required: false + - value: Asset.Other Current Asset.AssetsAvailableForSale + type: String + displayName: Assets Available For Sale + required: false + - value: Asset.Other Current Asset.BalWithGovtAuthorities + type: String + displayName: Balance With Govt Authorities + required: false + - value: Asset.Other Current Asset.CalledUpShareCapitalNotPaid + type: String + displayName: Called Up Share Capital Not Paid + required: false + - value: Asset.Other Current Asset.ExpenditureAuthorisationsAndLettersOfCredit + type: String + displayName: Expenditure Authorisations And Letters Of Credit + required: false + - value: Asset.Other Current Asset.GlobalTaxDeferred + type: String + displayName: Global Tax Deferred + required: false + - value: Asset.Other Current Asset.GlobalTaxRefund + type: String + displayName: Global Tax Refund + required: false + - value: Asset.Other Current Asset.InternalTransfers + type: String + displayName: Internal Transfers + required: false + - value: Asset.Other Current Asset.OtherConsumables + type: String + displayName: Other Consumables + required: false + - value: Asset.Other Current Asset.ProvisionsCurrentAssets + type: String + displayName: Provisions Current Assets + required: false + - value: Asset.Other Current Asset.ShortTermInvestmentsInRelatedParties + type: String + displayName: Short Term Investments In Related Parties + required: false + - value: Asset.Other Current Asset.ShortTermLoansAndAdvancesToRelatedParties + type: String + displayName: Short Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Current Asset.TradeAndOtherReceivables + type: String + displayName: Trade And Other Receivables + required: false + - value: Asset.Fixed Asset.AccumulatedDepletion + type: String + displayName: Accumulated Depletion + required: false + - value: Asset.Fixed Asset.AccumulatedDepreciation + type: String + displayName: Accumulated Depreciation + required: false + - value: Asset.Fixed Asset.DepletableAssets + type: String + displayName: Depletable Assets + required: false + - value: Asset.Fixed Asset.FixedAssetComputers + type: String + displayName: Fixed Asset Computers + required: false + - value: Asset.Fixed Asset.FixedAssetCopiers + type: String + displayName: Fixed Asset Copiers + required: false + - value: Asset.Fixed Asset.FixedAssetFurniture + type: String + displayName: Fixed Asset Furniture + required: false + - value: Asset.Fixed Asset.FixedAssetPhone + type: String + displayName: Fixed Asset Phone + required: false + - value: Asset.Fixed Asset.FixedAssetPhotoVideo + type: String + displayName: Fixed Asset Photo Video + required: false + - value: Asset.Fixed Asset.FixedAssetSoftware + type: String + displayName: Fixed Asset Software + required: false + - value: Asset.Fixed Asset.FixedAssetOtherToolsEquipment + type: String + displayName: Fixed Asset Other Tools Equipment + required: false + - value: Asset.Fixed Asset.FurnitureAndFixtures + type: String + displayName: Furniture And Fixtures + required: false + - value: Asset.Fixed Asset.Land + type: String + displayName: Land + required: false + - value: Asset.Fixed Asset.LeaseholdImprovements + type: String + displayName: Leasehold Improvements + required: false + - value: Asset.Fixed Asset.OtherFixedAssets + type: String + displayName: Other Fixed Assets + required: false + - value: Asset.Fixed Asset.AccumulatedAmortization + type: String + displayName: Accumulated Amortization + required: false + - value: Asset.Fixed Asset.Buildings + type: String + displayName: Buildings + required: false + - value: Asset.Fixed Asset.IntangibleAssets + type: String + displayName: Intangible Assets + required: false + - value: Asset.Fixed Asset.MachineryAndEquipment + type: String + displayName: Machinery And Equipment + required: false + - value: Asset.Fixed Asset.Vehicles + type: String + displayName: Vehicles + required: false + - value: Asset.Fixed Asset.AssetsInCourseOfConstruction + type: String + displayName: Assets In Course Of Construction + required: false + - value: Asset.Fixed Asset.CapitalWip + type: String + displayName: Capital Wip + required: false + - value: Asset.Fixed Asset.CumulativeDepreciationOnIntangibleAssets + type: String + displayName: Cumulative Depreciation On Intangible Assets + required: false + - value: Asset.Fixed Asset.IntangibleAssetsUnderDevelopment + type: String + displayName: Intangible Assets Under Development + required: false + - value: Asset.Fixed Asset.LandAsset + type: String + displayName: Land Asset + required: false + - value: Asset.Fixed Asset.NonCurrentAssets + type: String + displayName: Non Current Assets + required: false + - value: Asset.Fixed Asset.ParticipatingInterests + type: String + displayName: Participating Interests + required: false + - value: Asset.Fixed Asset.ProvisionsFixedAssets + type: String + displayName: Provisions Fixed Assets + required: false + - value: Asset.Other Asset.LeaseBuyout + type: String + displayName: Lease Buyout + required: false + - value: Asset.Other Asset.OtherLongTermAssets + type: String + displayName: Other Long Term Assets + required: false + - value: Asset.Other Asset.SecurityDeposits + type: String + displayName: Security Deposits + required: false + - value: Asset.Other Asset.AccumulatedAmortizationOfOtherAssets + type: String + displayName: Accumulated Amortization Of Other Assets + required: false + - value: Asset.Other Asset.Goodwill + type: String + displayName: Goodwill + required: false + - value: Asset.Other Asset.Licenses + type: String + displayName: Licenses + required: false + - value: Asset.Other Asset.OrganizationalCosts + type: String + displayName: Organizational Costs + required: false + - value: Asset.Other Asset.AssetsHeldForSale + type: String + displayName: Assets Held For Sale + required: false + - value: Asset.Other Asset.AvailableForSaleFinancialAssets + type: String + displayName: Available For Sale Financial Assets + required: false + - value: Asset.Other Asset.DeferredTax + type: String + displayName: Deferred Tax + required: false + - value: Asset.Other Asset.Investments + type: String + displayName: Investments + required: false + - value: Asset.Other Asset.LongTermInvestments + type: String + displayName: Long Term Investments + required: false + - value: Asset.Other Asset.LongTermLoansAndAdvancesToRelatedParties + type: String + displayName: Long Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Asset.OtherIntangibleAssets + type: String + displayName: Other Intangible Assets + required: false + - value: Asset.Other Asset.OtherLongTermInvestments + type: String + displayName: Other Long Term Investments + required: false + - value: Asset.Other Asset.OtherLongTermLoansAndAdvances + type: String + displayName: Other Long Term Loans And Advances + required: false + - value: Asset.Other Asset.PrepaymentsAndAccruedIncome + type: String + displayName: Prepayments And Accrued Income + required: false + - value: Asset.Other Asset.ProvisionsNonCurrentAssets + type: String + displayName: Provisions Non-Current Assets + required: false + - value: Asset.Accounts Receivable.AccountsReceivable + type: String + displayName: Accounts Receivable + required: false + - value: Expense.Expense.AdvertisingPromotional + type: String + displayName: Advertising/Promotional + required: false + - value: Expense.Expense.BadDebts + type: String + displayName: Bad Debts + required: false + - value: Expense.Expense.BankCharges + type: String + displayName: Bank Charges + required: false + - value: Expense.Expense.CharitableContributions + type: String + displayName: Charitable Contributions + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.Entertainment + type: String + displayName: Entertainment + required: false + - value: Expense.Expense.EntertainmentMeals + type: String + displayName: Entertainment Meals + required: false + - value: Expense.Expense.EquipmentRental + type: String + displayName: Equipment Rental + required: false + - value: Expense.Expense.FinanceCosts + type: String + displayName: Finance Costs + required: false + - value: Expense.Expense.GlobalTaxExpense + type: String + displayName: Global Tax Expense + required: false + - value: Expense.Expense.Insurance + type: String + displayName: Insurance + required: false + - value: Expense.Expense.InterestPaid + type: String + displayName: Interest Paid + required: false + - value: Expense.Expense.LegalProfessionalFees + type: String + displayName: Legal And Professional Fees + required: false + - value: Expense.Expense.OfficeExpenses + type: String + displayName: Office Expenses + required: false + - value: Expense.Expense.OfficeGeneralAdministrativeExpenses + type: String + displayName: Office/General Administrative Expenses + required: false + - value: Expense.Expense.OtherBusinessExpenses + type: String + displayName: Other Business Expenses + required: false + - value: Expense.Expense.OtherMiscellaneousServiceCost + type: String + displayName: Other Miscellaneous Service Cost + required: false + - value: Expense.Expense.PromotionalMeals + type: String + displayName: Promotional Meals + required: false + - value: Expense.Expense.RentOrLeaseOfBuildings + type: String + displayName: Rent Or Lease Of Buildings + required: false + - value: Expense.Expense.RepairMaintenance + type: String + displayName: Repair And Maintenance + required: false + - value: Expense.Expense.ShippingFreightDelivery + type: String + displayName: 'Shipping, Freight And Delivery' + required: false + - value: Expense.Expense.SuppliesMaterials + type: String + displayName: Supplies And Materials + required: false + - value: Expense.Expense.Travel + type: String + displayName: Travel + required: false + - value: Expense.Expense.TravelMeals + type: String + displayName: Travel Meals + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.Auto + type: String + displayName: Auto + required: false + - value: Expense.Expense.CostOfLabor + type: String + displayName: Cost Of Labor + required: false + - value: Expense.Expense.DuesSubscriptions + type: String + displayName: Dues And Subscriptions + required: false + - value: Expense.Expense.PayrollExpenses + type: String + displayName: Payroll Expenses + required: false + - value: Expense.Expense.TaxesPaid + type: String + displayName: Taxes Paid + required: false + - value: Expense.Expense.UnappliedCashBillPaymentExpense + type: String + displayName: Unapplied Cash Bill Payment Expense + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.AmortizationExpense + type: String + displayName: Amortization Expense + required: false + - value: Expense.Expense.AppropriationsToDepreciation + type: String + displayName: Appropriations To Depreciation + required: false + - value: Expense.Expense.BorrowingCost + type: String + displayName: Borrowing Cost + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.DistributionCosts + type: String + displayName: Distribution Costs + required: false + - value: Expense.Expense.ExternalServices + type: String + displayName: External Services + required: false + - value: Expense.Expense.ExtraordinaryCharges + type: String + displayName: Extraordinary Charges + required: false + - value: Expense.Expense.IncomeTaxExpense + type: String + displayName: Income Tax Expense + required: false + - value: Expense.Expense.LossOnDiscontinuedOperationsNetOfTax + type: String + displayName: Loss On Discontinued Operations Net Of Tax + required: false + - value: Expense.Expense.ManagementCompensation + type: String + displayName: Management Compensation + required: false + - value: Expense.Expense.OtherCurrentOperatingCharges + type: String + displayName: Other Current Operating Charges + required: false + - value: Expense.Expense.OtherExternalServices + type: String + displayName: Other External Services + required: false + - value: Expense.Expense.OtherRentalCosts + type: String + displayName: Other Rental Costs + required: false + - value: Expense.Expense.OtherSellingExpenses + type: String + displayName: Other Selling Expenses + required: false + - value: Expense.Expense.ProjectStudiesSurveysAssessments + type: String + displayName: Project Studies Surveys Assessments + required: false + - value: Expense.Expense.PurchasesRebates + type: String + displayName: Purchases Rebates + required: false + - value: Expense.Expense.ShippingAndDeliveryExpense + type: String + displayName: Shipping And Delivery Expense + required: false + - value: Expense.Expense.StaffCosts + type: String + displayName: Staff Costs + required: false + - value: Expense.Expense.Sundry + type: String + displayName: Sundry + required: false + - value: Expense.Expense.TravelExpensesGeneralAndAdminExpenses + type: String + displayName: Travel Expenses General And Admin Expenses + required: false + - value: Expense.Expense.TravelExpensesSellingExpense + type: String + displayName: Travel Expenses Selling Expense + required: false + - value: Expense.Other Expense.Depreciation + type: String + displayName: Depreciation + required: false + - value: Expense.Other Expense.ExchangeGainOrLoss + type: String + displayName: Exchange Gain Or Loss + required: false + - value: Expense.Other Expense.OtherMiscellaneousExpense + type: String + displayName: Other Miscellaneous Expense + required: false + - value: Expense.Other Expense.PenaltiesSettlements + type: String + displayName: Penalties And Settlements + required: false + - value: Expense.Other Expense.Amortization + type: String + displayName: Amortization + required: false + - value: Expense.Other Expense.GasAndFuel + type: String + displayName: Gas And Fuel + required: false + - value: Expense.Other Expense.HomeOffice + type: String + displayName: Home Office + required: false + - value: Expense.Other Expense.HomeOwnerRentalInsurance + type: String + displayName: Home Owner Rental Insurance + required: false + - value: Expense.Other Expense.OtherHomeOfficeExpenses + type: String + displayName: Other Home Office Expenses + required: false + - value: Expense.Other Expense.MortgageInterest + type: String + displayName: Mortgage Interest + required: false + - value: Expense.Other Expense.RentAndLease + type: String + displayName: Rent And Lease + required: false + - value: Expense.Other Expense.RepairsAndMaintenance + type: String + displayName: Repairs And Maintenance + required: false + - value: Expense.Other Expense.ParkingAndTolls + type: String + displayName: Parking And Tolls + required: false + - value: Expense.Other Expense.Vehicle + type: String + displayName: Vehicle + required: false + - value: Expense.Other Expense.VehicleInsurance + type: String + displayName: Vehicle Insurance + required: false + - value: Expense.Other Expense.VehicleLease + type: String + displayName: Vehicle Lease + required: false + - value: Expense.Other Expense.VehicleLoanInterest + type: String + displayName: Vehicle Loan Interest + required: false + - value: Expense.Other Expense.VehicleLoan + type: String + displayName: Vehicle Loan + required: false + - value: Expense.Other Expense.VehicleRegistration + type: String + displayName: Vehicle Registration + required: false + - value: Expense.Other Expense.VehicleRepairs + type: String + displayName: Vehicle Repairs + required: false + - value: Expense.Other Expense.OtherVehicleExpenses + type: String + displayName: Other Vehicle Expenses + required: false + - value: Expense.Other Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Other Expense.WashAndRoadServices + type: String + displayName: Wash And Road Services + required: false + - value: Expense.Other Expense.DeferredTaxExpense + type: String + displayName: Deferred Tax Expense + required: false + - value: Expense.Other Expense.Depletion + type: String + displayName: Depletion + required: false + - value: Expense.Other Expense.ExceptionalItems + type: String + displayName: Exceptional Items + required: false + - value: Expense.Other Expense.ExtraordinaryItems + type: String + displayName: Extraordinary Items + required: false + - value: Expense.Other Expense.IncomeTaxOtherExpense + type: String + displayName: Income Tax Other Expense + required: false + - value: Expense.Other Expense.MatCredit + type: String + displayName: Mat Credit + required: false + - value: Expense.Other Expense.PriorPeriodItems + type: String + displayName: Prior Period Items + required: false + - value: Expense.Other Expense.TaxRoundoffGainOrLoss + type: String + displayName: Tax Roundoff Gain Or Loss + required: false + - value: Expense.Cost of Goods Sold.EquipmentRentalCos + type: String + displayName: Equipment Rental - COS + required: false + - value: Expense.Cost of Goods Sold.OtherCostsOfServiceCos + type: String + displayName: Other Costs Of Sales - COS + required: false + - value: Expense.Cost of Goods Sold.ShippingFreightDeliveryCos + type: String + displayName: 'Shipping, Freight And Delivery - COS' + required: false + - value: Expense.Cost of Goods Sold.SuppliesMaterialsCogs + type: String + displayName: Supplies And Materials - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfLaborCos + type: String + displayName: Cost Of Labor - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfSales + type: String + displayName: Cost Of Sales + required: false + - value: Expense.Cost of Goods Sold.FreightAndDeliveryCost + type: String + displayName: Freight And Delivery Cost + required: false + - value: Income.Income.NonProfitIncome + type: String + displayName: Non Profit Income + required: false + - value: Income.Income.OtherPrimaryIncome + type: String + displayName: Other Primary Income + required: false + - value: Income.Income.SalesOfProductIncome + type: String + displayName: Sales Of ProductIncome + required: false + - value: Income.Income.ServiceFeeIncome + type: String + displayName: Service Fee Income + required: false + - value: Income.Income.DiscountsRefundsGiven + type: String + displayName: Discounts Refunds Given + required: false + - value: Income.Income.UnappliedCashPaymentIncome + type: String + displayName: Unapplied Cash Payment Income + required: false + - value: Income.Income.CashReceiptIncome + type: String + displayName: Cash Receipt Income + required: false + - value: Income.Income.OperatingGrants + type: String + displayName: Operating Grants + required: false + - value: Income.Income.OtherCurrentOperatingIncome + type: String + displayName: Other Current Operating Income + required: false + - value: Income.Income.OwnWorkCapitalized + type: String + displayName: Own Work Capitalized + required: false + - value: Income.Income.RevenueGeneral + type: String + displayName: Revenue General + required: false + - value: Income.Income.SalesRetail + type: String + displayName: Sales Retail + required: false + - value: Income.Income.SalesWholesale + type: String + displayName: Sales Wholesale + required: false + - value: Income.Income.SavingsByTaxScheme + type: String + displayName: Savings By Tax Scheme + required: false + - value: Income.Other Income.DividendIncome + type: String + displayName: Dividend Income + required: false + - value: Income.Other Income.InterestEarned + type: String + displayName: Interest Earned + required: false + - value: Income.Other Income.OtherInvestmentIncome + type: String + displayName: Other Investment Income + required: false + - value: Income.Other Income.OtherMiscellaneousIncome + type: String + displayName: Other Miscellaneous Income + required: false + - value: Income.Other Income.TaxExemptInterest + type: String + displayName: Tax Exempt Interest + required: false + - value: Income.Other Income.GainLossOnSaleOfFixedAssets + type: String + displayName: Gain Loss On Sale Of Fixed Assets + required: false + - value: Income.Other Income.GainLossOnSaleOfInvestments + type: String + displayName: Gain Loss On Sale Of Investments + required: false + - value: Income.Other Income.LossOnDisposalOfAssets + type: String + displayName: Loss On Disposal Of Assets + required: false + - value: Income.Other Income.OtherOperatingIncome + type: String + displayName: Other Operating Income + required: false + - value: Income.Other Income.UnrealisedLossOnSecuritiesNetOfTax + type: String + displayName: Unrealised Loss On Securities Net Of Tax + required: false + - value: Liability.Accounts Payable.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.Accounts Payable.OutstandingDuesMicroSmallEnterprise + type: String + displayName: Outstanding Dues Micro Small Enterprise + required: false + - value: Liability.Accounts Payable.OutstandingDuesOtherThanMicroSmallEnterprise + type: String + displayName: Outstanding Dues Other Than Micro Small Enterprise + required: false + - value: Liability.Credit Card.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.Long Term Liability.NotesPayable + type: String + displayName: Notes Payable + required: false + - value: Liability.Long Term Liability.OtherLongTermLiabilities + type: String + displayName: Other Long Term Liabilities + required: false + - value: Liability.Long Term Liability.ShareholderNotesPayable + type: String + displayName: Shareholder Notes Payable + required: false + - value: Liability.Long Term Liability.AccrualsAndDeferredIncome + type: String + displayName: Accruals And Deferred Income + required: false + - value: Liability.Long Term Liability.AccruedLongLermLiabilities + type: String + displayName: Accrued Long Lerm Liabilities + required: false + - value: Liability.Long Term Liability.AccruedVacationPayable + type: String + displayName: Accrued Vacation Payable + required: false + - value: Liability.Long Term Liability.BankLoans + type: String + displayName: Bank Loans + required: false + - value: Liability.Long Term Liability.DebtsRelatedToParticipatingInterests + type: String + displayName: Debts Related To Participating Interests + required: false + - value: Liability.Long Term Liability.DeferredTaxLiabilities + type: String + displayName: Deferred Tax Liabilities + required: false + - value: Liability.Long Term Liability.GovernmentAndOtherPublicAuthorities + type: String + displayName: Government And Other Public Authorities + required: false + - value: Liability.Long Term Liability.GroupAndAssociates + type: String + displayName: Group And Associates + required: false + - value: Liability.Long Term Liability.LiabilitiesRelatedToAssetsHeldForSale + type: String + displayName: Liabilities Related To Assets Held For Sale + required: false + - value: Liability.Long Term Liability.LongTermBorrowings + type: String + displayName: Long Term Borrowings + required: false + - value: Liability.Long Term Liability.LongTermDebit + type: String + displayName: Long Term Debit + required: false + - value: Liability.Long Term Liability.LongTermEmployeeBenefitObligations + type: String + displayName: Long Term Employee Benefit Obligations + required: false + - value: Liability.Long Term Liability.ObligationsUnderFinanceLeases + type: String + displayName: Obligations Under Finance Leases + required: false + - value: Liability.Long Term Liability.OtherLongTermProvisions + type: String + displayName: Other Long Term Provisions + required: false + - value: Liability.Long Term Liability.ProvisionForLiabilities + type: String + displayName: Provision For Liabilities + required: false + - value: Liability.Long Term Liability.ProvisionsNonCurrentLiabilities + type: String + displayName: Provisions Non Current Liabilities + required: false + - value: Liability.Long Term Liability.StaffAndRelatedLongTermLiabilityAccounts + type: String + displayName: Staff And Related Long Term Liability Accounts + required: false + - value: Liability.Other Current Liability.DirectDepositPayable + type: String + displayName: Direct Deposit Payable + required: false + - value: Liability.Other Current Liability.LineOfCredit + type: String + displayName: Line Of Credit + required: false + - value: Liability.Other Current Liability.LoanPayable + type: String + displayName: Loan Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxPayable + type: String + displayName: Global Tax Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxSuspense + type: String + displayName: Global Tax Suspense + required: false + - value: Liability.Other Current Liability.OtherCurrentLiabilities + type: String + displayName: Other Current Liabilities + required: false + - value: Liability.Other Current Liability.PayrollClearing + type: String + displayName: Payroll Clearing + required: false + - value: Liability.Other Current Liability.PayrollTaxPayable + type: String + displayName: Payroll Tax Payable + required: false + - value: Liability.Other Current Liability.PrepaidExpensesPayable + type: String + displayName: Prepaid Expenses Payable + required: false + - value: Liability.Other Current Liability.RentsInTrustLiability + type: String + displayName: Rents In Trust Liability + required: false + - value: Liability.Other Current Liability.TrustAccountsLiabilities + type: String + displayName: Trust Accounts Liabilities + required: false + - value: Liability.Other Current Liability.FederalIncomeTaxPayable + type: String + displayName: Federal Income Tax Payable + required: false + - value: Liability.Other Current Liability.InsurancePayable + type: String + displayName: Insurance Payable + required: false + - value: Liability.Other Current Liability.SalesTaxPayable + type: String + displayName: Sales Tax Payable + required: false + - value: Liability.Other Current Liability.StateLocalIncomeTaxPayable + type: String + displayName: State Local Income Tax Payable + required: false + - value: Liability.Other Current Liability.AccruedLiabilities + type: String + displayName: Accrued Liabilities + required: false + - value: Liability.Other Current Liability.CurrentLiabilities + type: String + displayName: Current Liabilities + required: false + - value: Liability.Other Current Liability.CurrentPortionEmployeeBenefitsObligations + type: String + displayName: Current Portion EmployeeBenefits Obligations + required: false + - value: Liability.Other Current Liability.CurrentPortionOfObligationsUnderFinanceLeases + type: String + displayName: Current Portion Of Obligations Under Finance Leases + required: false + - value: Liability.Other Current Liability.CurrentTaxLiability + type: String + displayName: Current Tax Liability + required: false + - value: Liability.Other Current Liability.DividendsPayable + type: String + displayName: Dividends Payable + required: false + - value: Liability.Other Current Liability.DutiesAndTaxes + type: String + displayName: Duties And Taxes + required: false + - value: Liability.Other Current Liability.InterestPayables + type: String + displayName: Interest Payables + required: false + - value: Liability.Other Current Liability.ProvisionForWarrantyObligations + type: String + displayName: Provision For Warranty Obligations + required: false + - value: Liability.Other Current Liability.ProvisionsCurrentLiabilities + type: String + displayName: Provisions Current Liabilities + required: false + - value: Liability.Other Current Liability.ShortTermBorrowings + type: String + displayName: Short Term Borrowings + required: false + - value: Liability.Other Current Liability.SocialSecurityAgencies + type: String + displayName: Social Security Agencies + required: false + - value: Liability.Other Current Liability.StaffAndRelatedLiabilityAccounts + type: String + displayName: Staff And Related Liability Accounts + required: false + - value: Liability.Other Current Liability.SundryDebtorsAndCreditors + type: String + displayName: Sundry Debtors And Creditors + required: false + - value: Liability.Other Current Liability.TradeAndOtherPayables + type: String + displayName: Trade And Other Payables + required: false + - value: Equity.Equity.OpeningBalanceEquity + type: String + displayName: Opening Balance Equity + required: false + - value: Equity.Equity.PartnersEquity + type: String + displayName: Partners Equity + required: false + - value: Equity.Equity.RetainedEarnings + type: String + displayName: Retained Earnings + required: false + - value: Equity.Equity.AccumulatedAdjustment + type: String + displayName: Accumulated Adjustment + required: false + - value: Equity.Equity.OwnersEquity + type: String + displayName: Owners Equity + required: false + - value: Equity.Equity.PaidInCapitalOrSurplus + type: String + displayName: Paid In Capital Or Surplus + required: false + - value: Equity.Equity.PartnerContributions + type: String + displayName: Partner Contributions + required: false + - value: Equity.Equity.PartnerDistributions + type: String + displayName: Partner Distributions + required: false + - value: Equity.Equity.PreferredStock + type: String + displayName: Preferred Stock + required: false + - value: Equity.Equity.CommonStock + type: String + displayName: Common Stock + required: false + - value: Equity.Equity.TreasuryStock + type: String + displayName: Treasury Stock + required: false + - value: Equity.Equity.EstimatedTaxes + type: String + displayName: Estimated Taxes + required: false + - value: Equity.Equity.Healthcare + type: String + displayName: Healthcare + required: false + - value: Equity.Equity.PersonalIncome + type: String + displayName: Personal Income + required: false + - value: Equity.Equity.PersonalExpense + type: String + displayName: Personal Expense + required: false + - value: Equity.Equity.AccumulatedOtherComprehensiveIncome + type: String + displayName: Accumulated Other Comprehensive Income + required: false + - value: Equity.Equity.CalledUpShareCapital + type: String + displayName: Called Up Share Capital + required: false + - value: Equity.Equity.CapitalReserves + type: String + displayName: Capital Reserves + required: false + - value: Equity.Equity.DividendDisbursed + type: String + displayName: Dividend Disbursed + required: false + - value: Equity.Equity.EquityInEarningsOfSubsiduaries + type: String + displayName: Equity In Earnings Of Subsiduaries + required: false + - value: Equity.Equity.InvestmentGrants + type: String + displayName: Investment Grants + required: false + - value: Equity.Equity.MoneyReceivedAgainstShareWarrants + type: String + displayName: Money Received Against Share Warrants + required: false + - value: Equity.Equity.OtherFreeReserves + type: String + displayName: Other Free Reserves + required: false + - value: Equity.Equity.ShareApplicationMoneyPendingAllotment + type: String + displayName: Share Application Money Pending Allotment + required: false + - value: Equity.Equity.ShareCapital + type: String + displayName: Share Capital + required: false + - value: Equity.Equity.Funds + type: String + displayName: Funds + required: false + required: true + required: true + QuickBooks Online: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: If included must have a length between 1 and 7 characters + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: + - field: Name + details: Must have a length between 1 and 100 characters + information: [] + currency: + type: String + displayName: Currency + description: The currency of the account + required: false + validation: + warnings: [] + information: + - field: Currency + details: When not specified company base currency will be used + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Bank.CashOnHand + type: String + displayName: Cash On Hand + required: false + - value: Asset.Bank.Checking + type: String + displayName: Checking + required: false + - value: Asset.Bank.MoneyMarket + type: String + displayName: Money Market + required: false + - value: Asset.Bank.RentsHeldInTrust + type: String + displayName: Rents Held In Trust + required: false + - value: Asset.Bank.Savings + type: String + displayName: Savings + required: false + - value: Asset.Bank.TrustAccounts + type: String + displayName: Trust Accounts + required: false + - value: Asset.Bank.CashAndCashEquivalents + type: String + displayName: Cash And Cash Equivalents + required: false + - value: Asset.Bank.OtherEarmarkedBankAccounts + type: String + displayName: Other Earmarked Bank Accounts + required: false + - value: Asset.Other Current Asset.AllowanceForBadDebts + type: String + displayName: Allowance For Bad Debts + required: false + - value: Asset.Other Current Asset.DevelopmentCosts + type: String + displayName: Development Costs + required: false + - value: Asset.Other Current Asset.EmployeeCashAdvances + type: String + displayName: Employee Cash Advances + required: false + - value: Asset.Other Current Asset.OtherCurrentAssets + type: String + displayName: Other Current Assets + required: false + - value: Asset.Other Current Asset.Inventory + type: String + displayName: Inventory + required: false + - value: Asset.Other Current Asset.Investment_MortgageRealEstateLoans + type: String + displayName: Investment Mortgage Real Estate Loans + required: false + - value: Asset.Other Current Asset.Investment_Other + type: String + displayName: Investment Other + required: false + - value: Asset.Other Current Asset.Investment_TaxExemptSecurities + type: String + displayName: Investment Tax Exempt Securities + required: false + - value: Asset.Other Current Asset.Investment_USGovernmentObligations + type: String + displayName: Investment US Government Obligations + required: false + - value: Asset.Other Current Asset.LoansToOfficers + type: String + displayName: Loans To Officers + required: false + - value: Asset.Other Current Asset.LoansToOthers + type: String + displayName: Loans To Others + required: false + - value: Asset.Other Current Asset.LoansToStockholders + type: String + displayName: Loans To Stockholders + required: false + - value: Asset.Other Current Asset.PrepaidExpenses + type: String + displayName: Prepaid Expenses + required: false + - value: Asset.Other Current Asset.Retainage + type: String + displayName: Retainage + required: false + - value: Asset.Other Current Asset.UndepositedFunds + type: String + displayName: Undeposited Funds + required: false + - value: Asset.Other Current Asset.AssetsAvailableForSale + type: String + displayName: Assets Available For Sale + required: false + - value: Asset.Other Current Asset.BalWithGovtAuthorities + type: String + displayName: Balance With Govt Authorities + required: false + - value: Asset.Other Current Asset.CalledUpShareCapitalNotPaid + type: String + displayName: Called Up Share Capital Not Paid + required: false + - value: Asset.Other Current Asset.ExpenditureAuthorisationsAndLettersOfCredit + type: String + displayName: Expenditure Authorisations And Letters Of Credit + required: false + - value: Asset.Other Current Asset.GlobalTaxDeferred + type: String + displayName: Global Tax Deferred + required: false + - value: Asset.Other Current Asset.GlobalTaxRefund + type: String + displayName: Global Tax Refund + required: false + - value: Asset.Other Current Asset.InternalTransfers + type: String + displayName: Internal Transfers + required: false + - value: Asset.Other Current Asset.OtherConsumables + type: String + displayName: Other Consumables + required: false + - value: Asset.Other Current Asset.ProvisionsCurrentAssets + type: String + displayName: Provisions Current Assets + required: false + - value: Asset.Other Current Asset.ShortTermInvestmentsInRelatedParties + type: String + displayName: Short Term Investments In Related Parties + required: false + - value: Asset.Other Current Asset.ShortTermLoansAndAdvancesToRelatedParties + type: String + displayName: Short Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Current Asset.TradeAndOtherReceivables + type: String + displayName: Trade And Other Receivables + required: false + - value: Asset.Fixed Asset.AccumulatedDepletion + type: String + displayName: Accumulated Depletion + required: false + - value: Asset.Fixed Asset.AccumulatedDepreciation + type: String + displayName: Accumulated Depreciation + required: false + - value: Asset.Fixed Asset.DepletableAssets + type: String + displayName: Depletable Assets + required: false + - value: Asset.Fixed Asset.FixedAssetComputers + type: String + displayName: Fixed Asset Computers + required: false + - value: Asset.Fixed Asset.FixedAssetCopiers + type: String + displayName: Fixed Asset Copiers + required: false + - value: Asset.Fixed Asset.FixedAssetFurniture + type: String + displayName: Fixed Asset Furniture + required: false + - value: Asset.Fixed Asset.FixedAssetPhone + type: String + displayName: Fixed Asset Phone + required: false + - value: Asset.Fixed Asset.FixedAssetPhotoVideo + type: String + displayName: Fixed Asset Photo Video + required: false + - value: Asset.Fixed Asset.FixedAssetSoftware + type: String + displayName: Fixed Asset Software + required: false + - value: Asset.Fixed Asset.FixedAssetOtherToolsEquipment + type: String + displayName: Fixed Asset Other Tools Equipment + required: false + - value: Asset.Fixed Asset.FurnitureAndFixtures + type: String + displayName: Furniture And Fixtures + required: false + - value: Asset.Fixed Asset.Land + type: String + displayName: Land + required: false + - value: Asset.Fixed Asset.LeaseholdImprovements + type: String + displayName: Leasehold Improvements + required: false + - value: Asset.Fixed Asset.OtherFixedAssets + type: String + displayName: Other Fixed Assets + required: false + - value: Asset.Fixed Asset.AccumulatedAmortization + type: String + displayName: Accumulated Amortization + required: false + - value: Asset.Fixed Asset.Buildings + type: String + displayName: Buildings + required: false + - value: Asset.Fixed Asset.IntangibleAssets + type: String + displayName: Intangible Assets + required: false + - value: Asset.Fixed Asset.MachineryAndEquipment + type: String + displayName: Machinery And Equipment + required: false + - value: Asset.Fixed Asset.Vehicles + type: String + displayName: Vehicles + required: false + - value: Asset.Fixed Asset.AssetsInCourseOfConstruction + type: String + displayName: Assets In Course Of Construction + required: false + - value: Asset.Fixed Asset.CapitalWip + type: String + displayName: Capital Wip + required: false + - value: Asset.Fixed Asset.CumulativeDepreciationOnIntangibleAssets + type: String + displayName: Cumulative Depreciation On Intangible Assets + required: false + - value: Asset.Fixed Asset.IntangibleAssetsUnderDevelopment + type: String + displayName: Intangible Assets Under Development + required: false + - value: Asset.Fixed Asset.LandAsset + type: String + displayName: Land Asset + required: false + - value: Asset.Fixed Asset.NonCurrentAssets + type: String + displayName: Non Current Assets + required: false + - value: Asset.Fixed Asset.ParticipatingInterests + type: String + displayName: Participating Interests + required: false + - value: Asset.Fixed Asset.ProvisionsFixedAssets + type: String + displayName: Provisions Fixed Assets + required: false + - value: Asset.Other Asset.LeaseBuyout + type: String + displayName: Lease Buyout + required: false + - value: Asset.Other Asset.OtherLongTermAssets + type: String + displayName: Other Long Term Assets + required: false + - value: Asset.Other Asset.SecurityDeposits + type: String + displayName: Security Deposits + required: false + - value: Asset.Other Asset.AccumulatedAmortizationOfOtherAssets + type: String + displayName: Accumulated Amortization Of Other Assets + required: false + - value: Asset.Other Asset.Goodwill + type: String + displayName: Goodwill + required: false + - value: Asset.Other Asset.Licenses + type: String + displayName: Licenses + required: false + - value: Asset.Other Asset.OrganizationalCosts + type: String + displayName: Organizational Costs + required: false + - value: Asset.Other Asset.AssetsHeldForSale + type: String + displayName: Assets Held For Sale + required: false + - value: Asset.Other Asset.AvailableForSaleFinancialAssets + type: String + displayName: Available For Sale Financial Assets + required: false + - value: Asset.Other Asset.DeferredTax + type: String + displayName: Deferred Tax + required: false + - value: Asset.Other Asset.Investments + type: String + displayName: Investments + required: false + - value: Asset.Other Asset.LongTermInvestments + type: String + displayName: Long Term Investments + required: false + - value: Asset.Other Asset.LongTermLoansAndAdvancesToRelatedParties + type: String + displayName: Long Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Asset.OtherIntangibleAssets + type: String + displayName: Other Intangible Assets + required: false + - value: Asset.Other Asset.OtherLongTermInvestments + type: String + displayName: Other Long Term Investments + required: false + - value: Asset.Other Asset.OtherLongTermLoansAndAdvances + type: String + displayName: Other Long Term Loans And Advances + required: false + - value: Asset.Other Asset.PrepaymentsAndAccruedIncome + type: String + displayName: Prepayments And Accrued Income + required: false + - value: Asset.Other Asset.ProvisionsNonCurrentAssets + type: String + displayName: Provisions Non-Current Assets + required: false + - value: Asset.Accounts Receivable.AccountsReceivable + type: String + displayName: Accounts Receivable + required: false + - value: Expense.Expense.AdvertisingPromotional + type: String + displayName: Advertising/Promotional + required: false + - value: Expense.Expense.BadDebts + type: String + displayName: Bad Debts + required: false + - value: Expense.Expense.BankCharges + type: String + displayName: Bank Charges + required: false + - value: Expense.Expense.CharitableContributions + type: String + displayName: Charitable Contributions + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.Entertainment + type: String + displayName: Entertainment + required: false + - value: Expense.Expense.EntertainmentMeals + type: String + displayName: Entertainment Meals + required: false + - value: Expense.Expense.EquipmentRental + type: String + displayName: Equipment Rental + required: false + - value: Expense.Expense.FinanceCosts + type: String + displayName: Finance Costs + required: false + - value: Expense.Expense.GlobalTaxExpense + type: String + displayName: Global Tax Expense + required: false + - value: Expense.Expense.Insurance + type: String + displayName: Insurance + required: false + - value: Expense.Expense.InterestPaid + type: String + displayName: Interest Paid + required: false + - value: Expense.Expense.LegalProfessionalFees + type: String + displayName: Legal And Professional Fees + required: false + - value: Expense.Expense.OfficeExpenses + type: String + displayName: Office Expenses + required: false + - value: Expense.Expense.OfficeGeneralAdministrativeExpenses + type: String + displayName: Office/General Administrative Expenses + required: false + - value: Expense.Expense.OtherBusinessExpenses + type: String + displayName: Other Business Expenses + required: false + - value: Expense.Expense.OtherMiscellaneousServiceCost + type: String + displayName: Other Miscellaneous Service Cost + required: false + - value: Expense.Expense.PromotionalMeals + type: String + displayName: Promotional Meals + required: false + - value: Expense.Expense.RentOrLeaseOfBuildings + type: String + displayName: Rent Or Lease Of Buildings + required: false + - value: Expense.Expense.RepairMaintenance + type: String + displayName: Repair And Maintenance + required: false + - value: Expense.Expense.ShippingFreightDelivery + type: String + displayName: 'Shipping, Freight And Delivery' + required: false + - value: Expense.Expense.SuppliesMaterials + type: String + displayName: Supplies And Materials + required: false + - value: Expense.Expense.Travel + type: String + displayName: Travel + required: false + - value: Expense.Expense.TravelMeals + type: String + displayName: Travel Meals + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.Auto + type: String + displayName: Auto + required: false + - value: Expense.Expense.CostOfLabor + type: String + displayName: Cost Of Labor + required: false + - value: Expense.Expense.DuesSubscriptions + type: String + displayName: Dues And Subscriptions + required: false + - value: Expense.Expense.PayrollExpenses + type: String + displayName: Payroll Expenses + required: false + - value: Expense.Expense.TaxesPaid + type: String + displayName: Taxes Paid + required: false + - value: Expense.Expense.UnappliedCashBillPaymentExpense + type: String + displayName: Unapplied Cash Bill Payment Expense + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.AmortizationExpense + type: String + displayName: Amortization Expense + required: false + - value: Expense.Expense.AppropriationsToDepreciation + type: String + displayName: Appropriations To Depreciation + required: false + - value: Expense.Expense.BorrowingCost + type: String + displayName: Borrowing Cost + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.DistributionCosts + type: String + displayName: Distribution Costs + required: false + - value: Expense.Expense.ExternalServices + type: String + displayName: External Services + required: false + - value: Expense.Expense.ExtraordinaryCharges + type: String + displayName: Extraordinary Charges + required: false + - value: Expense.Expense.IncomeTaxExpense + type: String + displayName: Income Tax Expense + required: false + - value: Expense.Expense.LossOnDiscontinuedOperationsNetOfTax + type: String + displayName: Loss On Discontinued Operations Net Of Tax + required: false + - value: Expense.Expense.ManagementCompensation + type: String + displayName: Management Compensation + required: false + - value: Expense.Expense.OtherCurrentOperatingCharges + type: String + displayName: Other Current Operating Charges + required: false + - value: Expense.Expense.OtherExternalServices + type: String + displayName: Other External Services + required: false + - value: Expense.Expense.OtherRentalCosts + type: String + displayName: Other Rental Costs + required: false + - value: Expense.Expense.OtherSellingExpenses + type: String + displayName: Other Selling Expenses + required: false + - value: Expense.Expense.ProjectStudiesSurveysAssessments + type: String + displayName: Project Studies Surveys Assessments + required: false + - value: Expense.Expense.PurchasesRebates + type: String + displayName: Purchases Rebates + required: false + - value: Expense.Expense.ShippingAndDeliveryExpense + type: String + displayName: Shipping And Delivery Expense + required: false + - value: Expense.Expense.StaffCosts + type: String + displayName: Staff Costs + required: false + - value: Expense.Expense.Sundry + type: String + displayName: Sundry + required: false + - value: Expense.Expense.TravelExpensesGeneralAndAdminExpenses + type: String + displayName: Travel Expenses General And Admin Expenses + required: false + - value: Expense.Expense.TravelExpensesSellingExpense + type: String + displayName: Travel Expenses Selling Expense + required: false + - value: Expense.Other Expense.Depreciation + type: String + displayName: Depreciation + required: false + - value: Expense.Other Expense.ExchangeGainOrLoss + type: String + displayName: Exchange Gain Or Loss + required: false + - value: Expense.Other Expense.OtherMiscellaneousExpense + type: String + displayName: Other Miscellaneous Expense + required: false + - value: Expense.Other Expense.PenaltiesSettlements + type: String + displayName: Penalties And Settlements + required: false + - value: Expense.Other Expense.Amortization + type: String + displayName: Amortization + required: false + - value: Expense.Other Expense.GasAndFuel + type: String + displayName: Gas And Fuel + required: false + - value: Expense.Other Expense.HomeOffice + type: String + displayName: Home Office + required: false + - value: Expense.Other Expense.HomeOwnerRentalInsurance + type: String + displayName: Home Owner Rental Insurance + required: false + - value: Expense.Other Expense.OtherHomeOfficeExpenses + type: String + displayName: Other Home Office Expenses + required: false + - value: Expense.Other Expense.MortgageInterest + type: String + displayName: Mortgage Interest + required: false + - value: Expense.Other Expense.RentAndLease + type: String + displayName: Rent And Lease + required: false + - value: Expense.Other Expense.RepairsAndMaintenance + type: String + displayName: Repairs And Maintenance + required: false + - value: Expense.Other Expense.ParkingAndTolls + type: String + displayName: Parking And Tolls + required: false + - value: Expense.Other Expense.Vehicle + type: String + displayName: Vehicle + required: false + - value: Expense.Other Expense.VehicleInsurance + type: String + displayName: Vehicle Insurance + required: false + - value: Expense.Other Expense.VehicleLease + type: String + displayName: Vehicle Lease + required: false + - value: Expense.Other Expense.VehicleLoanInterest + type: String + displayName: Vehicle Loan Interest + required: false + - value: Expense.Other Expense.VehicleLoan + type: String + displayName: Vehicle Loan + required: false + - value: Expense.Other Expense.VehicleRegistration + type: String + displayName: Vehicle Registration + required: false + - value: Expense.Other Expense.VehicleRepairs + type: String + displayName: Vehicle Repairs + required: false + - value: Expense.Other Expense.OtherVehicleExpenses + type: String + displayName: Other Vehicle Expenses + required: false + - value: Expense.Other Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Other Expense.WashAndRoadServices + type: String + displayName: Wash And Road Services + required: false + - value: Expense.Other Expense.DeferredTaxExpense + type: String + displayName: Deferred Tax Expense + required: false + - value: Expense.Other Expense.Depletion + type: String + displayName: Depletion + required: false + - value: Expense.Other Expense.ExceptionalItems + type: String + displayName: Exceptional Items + required: false + - value: Expense.Other Expense.ExtraordinaryItems + type: String + displayName: Extraordinary Items + required: false + - value: Expense.Other Expense.IncomeTaxOtherExpense + type: String + displayName: Income Tax Other Expense + required: false + - value: Expense.Other Expense.MatCredit + type: String + displayName: Mat Credit + required: false + - value: Expense.Other Expense.PriorPeriodItems + type: String + displayName: Prior Period Items + required: false + - value: Expense.Other Expense.TaxRoundoffGainOrLoss + type: String + displayName: Tax Roundoff Gain Or Loss + required: false + - value: Expense.Cost of Goods Sold.EquipmentRentalCos + type: String + displayName: Equipment Rental - COS + required: false + - value: Expense.Cost of Goods Sold.OtherCostsOfServiceCos + type: String + displayName: Other Costs Of Sales - COS + required: false + - value: Expense.Cost of Goods Sold.ShippingFreightDeliveryCos + type: String + displayName: 'Shipping, Freight And Delivery - COS' + required: false + - value: Expense.Cost of Goods Sold.SuppliesMaterialsCogs + type: String + displayName: Supplies And Materials - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfLaborCos + type: String + displayName: Cost Of Labor - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfSales + type: String + displayName: Cost Of Sales + required: false + - value: Expense.Cost of Goods Sold.FreightAndDeliveryCost + type: String + displayName: Freight And Delivery Cost + required: false + - value: Income.Income.NonProfitIncome + type: String + displayName: Non Profit Income + required: false + - value: Income.Income.OtherPrimaryIncome + type: String + displayName: Other Primary Income + required: false + - value: Income.Income.SalesOfProductIncome + type: String + displayName: Sales Of ProductIncome + required: false + - value: Income.Income.ServiceFeeIncome + type: String + displayName: Service Fee Income + required: false + - value: Income.Income.DiscountsRefundsGiven + type: String + displayName: Discounts Refunds Given + required: false + - value: Income.Income.UnappliedCashPaymentIncome + type: String + displayName: Unapplied Cash Payment Income + required: false + - value: Income.Income.CashReceiptIncome + type: String + displayName: Cash Receipt Income + required: false + - value: Income.Income.OperatingGrants + type: String + displayName: Operating Grants + required: false + - value: Income.Income.OtherCurrentOperatingIncome + type: String + displayName: Other Current Operating Income + required: false + - value: Income.Income.OwnWorkCapitalized + type: String + displayName: Own Work Capitalized + required: false + - value: Income.Income.RevenueGeneral + type: String + displayName: Revenue General + required: false + - value: Income.Income.SalesRetail + type: String + displayName: Sales Retail + required: false + - value: Income.Income.SalesWholesale + type: String + displayName: Sales Wholesale + required: false + - value: Income.Income.SavingsByTaxScheme + type: String + displayName: Savings By Tax Scheme + required: false + - value: Income.Other Income.DividendIncome + type: String + displayName: Dividend Income + required: false + - value: Income.Other Income.InterestEarned + type: String + displayName: Interest Earned + required: false + - value: Income.Other Income.OtherInvestmentIncome + type: String + displayName: Other Investment Income + required: false + - value: Income.Other Income.OtherMiscellaneousIncome + type: String + displayName: Other Miscellaneous Income + required: false + - value: Income.Other Income.TaxExemptInterest + type: String + displayName: Tax Exempt Interest + required: false + - value: Income.Other Income.GainLossOnSaleOfFixedAssets + type: String + displayName: Gain Loss On Sale Of Fixed Assets + required: false + - value: Income.Other Income.GainLossOnSaleOfInvestments + type: String + displayName: Gain Loss On Sale Of Investments + required: false + - value: Income.Other Income.LossOnDisposalOfAssets + type: String + displayName: Loss On Disposal Of Assets + required: false + - value: Income.Other Income.OtherOperatingIncome + type: String + displayName: Other Operating Income + required: false + - value: Income.Other Income.UnrealisedLossOnSecuritiesNetOfTax + type: String + displayName: Unrealised Loss On Securities Net Of Tax + required: false + - value: Liability.Accounts Payable.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.Accounts Payable.OutstandingDuesMicroSmallEnterprise + type: String + displayName: Outstanding Dues Micro Small Enterprise + required: false + - value: Liability.Accounts Payable.OutstandingDuesOtherThanMicroSmallEnterprise + type: String + displayName: Outstanding Dues Other Than Micro Small Enterprise + required: false + - value: Liability.Credit Card.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.Long Term Liability.NotesPayable + type: String + displayName: Notes Payable + required: false + - value: Liability.Long Term Liability.OtherLongTermLiabilities + type: String + displayName: Other Long Term Liabilities + required: false + - value: Liability.Long Term Liability.ShareholderNotesPayable + type: String + displayName: Shareholder Notes Payable + required: false + - value: Liability.Long Term Liability.AccrualsAndDeferredIncome + type: String + displayName: Accruals And Deferred Income + required: false + - value: Liability.Long Term Liability.AccruedLongLermLiabilities + type: String + displayName: Accrued Long Lerm Liabilities + required: false + - value: Liability.Long Term Liability.AccruedVacationPayable + type: String + displayName: Accrued Vacation Payable + required: false + - value: Liability.Long Term Liability.BankLoans + type: String + displayName: Bank Loans + required: false + - value: Liability.Long Term Liability.DebtsRelatedToParticipatingInterests + type: String + displayName: Debts Related To Participating Interests + required: false + - value: Liability.Long Term Liability.DeferredTaxLiabilities + type: String + displayName: Deferred Tax Liabilities + required: false + - value: Liability.Long Term Liability.GovernmentAndOtherPublicAuthorities + type: String + displayName: Government And Other Public Authorities + required: false + - value: Liability.Long Term Liability.GroupAndAssociates + type: String + displayName: Group And Associates + required: false + - value: Liability.Long Term Liability.LiabilitiesRelatedToAssetsHeldForSale + type: String + displayName: Liabilities Related To Assets Held For Sale + required: false + - value: Liability.Long Term Liability.LongTermBorrowings + type: String + displayName: Long Term Borrowings + required: false + - value: Liability.Long Term Liability.LongTermDebit + type: String + displayName: Long Term Debit + required: false + - value: Liability.Long Term Liability.LongTermEmployeeBenefitObligations + type: String + displayName: Long Term Employee Benefit Obligations + required: false + - value: Liability.Long Term Liability.ObligationsUnderFinanceLeases + type: String + displayName: Obligations Under Finance Leases + required: false + - value: Liability.Long Term Liability.OtherLongTermProvisions + type: String + displayName: Other Long Term Provisions + required: false + - value: Liability.Long Term Liability.ProvisionForLiabilities + type: String + displayName: Provision For Liabilities + required: false + - value: Liability.Long Term Liability.ProvisionsNonCurrentLiabilities + type: String + displayName: Provisions Non Current Liabilities + required: false + - value: Liability.Long Term Liability.StaffAndRelatedLongTermLiabilityAccounts + type: String + displayName: Staff And Related Long Term Liability Accounts + required: false + - value: Liability.Other Current Liability.DirectDepositPayable + type: String + displayName: Direct Deposit Payable + required: false + - value: Liability.Other Current Liability.LineOfCredit + type: String + displayName: Line Of Credit + required: false + - value: Liability.Other Current Liability.LoanPayable + type: String + displayName: Loan Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxPayable + type: String + displayName: Global Tax Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxSuspense + type: String + displayName: Global Tax Suspense + required: false + - value: Liability.Other Current Liability.OtherCurrentLiabilities + type: String + displayName: Other Current Liabilities + required: false + - value: Liability.Other Current Liability.PayrollClearing + type: String + displayName: Payroll Clearing + required: false + - value: Liability.Other Current Liability.PayrollTaxPayable + type: String + displayName: Payroll Tax Payable + required: false + - value: Liability.Other Current Liability.PrepaidExpensesPayable + type: String + displayName: Prepaid Expenses Payable + required: false + - value: Liability.Other Current Liability.RentsInTrustLiability + type: String + displayName: Rents In Trust Liability + required: false + - value: Liability.Other Current Liability.TrustAccountsLiabilities + type: String + displayName: Trust Accounts Liabilities + required: false + - value: Liability.Other Current Liability.FederalIncomeTaxPayable + type: String + displayName: Federal Income Tax Payable + required: false + - value: Liability.Other Current Liability.InsurancePayable + type: String + displayName: Insurance Payable + required: false + - value: Liability.Other Current Liability.SalesTaxPayable + type: String + displayName: Sales Tax Payable + required: false + - value: Liability.Other Current Liability.StateLocalIncomeTaxPayable + type: String + displayName: State Local Income Tax Payable + required: false + - value: Liability.Other Current Liability.AccruedLiabilities + type: String + displayName: Accrued Liabilities + required: false + - value: Liability.Other Current Liability.CurrentLiabilities + type: String + displayName: Current Liabilities + required: false + - value: Liability.Other Current Liability.CurrentPortionEmployeeBenefitsObligations + type: String + displayName: Current Portion EmployeeBenefits Obligations + required: false + - value: Liability.Other Current Liability.CurrentPortionOfObligationsUnderFinanceLeases + type: String + displayName: Current Portion Of Obligations Under Finance Leases + required: false + - value: Liability.Other Current Liability.CurrentTaxLiability + type: String + displayName: Current Tax Liability + required: false + - value: Liability.Other Current Liability.DividendsPayable + type: String + displayName: Dividends Payable + required: false + - value: Liability.Other Current Liability.DutiesAndTaxes + type: String + displayName: Duties And Taxes + required: false + - value: Liability.Other Current Liability.InterestPayables + type: String + displayName: Interest Payables + required: false + - value: Liability.Other Current Liability.ProvisionForWarrantyObligations + type: String + displayName: Provision For Warranty Obligations + required: false + - value: Liability.Other Current Liability.ProvisionsCurrentLiabilities + type: String + displayName: Provisions Current Liabilities + required: false + - value: Liability.Other Current Liability.ShortTermBorrowings + type: String + displayName: Short Term Borrowings + required: false + - value: Liability.Other Current Liability.SocialSecurityAgencies + type: String + displayName: Social Security Agencies + required: false + - value: Liability.Other Current Liability.StaffAndRelatedLiabilityAccounts + type: String + displayName: Staff And Related Liability Accounts + required: false + - value: Liability.Other Current Liability.SundryDebtorsAndCreditors + type: String + displayName: Sundry Debtors And Creditors + required: false + - value: Liability.Other Current Liability.TradeAndOtherPayables + type: String + displayName: Trade And Other Payables + required: false + - value: Equity.Equity.OpeningBalanceEquity + type: String + displayName: Opening Balance Equity + required: false + - value: Equity.Equity.PartnersEquity + type: String + displayName: Partners Equity + required: false + - value: Equity.Equity.RetainedEarnings + type: String + displayName: Retained Earnings + required: false + - value: Equity.Equity.AccumulatedAdjustment + type: String + displayName: Accumulated Adjustment + required: false + - value: Equity.Equity.OwnersEquity + type: String + displayName: Owners Equity + required: false + - value: Equity.Equity.PaidInCapitalOrSurplus + type: String + displayName: Paid In Capital Or Surplus + required: false + - value: Equity.Equity.PartnerContributions + type: String + displayName: Partner Contributions + required: false + - value: Equity.Equity.PartnerDistributions + type: String + displayName: Partner Distributions + required: false + - value: Equity.Equity.PreferredStock + type: String + displayName: Preferred Stock + required: false + - value: Equity.Equity.CommonStock + type: String + displayName: Common Stock + required: false + - value: Equity.Equity.TreasuryStock + type: String + displayName: Treasury Stock + required: false + - value: Equity.Equity.EstimatedTaxes + type: String + displayName: Estimated Taxes + required: false + - value: Equity.Equity.Healthcare + type: String + displayName: Healthcare + required: false + - value: Equity.Equity.PersonalIncome + type: String + displayName: Personal Income + required: false + - value: Equity.Equity.PersonalExpense + type: String + displayName: Personal Expense + required: false + - value: Equity.Equity.AccumulatedOtherComprehensiveIncome + type: String + displayName: Accumulated Other Comprehensive Income + required: false + - value: Equity.Equity.CalledUpShareCapital + type: String + displayName: Called Up Share Capital + required: false + - value: Equity.Equity.CapitalReserves + type: String + displayName: Capital Reserves + required: false + - value: Equity.Equity.DividendDisbursed + type: String + displayName: Dividend Disbursed + required: false + - value: Equity.Equity.EquityInEarningsOfSubsiduaries + type: String + displayName: Equity In Earnings Of Subsiduaries + required: false + - value: Equity.Equity.InvestmentGrants + type: String + displayName: Investment Grants + required: false + - value: Equity.Equity.MoneyReceivedAgainstShareWarrants + type: String + displayName: Money Received Against Share Warrants + required: false + - value: Equity.Equity.OtherFreeReserves + type: String + displayName: Other Free Reserves + required: false + - value: Equity.Equity.ShareApplicationMoneyPendingAllotment + type: String + displayName: Share Application Money Pending Allotment + required: false + - value: Equity.Equity.ShareCapital + type: String + displayName: Share Capital + required: false + - value: Equity.Equity.Funds + type: String + displayName: Funds + required: false + required: true + required: true + Sage Business Cloud Accounting: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: [] + information: + - field: Name + details: Should not be longer than 200 characters. + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: [] + information: + - field: NominalCode + details: Should be a number between 1 and 99999999. + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: SALES + type: String + displayName: Sales + required: false + - value: OTHER_INCOME + type: String + displayName: Other Income + required: false + - value: DIRECT_EXPENSES + type: String + displayName: Direct Expenses + required: false + - value: OVERHEADS + type: String + displayName: Overheads + required: false + - value: DEPRECIATION + type: String + displayName: Depreciation + required: false + - value: CURRENT_ASSETS + type: String + displayName: Current Assets + required: false + - value: FIXED_ASSETS + type: String + displayName: Fixed Assets + required: false + - value: FUTURE_ASSETS + type: String + displayName: Future Assets + required: false + - value: BANK + type: String + displayName: Bank + required: false + - value: CURRENT_LIABILITY + type: String + displayName: Current Liability + required: false + - value: FUTURE_LIABILITY + type: String + displayName: Future Liability + required: false + - value: EQUITY + type: String + displayName: Equity + required: false + - value: LINE_OF_CREDIT + type: String + displayName: Credit Card / Loan + required: false + required: true + required: true + Sage Intacct: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: Must be unique within the entity. + - field: NominalCode + details: 'Must be at most 24 characters in length, although restrictions may vary between entities.' + information: [] + name: + type: String + displayName: Name + description: Name of the account + required: true + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + type: + type: String + displayName: Account Type + description: 'The type, or base category, of the account' + options: + - value: Asset + type: String + displayName: Asset + required: false + - value: Equity + type: String + displayName: Equity + required: false + - value: Expense + type: String + displayName: Expense + required: false + - value: Income + type: String + displayName: Income + required: false + - value: Liability + type: String + displayName: Liability + required: false + required: true + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + required: true + validation: + warnings: [] + information: + - field: FullyQualifiedCategory + details: 'Any category that is part of the hierarchy of one of: ''Assets'', ''Equity'', ''Liabilities'', ''Total Expenses'' and ''Total Income'' is permitted.' + required: true + Sandbox: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + name: + type: String + displayName: Name + description: Name of the account + required: true + description: + type: String + displayName: Description + description: Description of the account + required: true + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + required: true + fullyQualifiedName: + type: String + displayName: Fully Qualified Name + description: The full name of the account e.g. Liability.Current.VAT or Income.Revenue.Sales + required: true + currency: + type: String + displayName: Currency + description: The currency of the account + required: true + currentBalance: + type: Number + displayName: Current Balance + description: The current balance in the account + required: true + type: + type: String + displayName: Account Type + description: 'The type, or base category, of the account' + required: true + status: + type: String + displayName: Account Status + description: The status of the account + required: true + isBankAccount: + type: Boolean + displayName: Is Bank Account? + description: Confirms whether the nominal account represents a bank account or not + required: true + validDatatypeLinks: + type: Array + displayName: Valid Datatype Links + description: Describes which fields on other data types are valid links to this account in the originating system + properties: + property: + type: String + displayName: Property + description: The field on the source data type that other data types can link to + required: true + links: + type: Array + displayName: Links + description: 'A collection of absolute names of fields from other data types, e.g. Invoice.LineItems.AccountRef.Id' + required: true + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + Xero: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: Identifier for the nominal account. + required: true + validation: + warnings: + - field: NominalCode + details: Max length of 10 characters. + information: [] + name: + type: String + displayName: Name + description: Name of account as it appears in the chart of accounts or general ledger. + required: true + validation: + warnings: [] + information: + - field: Name + details: Payments are enabled to this account if the name ends in .PaymentsEnabled. + description: + type: String + displayName: Description + description: Description for the nominal account. + required: false + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: Account type and category for nominal account. + options: + - value: Asset.Current + type: String + displayName: Current Asset + required: false + - value: Asset.Fixed + type: String + displayName: Fixed Asset + required: false + - value: Asset.Inventory + type: String + displayName: Inventory + required: false + - value: Asset.NonCurrent + type: String + displayName: Non-current Asset + required: false + - value: Asset.Prepayment + type: String + displayName: Prepayment + required: false + - value: Expense.DirectCosts + type: String + displayName: Direct Costs + required: false + - value: Expense.Expense + type: String + displayName: Expense + required: false + - value: Expense.Overhead + type: String + displayName: Overhead + required: false + - value: Expense.Superannuation + type: String + displayName: Superannuation + required: false + - value: Expense.Wages + type: String + displayName: Wages + required: false + - value: Income.Sales + type: String + displayName: Sales + required: false + - value: Income.Revenue + type: String + displayName: Revenue + required: false + - value: Income.Other + type: String + displayName: Other Income + required: false + - value: Liability.Current + type: String + displayName: Current Liability + required: false + - value: Liability.Depreciation + type: String + displayName: Depreciation + required: false + - value: Liability.Liability + type: String + displayName: Liability + required: false + - value: Liability.NonCurrent + type: String + displayName: Non Current Liability + required: false + - value: Liability.PayAsYouGo + type: String + displayName: Pay As You Go Liability + required: false + - value: Liability.Superannuation + type: String + displayName: Superannuation Liability + required: false + - value: Liability.WagesPayable + type: String + displayName: Wages Payable Liability + required: false + - value: Equity.Equity + type: String + displayName: Equity + required: false + required: true + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-chartOfAccounts-model + x-speakeasy-group: loan-writeback.accounts + description: |- + The *Get create account model* endpoint returns the expected data for the request payload when creating an [account](https://docs.codat.io/lending-api#/schemas/Account) for a given company and integration. + + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions. + + **Integration-specific behavior** + + See the *response examples* for integration-specific indicative models. + '/companies/{companyId}/connections/{connectionId}/push/accounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + summary: Create account + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAccount/definitions/accountPrototype' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateAccountResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Create account* endpoint creates a new [account](https://docs.codat.io/lending-api#/schemas/Account) for a given company's connection. + + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create account model](https://docs.codat.io/lending-api#/operations/get-create-chartOfAccounts-model). + operationId: create-account + x-speakeasy-group: loan-writeback.accounts + '/companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + summary: Create source account + 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. + + > ### 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 + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/SourceAccountV2/definitions/sourceAccountV2Prototype' + - $ref: '#/components/schemas/SourceAccount/definitions/sourceAccountPrototype' + 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: + value: + id: acc-002 + accountName: account-081 + sortCode: '123456' + accountType: Credit + accountNumber: '12345670' + currency: GBP + balance: 99.99 + modifiedDate: '2023-01-09T14:14:14.1057478Z' + responses: + '200': + description: Success + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/SourceAccountV2' + - $ref: '#/components/schemas/SourceAccount' + 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' + x-speakeasy-group: loan-writeback.source-accounts + '/companies/{companyId}/connections/{connectionId}/bankFeedAccounts/mapping': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Loan writeback + summary: List bank feed account mappings + 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 + x-speakeasy-group: loan-writeback.source-accounts + x-speakeasy-name-override: list-mappings + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankFeedMapping/definitions/bankFeedMappings' + examples: + Example: + 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 + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + post: + tags: + - Loan writeback + 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 + x-speakeasy-group: loan-writeback.source-accounts + x-speakeasy-name-override: create-mapping + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BankFeedBankAccountMapping' + examples: + Example: + value: + sourceAccountId: acc-002 + targetAccountId: account-081 + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankFeedBankAccountMappingResponse' + 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}/options/suppliers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create/update supplier model + tags: + - Loan writeback + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + Exact (Netherlands): + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + validation: + warnings: + - field: RegistrationNumber + details: 'Only for Exact Netherlands, if provided, must be exactly 20 characters in length' + information: [] + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: false + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: + - field: Addresses.Country + details: Must be a 2-letter country code + information: [] + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + required: false + validation: + warnings: [] + information: + - field: Addresses + details: 'Only the first address provided will be considered, all other entries will be not be recorded' + required: true + Exact (UK): + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + validation: + warnings: + - field: RegistrationNumber + details: 'Only for Exact Netherlands, if provided, must be exactly 20 characters in length' + information: [] + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: false + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: + - field: Addresses.Country + details: Must be a 2-letter country code + information: [] + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + required: false + validation: + warnings: [] + information: + - field: Addresses + details: 'Only the first address provided will be considered, all other entries will be not be recorded' + required: true + FreeAgent: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: true + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + country: + type: String + displayName: Country + description: The country for the address + required: false + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + required: false + validation: + warnings: [] + information: + - field: Addresses + details: Only one address may be specified + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: false + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + required: true + MYOB AccountRight and Essentials: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + validation: + warnings: + - field: SupplierName + details: Must not have the part after the first name longer than 30 characters. + - field: SupplierName + details: Must not have its first part (i.e. the first name) longer than 20 characters. + information: + - field: SupplierName + details: Must be provided and must contain a First and Last name separated by a ' '(space). + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + validation: + warnings: [] + information: + - field: EmailAddress + details: Must not be longer than 255 characters. + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + validation: + warnings: [] + information: + - field: Phone + details: Must not be longer than 21 characters. + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + validation: + warnings: [] + information: + - field: TaxNumber + details: Must not be longer than 19 characters. + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + validation: + warnings: [] + information: + - field: RegistrationNumber + details: Must not be longer than 14 characters. + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + required: false + - value: Unknown + type: String + required: false + required: true + validation: + warnings: [] + information: + - field: Status + details: Must be provided. + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + validation: + warnings: [] + information: + - field: Addresses.Line1 + details: Must not be longer than 127 characters. + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + validation: + warnings: [] + information: + - field: Addresses.Line2 + details: Must not be longer than 127 characters. + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + validation: + warnings: [] + information: + - field: Addresses.City + details: Must not be longer than 255 characters. + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + validation: + warnings: [] + information: + - field: Addresses.Region + details: Must not be longer than 255 characters. + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + validation: + warnings: [] + information: + - field: Addresses.PostalCode + details: Must not be longer than 11 characters. + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: [] + information: + - field: Addresses.Country + details: Must not be longer than 255 characters. + required: true + validation: + warnings: + - field: Addresses + details: Must only have 5 address entries at most. + information: + - field: Addresses + details: Must be provided. + required: true + Oracle NetSuite: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + type: + type: String + displayName: Address Type + description: The type of the address + options: + - value: Billing + type: String + displayName: Billing + required: false + - value: Delivery + type: String + displayName: Delivery + required: false + - value: Unknown + type: String + displayName: Unknown + required: false + required: true + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + country: + type: String + displayName: Country + description: The country for the address + required: true + validation: + warnings: + - field: Addresses.Country + details: Must be a two letter Country ISO code + information: [] + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + required: false + validation: + warnings: + - field: Addresses + details: Only one each of Billing and Delivery addresses can be provided + information: + - field: Addresses + details: Multiple addresses of Unknown type may be provided + required: true + QuickBooks Desktop: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + validation: + warnings: + - field: SupplierName + details: Max length of 41 characters. + information: [] + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: false + validation: + warnings: + - field: ContactName + details: Max length of 25 characters for first and last names + information: [] + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + validation: + warnings: + - field: TaxNumber + details: Max length of 30 characters. + information: [] + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + validation: + warnings: + - field: DefaultCurrency + details: 'Must be a three letter ISO code that matches an existing, active currency in the QuickBooks Desktop company' + - field: DefaultCurrency + details: Can only be set if Multicurrency is enabled within the QuickBooks Desktop company + information: + - field: DefaultCurrency + details: 'If not set, will default to the base currency of the QuickBooks Desktop company' + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + validation: + warnings: + - field: Addresses.Line1 + details: Max length of 41 characters. + information: [] + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + validation: + warnings: + - field: Addresses.Line2 + details: Max length of 41 characters. + information: [] + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + validation: + warnings: + - field: Addresses.City + details: Max length of 31 characters. + information: [] + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + validation: + warnings: + - field: Addresses.Region + details: Max length of 21 characters. + information: [] + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: + - field: Addresses.Country + details: Max length of 31 characters. + information: [] + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + validation: + warnings: + - field: Addresses.PostalCode + details: Max length of 13 characters. + information: [] + type: + type: String + displayName: Address Type + description: The type of the address + options: + - value: Billing + type: String + displayName: Billing Address + required: false + - value: Delivery + type: String + displayName: Delivery Address + required: false + required: true + validation: + warnings: [] + information: + - field: Addresses.Type + details: Only 1 address each of type(s) Billing/Delivery may be specified. + required: false + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + validation: + warnings: + - field: Phone + details: 'Country, area, and number are space separated' + information: [] + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + validation: + warnings: + - field: Addresses.Line1 + details: Max length of 500 characters. + information: [] + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + validation: + warnings: + - field: Addresses.Line2 + details: Max length of 500 characters. + information: [] + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + validation: + warnings: + - field: Addresses.City + details: Max length of 255 characters. + information: [] + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + validation: + warnings: + - field: Addresses.Region + details: Max length of 255 characters. + information: [] + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: + - field: Addresses.Country + details: Max length of 50 characters. + information: [] + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + validation: + warnings: + - field: Addresses.PostalCode + details: Only English alphabet characters are permitted. + - field: Addresses.PostalCode + details: Max length of 50 characters. + information: [] + type: + type: String + displayName: Address Type + description: The type of the address + options: + - value: Billing + type: String + displayName: Billing Address + required: false + required: true + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + required: true + QuickBooks Online: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + validation: + warnings: + - field: Phone + details: 'Country, area, and number are space separated' + information: [] + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + validation: + warnings: + - field: Addresses.Line1 + details: Max length of 500 characters. + information: [] + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + validation: + warnings: + - field: Addresses.Line2 + details: Max length of 500 characters. + information: [] + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + validation: + warnings: + - field: Addresses.City + details: Max length of 255 characters. + information: [] + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + validation: + warnings: + - field: Addresses.Region + details: Max length of 255 characters. + information: [] + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: + - field: Addresses.Country + details: Max length of 50 characters. + information: [] + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + validation: + warnings: + - field: Addresses.PostalCode + details: Only English alphabet characters are permitted. + - field: Addresses.PostalCode + details: Max length of 50 characters. + information: [] + type: + type: String + displayName: Address Type + description: The type of the address + options: + - value: Billing + type: String + displayName: Billing Address + required: false + required: true + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + required: true + Sage 50 (UK): + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + id: + type: String + displayName: Id + description: ID of the supplier. + required: true + validation: + warnings: + - field: id + details: 'The supplier ID must be unique, contain no spaces and have a maximum of 8 characters.' + information: + - field: id + details: 'The supplier ID must be all Uppercase, if it is not, it will be converted to Uppercase before pushing.' + supplierName: + type: String displayName: Name - description: The name of the bank account in the originating system + description: Name of the supplier. + required: true + validation: + warnings: + - field: supplierName + details: The supplier name can have a maximum of 60 characters + information: [] + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier. + required: false + validation: + warnings: + - field: contactName + details: The contact name can have a maximum of 30 characters + information: [] + emailAddress: + type: String + displayName: Email Address + description: The email address that the supplier may be contacted on. + required: false + phone: + type: String + displayName: Telephone + description: The telephone number that the supplier may be contacted on. + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: 'If not provided, the currency will default to the company''s base currency.' + required: false + status: + type: String + displayName: Status + description: The status of the supplier. + options: + - value: Active + type: String + displayName: Active Status + required: false + required: false + addresses: + type: Array + displayName: Addresses + description: Contact addresses for the supplier. + properties: + line1: + type: String + displayName: Line 1 + description: Line 1 of the supplier address. + required: true + line2: + type: String + displayName: Line 2 + description: Line 2 of the supplier address. + required: false + city: + type: String + displayName: City + description: The city of the supplier address. + required: false + region: + type: String + displayName: Region + description: The region of the supplier address. + required: false + postalCode: + type: String + displayName: Postal code + description: Post or Zip code for the address. + required: false + type: + type: String + displayName: Type + description: The type of address as it related to the supplier. + options: + - value: Unknown + type: String + displayName: Unknown Address + required: false + required: false + validation: + warnings: [] + information: + - field: addresses.type + details: 'If Address type is not specified, it will default to type ''''Unknown''''' + required: false + validation: + warnings: + - field: addresses + details: Only one address can be included in the Addresses array. + information: [] + taxNumber: + type: String + displayName: Tax Number + description: Legal company registration identifier. + required: false + required: true + validation: + warnings: [] + information: + - details: 'Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company.' + Sage Business Cloud Accounting: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: false + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: true + validation: + warnings: + - field: Addresses.Line1 + details: 'If you''re adding an address for this Supplier, you must also include the first line' + information: [] + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + country: + type: String + displayName: Country + description: The country for the address + options: + - value: Afghanistan (AF) + type: String + displayName: Afghanistan (AF) + required: false + - value: Albania (AL) + type: String + displayName: Albania (AL) + required: false + - value: Algeria (DZ) + type: String + displayName: Algeria (DZ) + required: false + - value: Andorra (AD) + type: String + displayName: Andorra (AD) + required: false + - value: Angola (AO) + type: String + displayName: Angola (AO) + required: false + - value: Argentina (AR) + type: String + displayName: Argentina (AR) + required: false + - value: Armenia (AM) + type: String + displayName: Armenia (AM) + required: false + - value: Aruba (AW) + type: String + displayName: Aruba (AW) + required: false + - value: Australia (AU) + type: String + displayName: Australia (AU) + required: false + - value: Austria (AT) + type: String + displayName: Austria (AT) + required: false + - value: Azerbaijan (AZ) + type: String + displayName: Azerbaijan (AZ) + required: false + - value: Bahamas (BS) + type: String + displayName: Bahamas (BS) + required: false + - value: Bahrain (BH) + type: String + displayName: Bahrain (BH) + required: false + - value: Bangladesh (BD) + type: String + displayName: Bangladesh (BD) + required: false + - value: Barbados (BB) + type: String + displayName: Barbados (BB) + required: false + - value: Belarus (BY) + type: String + displayName: Belarus (BY) + required: false + - value: Belgium (BE) + type: String + displayName: Belgium (BE) + required: false + - value: Belize (BZ) + type: String + displayName: Belize (BZ) + required: false + - value: Benin (BJ) + type: String + displayName: Benin (BJ) + required: false + - value: Bermuda (BM) + type: String + displayName: Bermuda (BM) + required: false + - value: Bhutan (BT) + type: String + displayName: Bhutan (BT) + required: false + - value: Bolivia (BO) + type: String + displayName: Bolivia (BO) + required: false + - value: Bosnia and Herzegovina (BA) + type: String + displayName: Bosnia and Herzegovina (BA) + required: false + - value: Botswana (BW) + type: String + displayName: Botswana (BW) + required: false + - value: Brazil (BR) + type: String + displayName: Brazil (BR) + required: false + - value: British Virgin Islands (VG) + type: String + displayName: British Virgin Islands (VG) + required: false + - value: Brunei Darussalam (BN) + type: String + displayName: Brunei Darussalam (BN) + required: false + - value: Bulgaria (BG) + type: String + displayName: Bulgaria (BG) + required: false + - value: Burkina Faso (BF) + type: String + displayName: Burkina Faso (BF) + required: false + - value: Burundi (BI) + type: String + displayName: Burundi (BI) + required: false + - value: Cambodia (KH) + type: String + displayName: Cambodia (KH) + required: false + - value: Cameroon (CM) + type: String + displayName: Cameroon (CM) + required: false + - value: Canada (CA) + type: String + displayName: Canada (CA) + required: false + - value: Cape Verde (CV) + type: String + displayName: Cape Verde (CV) + required: false + - value: Cayman Islands (KY) + type: String + displayName: Cayman Islands (KY) + required: false + - value: Central African Republic (CF) + type: String + displayName: Central African Republic (CF) + required: false + - value: Chad (TD) + type: String + displayName: Chad (TD) + required: false + - value: Chile (CL) + type: String + displayName: Chile (CL) + required: false + - value: China (CN) + type: String + displayName: China (CN) + required: false + - value: Colombia (CO) + type: String + displayName: Colombia (CO) + required: false + - value: Comoros (KM) + type: String + displayName: Comoros (KM) + required: false + - value: Congo (CG) + type: String + displayName: Congo (CG) + required: false + - value: Costa Rica (CR) + type: String + displayName: Costa Rica (CR) + required: false + - value: Croatia (HR) + type: String + displayName: Croatia (HR) + required: false + - value: Cuba (CU) + type: String + displayName: Cuba (CU) + required: false + - value: Cura�ao (CW) + type: String + displayName: Cura�ao (CW) + required: false + - value: Cyprus (CY) + type: String + displayName: Cyprus (CY) + required: false + - value: Czech Republic (CZ) + type: String + displayName: Czech Republic (CZ) + required: false + - value: Democratic Republic of the Congo (CD) + type: String + displayName: Democratic Republic of the Congo (CD) + required: false + - value: Denmark (DK) + type: String + displayName: Denmark (DK) + required: false + - value: Djibouti (DJ) + type: String + displayName: Djibouti (DJ) + required: false + - value: Dominica (DM) + type: String + displayName: Dominica (DM) + required: false + - value: Dominican Republic (DO) + type: String + displayName: Dominican Republic (DO) + required: false + - value: East Timor (TP) + type: String + displayName: East Timor (TP) + required: false + - value: Ecuador (EC) + type: String + displayName: Ecuador (EC) + required: false + - value: Egypt (EG) + type: String + displayName: Egypt (EG) + required: false + - value: El Salvador (SV) + type: String + displayName: El Salvador (SV) + required: false + - value: Equatorial Guinea (GQ) + type: String + displayName: Equatorial Guinea (GQ) + required: false + - value: Eritrea (ER) + type: String + displayName: Eritrea (ER) + required: false + - value: Estonia (EE) + type: String + displayName: Estonia (EE) + required: false + - value: Ethiopia (ET) + type: String + displayName: Ethiopia (ET) + required: false + - value: Falkland Islands (Malvinas) (FK) + type: String + displayName: Falkland Islands (Malvinas) (FK) + required: false + - value: Federated States of Micronesia (FM) + type: String + displayName: Federated States of Micronesia (FM) + required: false + - value: Fiji (FJ) + type: String + displayName: Fiji (FJ) + required: false + - value: Finland (FI) + type: String + displayName: Finland (FI) + required: false + - value: France (FR) + type: String + displayName: France (FR) + required: false + - value: French Polynesia (PF) + type: String + displayName: French Polynesia (PF) + required: false + - value: Gabon (GA) + type: String + displayName: Gabon (GA) + required: false + - value: Gambia (GM) + type: String + displayName: Gambia (GM) + required: false + - value: Georgia (GE) + type: String + displayName: Georgia (GE) + required: false + - value: Germany (DE) + type: String + displayName: Germany (DE) + required: false + - value: Ghana (GH) + type: String + displayName: Ghana (GH) + required: false + - value: Gibraltar (GI) + type: String + displayName: Gibraltar (GI) + required: false + - value: Greece (GR) + type: String + displayName: Greece (GR) + required: false + - value: Greenland (GL) + type: String + displayName: Greenland (GL) + required: false + - value: Grenada (GD) + type: String + displayName: Grenada (GD) + required: false + - value: Guadaloupe (GP) + type: String + displayName: Guadaloupe (GP) + required: false + - value: Guam (GU) + type: String + displayName: Guam (GU) + required: false + - value: Guatemala (GT) + type: String + displayName: Guatemala (GT) + required: false + - value: Guernsey (GG) + type: String + displayName: Guernsey (GG) + required: false + - value: Guinea (GN) + type: String + displayName: Guinea (GN) + required: false + - value: Guinea-Bissau (GW) + type: String + displayName: Guinea-Bissau (GW) + required: false + - value: Guyana (GY) + type: String + displayName: Guyana (GY) + required: false + - value: Haiti (HT) + type: String + displayName: Haiti (HT) + required: false + - value: Honduras (HN) + type: String + displayName: Honduras (HN) + required: false + - value: Hong Kong (HK) + type: String + displayName: Hong Kong (HK) + required: false + - value: Hungary (HU) + type: String + displayName: Hungary (HU) + required: false + - value: Iceland (IS) + type: String + displayName: Iceland (IS) + required: false + - value: India (IN) + type: String + displayName: India (IN) + required: false + - value: Indonesia (ID) + type: String + displayName: Indonesia (ID) + required: false + - value: Iran (IR) + type: String + displayName: Iran (IR) + required: false + - value: Iraq (IQ) + type: String + displayName: Iraq (IQ) + required: false + - value: Ireland (IE) + type: String + displayName: Ireland (IE) + required: false + - value: Israel (IL) + type: String + displayName: Israel (IL) + required: false + - value: Italy (IT) + type: String + displayName: Italy (IT) + required: false + - value: Ivory Coast (CI) + type: String + displayName: Ivory Coast (CI) + required: false + - value: Jamaica (JM) + type: String + displayName: Jamaica (JM) + required: false + - value: Japan (JP) + type: String + displayName: Japan (JP) + required: false + - value: Jersey (JE) + type: String + displayName: Jersey (JE) + required: false + - value: Jordan (JO) + type: String + displayName: Jordan (JO) + required: false + - value: Kazakhstan (KZ) + type: String + displayName: Kazakhstan (KZ) + required: false + - value: Kenya (KE) + type: String + displayName: Kenya (KE) + required: false + - value: Kuwait (KW) + type: String + displayName: Kuwait (KW) + required: false + - value: Kyrgyzstan (KG) + type: String + displayName: Kyrgyzstan (KG) + required: false + - value: Laos (LA) + type: String + displayName: Laos (LA) + required: false + - value: Latvia (LV) + type: String + displayName: Latvia (LV) + required: false + - value: Lebanon (LB) + type: String + displayName: Lebanon (LB) + required: false + - value: Lesotho (LS) + type: String + displayName: Lesotho (LS) + required: false + - value: Liberia (LR) + type: String + displayName: Liberia (LR) + required: false + - value: Libya (LY) + type: String + displayName: Libya (LY) + required: false + - value: Liechtenstein (LI) + type: String + displayName: Liechtenstein (LI) + required: false + - value: Lithuania (LT) + type: String + displayName: Lithuania (LT) + required: false + - value: Luxembourg (LU) + type: String + displayName: Luxembourg (LU) + required: false + - value: Macau (MO) + type: String + displayName: Macau (MO) + required: false + - value: Macedonia (MK) + type: String + displayName: Macedonia (MK) + required: false + - value: Madagascar (MG) + type: String + displayName: Madagascar (MG) + required: false + - value: Malawi (MW) + type: String + displayName: Malawi (MW) + required: false + - value: Malaysia (MY) + type: String + displayName: Malaysia (MY) + required: false + - value: Maldives (MV) + type: String + displayName: Maldives (MV) + required: false + - value: Mali (ML) + type: String + displayName: Mali (ML) + required: false + - value: Malta (MT) + type: String + displayName: Malta (MT) + required: false + - value: Mauritania (MR) + type: String + displayName: Mauritania (MR) + required: false + - value: Mauritius (MU) + type: String + displayName: Mauritius (MU) + required: false + - value: Mexico (MX) + type: String + displayName: Mexico (MX) + required: false + - value: Moldova (MD) + type: String + displayName: Moldova (MD) + required: false + - value: Monaco (MC) + type: String + displayName: Monaco (MC) + required: false + - value: Mongolia (MN) + type: String + displayName: Mongolia (MN) + required: false + - value: Montenegro (ME) + type: String + displayName: Montenegro (ME) + required: false + - value: Morocco (MA) + type: String + displayName: Morocco (MA) + required: false + - value: Mozambique (MZ) + type: String + displayName: Mozambique (MZ) + required: false + - value: Myanmar (MM) + type: String + displayName: Myanmar (MM) + required: false + - value: Namibia (NA) + type: String + displayName: Namibia (NA) + required: false + - value: Nepal (NP) + type: String + displayName: Nepal (NP) + required: false + - value: Netherlands (NL) + type: String + displayName: Netherlands (NL) + required: false + - value: Netherlands Antilles (AN) + type: String + displayName: Netherlands Antilles (AN) + required: false + - value: New Caledonia (NC) + type: String + displayName: New Caledonia (NC) + required: false + - value: New Zealand (NZ) + type: String + displayName: New Zealand (NZ) + required: false + - value: Nicaragua (NI) + type: String + displayName: Nicaragua (NI) + required: false + - value: Niger (NE) + type: String + displayName: Niger (NE) + required: false + - value: Nigeria (NG) + type: String + displayName: Nigeria (NG) + required: false + - value: North Korea (KP) + type: String + displayName: North Korea (KP) + required: false + - value: Norway (NO) + type: String + displayName: Norway (NO) + required: false + - value: Oman (OM) + type: String + displayName: Oman (OM) + required: false + - value: Pakistan (PK) + type: String + displayName: Pakistan (PK) + required: false + - value: Panama (PA) + type: String + displayName: Panama (PA) + required: false + - value: Papua New Guinea (PG) + type: String + displayName: Papua New Guinea (PG) + required: false + - value: Paraguay (PY) + type: String + displayName: Paraguay (PY) + required: false + - value: Peru (PE) + type: String + displayName: Peru (PE) + required: false + - value: Philippines (PH) + type: String + displayName: Philippines (PH) + required: false + - value: Poland (PL) + type: String + displayName: Poland (PL) + required: false + - value: Portugal (PT) + type: String + displayName: Portugal (PT) + required: false + - value: Puerto Rico (PR) + type: String + displayName: Puerto Rico (PR) + required: false + - value: Qatar (QA) + type: String + displayName: Qatar (QA) + required: false + - value: Romania (RO) + type: String + displayName: Romania (RO) + required: false + - value: Russia (RU) + type: String + displayName: Russia (RU) + required: false + - value: Rwanda (RW) + type: String + displayName: Rwanda (RW) + required: false + - value: Saint Kitts and Nevis (KN) + type: String + displayName: Saint Kitts and Nevis (KN) + required: false + - value: Saint Pierre and Miquelon (PM) + type: String + displayName: Saint Pierre and Miquelon (PM) + required: false + - value: Samoa (WS) + type: String + displayName: Samoa (WS) + required: false + - value: San Marino (SM) + type: String + displayName: San Marino (SM) + required: false + - value: Sao Tome and Principe (ST) + type: String + displayName: Sao Tome and Principe (ST) + required: false + - value: Saudi Arabia (SA) + type: String + displayName: Saudi Arabia (SA) + required: false + - value: Senegal (SN) + type: String + displayName: Senegal (SN) + required: false + - value: Serbia (RS) + type: String + displayName: Serbia (RS) + required: false + - value: Seychelles (SC) + type: String + displayName: Seychelles (SC) + required: false + - value: Sierra Leone (SL) + type: String + displayName: Sierra Leone (SL) + required: false + - value: Singapore (SG) + type: String + displayName: Singapore (SG) + required: false + - value: Slovakia (SK) + type: String + displayName: Slovakia (SK) + required: false + - value: Slovenia (SI) + type: String + displayName: Slovenia (SI) + required: false + - value: Solomon Islands (SB) + type: String + displayName: Solomon Islands (SB) + required: false + - value: Somalia (SO) + type: String + displayName: Somalia (SO) + required: false + - value: South Africa (ZA) + type: String + displayName: South Africa (ZA) + required: false + - value: South Korea (KR) + type: String + displayName: South Korea (KR) + required: false + - value: Spain (ES) + type: String + displayName: Spain (ES) + required: false + - value: Sri Lanka (LK) + type: String + displayName: Sri Lanka (LK) + required: false + - value: St. Lucia (LC) + type: String + displayName: St. Lucia (LC) + required: false + - value: Sudan (SD) + type: String + displayName: Sudan (SD) + required: false + - value: Surinam (SR) + type: String + displayName: Surinam (SR) + required: false + - value: Swaziland (SZ) + type: String + displayName: Swaziland (SZ) + required: false + - value: Sweden (SE) + type: String + displayName: Sweden (SE) + required: false + - value: Switzerland (CH) + type: String + displayName: Switzerland (CH) + required: false + - value: Syria (SY) + type: String + displayName: Syria (SY) + required: false + - value: Taiwan (TW) + type: String + displayName: Taiwan (TW) + required: false + - value: Tajikistan (TJ) + type: String + displayName: Tajikistan (TJ) + required: false + - value: Tanzania (TZ) + type: String + displayName: Tanzania (TZ) + required: false + - value: Thailand (TH) + type: String + displayName: Thailand (TH) + required: false + - value: Togo (TG) + type: String + displayName: Togo (TG) + required: false + - value: Tonga (TO) + type: String + displayName: Tonga (TO) + required: false + - value: Trinidad and Tobago (TT) + type: String + displayName: Trinidad and Tobago (TT) + required: false + - value: Tunisia (TN) + type: String + displayName: Tunisia (TN) + required: false + - value: Turkey (TR) + type: String + displayName: Turkey (TR) + required: false + - value: Turkmenistan (TM) + type: String + displayName: Turkmenistan (TM) + required: false + - value: Tuvalu (TV) + type: String + displayName: Tuvalu (TV) + required: false + - value: Uganda (UG) + type: String + displayName: Uganda (UG) + required: false + - value: Ukraine (UA) + type: String + displayName: Ukraine (UA) + required: false + - value: United Arab Emirates (AE) + type: String + displayName: United Arab Emirates (AE) + required: false + - value: United Kingdom (GB) + type: String + displayName: United Kingdom (GB) + required: false + - value: United States (US) + type: String + displayName: United States (US) + required: false + - value: Uruguay (UY) + type: String + displayName: Uruguay (UY) + required: false + - value: Uzbekistan (UZ) + type: String + displayName: Uzbekistan (UZ) + required: false + - value: Vanuatu (VU) + type: String + displayName: Vanuatu (VU) + required: false + - value: Venezuela (VE) + type: String + displayName: Venezuela (VE) + required: false + - value: Vietnam (VN) + type: String + displayName: Vietnam (VN) + required: false + - value: Virgin Islands U.S. (VI) + type: String + displayName: Virgin Islands U.S. (VI) + required: false + - value: Western Sahara (EH) + type: String + displayName: Western Sahara (EH) + required: false + - value: Yemen (YE) + type: String + displayName: Yemen (YE) + required: false + - value: Zaire (ZR) + type: String + displayName: Zaire (ZR) + required: false + - value: Zambia (ZM) + type: String + displayName: Zambia (ZM) + required: false + - value: Zimbabwe (ZW) + type: String + displayName: Zimbabwe (ZW) + required: false + required: false + required: false + validation: + warnings: [] + information: + - field: Addresses + details: Can contain a maximum of one address + required: true + Sage Intacct: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + validation: + warnings: + - field: SupplierName + details: Must be between 1 and 100 characters + information: [] + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: true + validation: + warnings: + - field: ContactName + details: Must be between 1 and 200 characters + information: [] + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + validation: + warnings: + - field: Phone + details: Must be no greater than 30 characters + information: [] + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + validation: + warnings: + - field: EmailAddress + details: Must be no greater than 200 characters + information: [] + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + validation: + warnings: + - field: TaxNumber + details: Must be no greater than 20 characters + information: [] + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + validation: + warnings: + - field: RegistrationNumber + details: Must be no greater than 100 characters + information: [] + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + options: + - value: AUD + type: String + displayName: Australian Dollar + required: false + - value: CAD + type: String + displayName: Canadian Dollar + required: false + - value: GBP + type: String + displayName: Pound Sterling + required: false + - value: USD + type: String + displayName: US Dollar + required: false + - value: ZAR + type: String + displayName: Rand + required: false + required: false + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + validation: + warnings: + - field: Addresses.Line1 + details: Must be no greater than 200 characters + information: [] + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + validation: + warnings: + - field: Addresses.Line2 + details: Must be no greater than 200 characters + information: [] + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + validation: + warnings: + - field: Addresses.City + details: Must be no greater than 80 characters + information: [] + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + validation: + warnings: + - field: Addresses.Region + details: Must be no greater than 40 characters + information: [] + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + validation: + warnings: + - field: Addresses.PostalCode + details: Must be no greater than 30 characters + information: [] + country: + type: String + displayName: Country + description: The country for the address + options: + - value: United States + type: String + displayName: United States + required: false + - value: Afghanistan + type: String + displayName: Afghanistan + required: false + - value: Aland Islands + type: String + displayName: Aland Islands + required: false + - value: Albania + type: String + displayName: Albania + required: false + - value: Algeria + type: String + displayName: Algeria + required: false + - value: American Samoa + type: String + displayName: American Samoa + required: false + - value: Andorra + type: String + displayName: Andorra + required: false + - value: Angola + type: String + displayName: Angola + required: false + - value: Anguilla + type: String + displayName: Anguilla + required: false + - value: Antarctica + type: String + displayName: Antarctica + required: false + - value: Antigua and Barbuda + type: String + displayName: Antigua and Barbuda + required: false + - value: Argentina + type: String + displayName: Argentina + required: false + - value: Armenia + type: String + displayName: Armenia + required: false + - value: Aruba + type: String + displayName: Aruba + required: false + - value: Australia + type: String + displayName: Australia + required: false + - value: Austria + type: String + displayName: Austria + required: false + - value: Azerbaijan + type: String + displayName: Azerbaijan + required: false + - value: Bahamas + type: String + displayName: Bahamas + required: false + - value: Bahrain + type: String + displayName: Bahrain + required: false + - value: Bangladesh + type: String + displayName: Bangladesh + required: false + - value: Barbados + type: String + displayName: Barbados + required: false + - value: Belarus + type: String + displayName: Belarus + required: false + - value: Belgium + type: String + displayName: Belgium + required: false + - value: Belize + type: String + displayName: Belize + required: false + - value: Benin + type: String + displayName: Benin + required: false + - value: Bermuda + type: String + displayName: Bermuda + required: false + - value: Bhutan + type: String + displayName: Bhutan + required: false + - value: Bolivia + type: String + displayName: Bolivia + required: false + - value: 'Bonaire, Sint Eustatius and Saba' + type: String + displayName: 'Bonaire, Sint Eustatius and Saba' + required: false + - value: Bosnia and Herzegovina + type: String + displayName: Bosnia and Herzegovina + required: false + - value: Botswana + type: String + displayName: Botswana + required: false + - value: Bouvet Island + type: String + displayName: Bouvet Island + required: false + - value: Brazil + type: String + displayName: Brazil + required: false + - value: British Indian Ocean Territory + type: String + displayName: British Indian Ocean Territory + required: false + - value: Brunei Darussalam + type: String + displayName: Brunei Darussalam + required: false + - value: Bulgaria + type: String + displayName: Bulgaria + required: false + - value: Burkina Faso + type: String + displayName: Burkina Faso + required: false + - value: Burundi + type: String + displayName: Burundi + required: false + - value: Cambodia + type: String + displayName: Cambodia + required: false + - value: Cameroon + type: String + displayName: Cameroon + required: false + - value: Canada + type: String + displayName: Canada + required: false + - value: Cape Verde + type: String + displayName: Cape Verde + required: false + - value: Cayman Islands + type: String + displayName: Cayman Islands + required: false + - value: Central African Republic + type: String + displayName: Central African Republic + required: false + - value: Chad + type: String + displayName: Chad + required: false + - value: Chile + type: String + displayName: Chile + required: false + - value: China + type: String + displayName: China + required: false + - value: Christmas Island + type: String + displayName: Christmas Island + required: false + - value: Cocos (Keeling) Islands + type: String + displayName: Cocos (Keeling) Islands + required: false + - value: Colombia + type: String + displayName: Colombia + required: false + - value: Comoros + type: String + displayName: Comoros + required: false + - value: Congo + type: String + displayName: Congo + required: false + - value: 'Congo, Democratic Republic' + type: String + displayName: 'Congo, Democratic Republic' + required: false + - value: Cook Islands + type: String + displayName: Cook Islands + required: false + - value: Costa Rica + type: String + displayName: Costa Rica + required: false + - value: C�te d'Ivoire + type: String + displayName: C�te d'Ivoire + required: false + - value: Croatia + type: String + displayName: Croatia + required: false + - value: Cuba + type: String + displayName: Cuba + required: false + - value: Cura�ao + type: String + displayName: Cura�ao + required: false + - value: Cyprus + type: String + displayName: Cyprus + required: false + - value: Czech Republic + type: String + displayName: Czech Republic + required: false + - value: Denmark + type: String + displayName: Denmark + required: false + - value: Djibouti + type: String + displayName: Djibouti + required: false + - value: Dominica + type: String + displayName: Dominica + required: false + - value: Dominican Republic + type: String + displayName: Dominican Republic + required: false + - value: Ecuador + type: String + displayName: Ecuador + required: false + - value: Egypt + type: String + displayName: Egypt + required: false + - value: El Salvador + type: String + displayName: El Salvador + required: false + - value: Equatorial Guinea + type: String + displayName: Equatorial Guinea + required: false + - value: Eritrea + type: String + displayName: Eritrea + required: false + - value: Estonia + type: String + displayName: Estonia + required: false + - value: Eswatini + type: String + displayName: Eswatini + required: false + - value: Ethiopia + type: String + displayName: Ethiopia + required: false + - value: Falkland Islands (Malvinas + type: String + displayName: Falkland Islands (Malvinas + required: false + - value: Faroe Islands + type: String + displayName: Faroe Islands + required: false + - value: Fiji + type: String + displayName: Fiji + required: false + - value: Finland + type: String + displayName: Finland + required: false + - value: France + type: String + displayName: France + required: false + - value: French Guiana + type: String + displayName: French Guiana + required: false + - value: French Polynesia + type: String + displayName: French Polynesia + required: false + - value: French Southern Territories + type: String + displayName: French Southern Territories + required: false + - value: Gabon + type: String + displayName: Gabon + required: false + - value: Gambia + type: String + displayName: Gambia + required: false + - value: Georgia + type: String + displayName: Georgia + required: false + - value: Germany + type: String + displayName: Germany + required: false + - value: Ghana + type: String + displayName: Ghana + required: false + - value: Gibraltar + type: String + displayName: Gibraltar + required: false + - value: Greece + type: String + displayName: Greece + required: false + - value: Greenland + type: String + displayName: Greenland + required: false + - value: Grenada + type: String + displayName: Grenada + required: false + - value: Guadeloupe + type: String + displayName: Guadeloupe + required: false + - value: Guam + type: String + displayName: Guam + required: false + - value: Guatemala + type: String + displayName: Guatemala + required: false + - value: Guernsey + type: String + displayName: Guernsey + required: false + - value: Guinea + type: String + displayName: Guinea + required: false + - value: Guinea-Bissau + type: String + displayName: Guinea-Bissau + required: false + - value: Guyana + type: String + displayName: Guyana + required: false + - value: Haiti + type: String + displayName: Haiti + required: false + - value: Heard Is. & Mcdonald Islands + type: String + displayName: Heard Is. & Mcdonald Islands + required: false + - value: Honduras + type: String + displayName: Honduras + required: false + - value: Hong Kong + type: String + displayName: Hong Kong + required: false + - value: Hungary + type: String + displayName: Hungary + required: false + - value: Iceland + type: String + displayName: Iceland + required: false + - value: India + type: String + displayName: India + required: false + - value: Indonesia + type: String + displayName: Indonesia + required: false + - value: 'Iran, Islamic Republic of' + type: String + displayName: 'Iran, Islamic Republic of' + required: false + - value: Iraq + type: String + displayName: Iraq + required: false + - value: Ireland + type: String + displayName: Ireland + required: false + - value: Isle of Man + type: String + displayName: Isle of Man + required: false + - value: Israel + type: String + displayName: Israel + required: false + - value: Italy + type: String + displayName: Italy + required: false + - value: Jamaica + type: String + displayName: Jamaica + required: false + - value: Japan + type: String + displayName: Japan + required: false + - value: Jersey + type: String + displayName: Jersey + required: false + - value: Jordan + type: String + displayName: Jordan + required: false + - value: Kazakhstan + type: String + displayName: Kazakhstan + required: false + - value: Kenya + type: String + displayName: Kenya + required: false + - value: Kiribati + type: String + displayName: Kiribati + required: false + - value: 'Korea, Republic of' + type: String + displayName: 'Korea, Republic of' + required: false + - value: 'Korea, Demo. People''s Rep' + type: String + displayName: 'Korea, Demo. People''s Rep' + required: false + - value: Kosovo + type: String + displayName: Kosovo + required: false + - value: Kuwait + type: String + displayName: Kuwait + required: false + - value: Kyrgyzstan + type: String + displayName: Kyrgyzstan + required: false + - value: Lao + type: String + displayName: Lao + required: false + - value: Latvia + type: String + displayName: Latvia + required: false + - value: Lebanon + type: String + displayName: Lebanon + required: false + - value: Lesotho + type: String + displayName: Lesotho + required: false + - value: Liberia + type: String + displayName: Liberia + required: false + - value: Libyan Arab Jamahiriya + type: String + displayName: Libyan Arab Jamahiriya + required: false + - value: Liechtenstein + type: String + displayName: Liechtenstein + required: false + - value: Lithuania + type: String + displayName: Lithuania + required: false + - value: Luxembourg + type: String + displayName: Luxembourg + required: false + - value: Macao + type: String + displayName: Macao + required: false + - value: Macedonia + type: String + displayName: Macedonia + required: false + - value: Madagascar + type: String + displayName: Madagascar + required: false + - value: Malawi + type: String + displayName: Malawi + required: false + - value: Malaysia + type: String + displayName: Malaysia + required: false + - value: Maldives + type: String + displayName: Maldives + required: false + - value: Mali + type: String + displayName: Mali + required: false + - value: Malta + type: String + displayName: Malta + required: false + - value: Marshall Islands + type: String + displayName: Marshall Islands + required: false + - value: Martinique + type: String + displayName: Martinique + required: false + - value: Mauritania + type: String + displayName: Mauritania + required: false + - value: Mauritius + type: String + displayName: Mauritius + required: false + - value: Mayotte + type: String + displayName: Mayotte + required: false + - value: Mexico + type: String + displayName: Mexico + required: false + - value: Micronesia + type: String + displayName: Micronesia + required: false + - value: 'Moldova, Republic of' + type: String + displayName: 'Moldova, Republic of' + required: false + - value: Monaco + type: String + displayName: Monaco + required: false + - value: Mongolia + type: String + displayName: Mongolia + required: false + - value: Montenegro + type: String + displayName: Montenegro + required: false + - value: Montserrat + type: String + displayName: Montserrat + required: false + - value: Morocco + type: String + displayName: Morocco + required: false + - value: Mozambique + type: String + displayName: Mozambique + required: false + - value: Myanmar + type: String + displayName: Myanmar + required: false + - value: Namibia + type: String + displayName: Namibia + required: false + - value: Nauru + type: String + displayName: Nauru + required: false + - value: Nepal + type: String + displayName: Nepal + required: false + - value: Netherlands + type: String + displayName: Netherlands + required: false + - value: Netherlands Antilles + type: String + displayName: Netherlands Antilles + required: false + - value: New Caledonia + type: String + displayName: New Caledonia + required: false + - value: New Zealand + type: String + displayName: New Zealand + required: false + - value: Nicaragua + type: String + displayName: Nicaragua + required: false + - value: Niger + type: String + displayName: Niger + required: false + - value: Nigeria + type: String + displayName: Nigeria + required: false + - value: Niue + type: String + displayName: Niue + required: false + - value: Norfolk Island + type: String + displayName: Norfolk Island + required: false + - value: Northern Mariana Islands + type: String + displayName: Northern Mariana Islands + required: false + - value: Norway + type: String + displayName: Norway + required: false + - value: Oman + type: String + displayName: Oman + required: false + - value: Pakistan + type: String + displayName: Pakistan + required: false + - value: Palau + type: String + displayName: Palau + required: false + - value: 'Palestinian Territory, Occupied' + type: String + displayName: 'Palestinian Territory, Occupied' + required: false + - value: Panama + type: String + displayName: Panama + required: false + - value: Papua New Guinea + type: String + displayName: Papua New Guinea + required: false + - value: Paraguay + type: String + displayName: Paraguay + required: false + - value: Peru + type: String + displayName: Peru + required: false + - value: Philippines + type: String + displayName: Philippines + required: false + - value: Pitcairn + type: String + displayName: Pitcairn + required: false + - value: Poland + type: String + displayName: Poland + required: false + - value: Portugal + type: String + displayName: Portugal + required: false + - value: Puerto Rico + type: String + displayName: Puerto Rico + required: false + - value: Qatar + type: String + displayName: Qatar + required: false + - value: Reunion + type: String + displayName: Reunion + required: false + - value: Romania + type: String + displayName: Romania + required: false + - value: Russian Federation + type: String + displayName: Russian Federation + required: false + - value: Rwanda + type: String + displayName: Rwanda + required: false + - value: Saint Barthelemy + type: String + displayName: Saint Barthelemy + required: false + - value: Saint Helena + type: String + displayName: Saint Helena + required: false + - value: Saint Kitts and Nevis + type: String + displayName: Saint Kitts and Nevis + required: false + - value: Saint Lucia + type: String + displayName: Saint Lucia + required: false + - value: Saint Martin + type: String + displayName: Saint Martin + required: false + - value: Saint Pierre and Miquelon + type: String + displayName: Saint Pierre and Miquelon + required: false + - value: Saint Vincent and the Grenadines + type: String + displayName: Saint Vincent and the Grenadines + required: false + - value: Samoa + type: String + displayName: Samoa + required: false + - value: San Marino + type: String + displayName: San Marino + required: false + - value: Sao Tome and Principe + type: String + displayName: Sao Tome and Principe + required: false + - value: Saudi Arabia + type: String + displayName: Saudi Arabia + required: false + - value: Senegal + type: String + displayName: Senegal + required: false + - value: Serbia + type: String + displayName: Serbia + required: false + - value: Seychelles + type: String + displayName: Seychelles + required: false + - value: Sierra Leone + type: String + displayName: Sierra Leone + required: false + - value: Singapore + type: String + displayName: Singapore + required: false + - value: Sint Maarten + type: String + displayName: Sint Maarten + required: false + - value: Slovakia + type: String + displayName: Slovakia + required: false + - value: Slovenia + type: String + displayName: Slovenia + required: false + - value: Solomon Islands + type: String + displayName: Solomon Islands + required: false + - value: Somalia + type: String + displayName: Somalia + required: false + - value: South Africa + type: String + displayName: South Africa + required: false + - value: S. Georgia & S. Sandwich Is + type: String + displayName: S. Georgia & S. Sandwich Is + required: false + - value: Spain + type: String + displayName: Spain + required: false + - value: Sri Lanka + type: String + displayName: Sri Lanka + required: false + - value: Sudan + type: String + displayName: Sudan + required: false + - value: South Sudan + type: String + displayName: South Sudan + required: false + - value: Suriname + type: String + displayName: Suriname + required: false + - value: Svalbard and Jan Mayen + type: String + displayName: Svalbard and Jan Mayen + required: false + - value: Sweden + type: String + displayName: Sweden + required: false + - value: Switzerland + type: String + displayName: Switzerland + required: false + - value: Syrian Arab Republic + type: String + displayName: Syrian Arab Republic + required: false + - value: Taiwan + type: String + displayName: Taiwan + required: false + - value: Tajikistan + type: String + displayName: Tajikistan + required: false + - value: 'Tanzania, United Republic of' + type: String + displayName: 'Tanzania, United Republic of' + required: false + - value: Thailand + type: String + displayName: Thailand + required: false + - value: Timor-Leste + type: String + displayName: Timor-Leste + required: false + - value: Togo + type: String + displayName: Togo + required: false + - value: Tokelau + type: String + displayName: Tokelau + required: false + - value: Tonga + type: String + displayName: Tonga + required: false + - value: Trinidad and Tobago + type: String + displayName: Trinidad and Tobago + required: false + - value: Tunisia + type: String + displayName: Tunisia + required: false + - value: Turkey + type: String + displayName: Turkey + required: false + - value: Turkmenistan + type: String + displayName: Turkmenistan + required: false + - value: Turks and Caicos Islands + type: String + displayName: Turks and Caicos Islands + required: false + - value: Tuvalu + type: String + displayName: Tuvalu + required: false + - value: Uganda + type: String + displayName: Uganda + required: false + - value: Ukraine + type: String + displayName: Ukraine + required: false + - value: United Arab Emirates + type: String + displayName: United Arab Emirates + required: false + - value: United Kingdom + type: String + displayName: United Kingdom + required: false + - value: US Minor Outlying Islands + type: String + displayName: US Minor Outlying Islands + required: false + - value: Uruguay + type: String + displayName: Uruguay + required: false + - value: Uzbekistan + type: String + displayName: Uzbekistan + required: false + - value: Vanuatu + type: String + displayName: Vanuatu + required: false + - value: Vatican City State + type: String + displayName: Vatican City State + required: false + - value: Venezuela + type: String + displayName: Venezuela + required: false + - value: Vietnam + type: String + displayName: Vietnam + required: false + - value: 'Virgin Islands, British' + type: String + displayName: 'Virgin Islands, British' + required: false + - value: 'Virgin Islands, U.S' + type: String + displayName: 'Virgin Islands, U.S' + required: false + - value: Wallis and Futuna + type: String + displayName: Wallis and Futuna + required: false + - value: Western Sahara + type: String + displayName: Western Sahara + required: false + - value: Yemen + type: String + displayName: Yemen + required: false + - value: Zambia + type: String + displayName: Zambia + required: false + - value: Zimbabwe + type: String + displayName: Zimbabwe + required: false + required: false + validation: + warnings: + - field: Addresses.Country + details: Required if TaxNumber is supplied + information: [] + required: false + validation: + warnings: + - field: Addresses + details: 'If supplied, must contain only 1 address' + - field: Addresses + details: 'If TaxNumber is supplied, an Address with a Country is required' + information: [] + required: true + Sandbox: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: true + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: true + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + type: + type: String + displayName: Address Type + description: The type of the address + required: true + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: true + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: true + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: true + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: true + country: + type: String + displayName: Country + description: The country for the address + required: true + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: true + required: true + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: true + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: true + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + required: true + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + Xero: + value: + type: Object + displayName: Suppliers + description: 'An accounts payable contact that supplies good or services, also referred to as a vendor.' + properties: + supplierName: + type: String + displayName: Name + description: Name of the supplier. + required: true + phone: + type: String + displayName: Phone + description: Main contact phone number for the supplier. + required: false + validation: + warnings: + - field: phone + details: 'Country, area, and number are space separated' + information: [] + emailAddress: + type: String + displayName: Email + description: Main contact email for the supplier. + required: false + registrationNumber: + type: String + displayName: Registration Number + description: Legal company registration identifier. + required: false + validation: + warnings: + - field: registrationNumber + details: Max length of 50 characters + information: [] + taxNumber: + type: String + displayName: Tax Number + description: Legal tax registration identifier. + required: false + status: + type: String + displayName: Status + description: Status of the supplier account. + options: + - value: Active + type: String + displayName: Active + required: false + - value: InActive + type: String + displayName: Inactive + required: false + required: false + addresses: + type: Array + displayName: Addresses + description: Contact addresses for the supplier. + properties: + line1: + type: String + displayName: Address Line 1 + description: First line of the address. + required: false + validation: + warnings: + - field: addresses.line1 + details: Max length of 500 characters. + information: [] + line2: + type: String + displayName: Address Line 2 + description: Second line of the address. + required: false + validation: + warnings: + - field: addresses.line2 + details: Max length of 500 characters. + information: [] + city: + type: String + displayName: City + description: Local city for the address. + required: false + validation: + warnings: + - field: addresses.city + details: Max length of 255 characters. + information: [] + region: + type: String + displayName: Region + description: Region the address is located in. + required: false + validation: + warnings: + - field: addresses.region + details: Max length of 255 characters. + information: [] + country: + type: String + displayName: Country + description: Country for the address. + required: false + validation: + warnings: + - field: addresses.country + details: Max length of 50 characters. + information: [] + postalCode: + type: String + displayName: Postal code + description: Post or Zip code for the address. + required: false + validation: + warnings: + - field: addresses.postalCode + details: Only English alphabet characters are permitted. + - field: addresses.postalCode + details: Max length of 50 characters. + information: [] + type: + type: String + displayName: Type + description: The type of address as it related to the supplier. + options: + - value: Billing + type: String + displayName: Billing Address + required: false + - value: Delivery + type: String + displayName: Delivery Address + required: false + required: true + validation: + warnings: + - field: addresses.type + details: 'Billing = POBOX, Delivery/Unknown = DELIVERY' + information: [] + required: false + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-update-suppliers-model + x-speakeasy-group: loan-writeback.suppliers + description: "The *Get create/update supplier model* endpoint returns the expected data for the request payload when creating and updating a [supplier](https://docs.codat.io/lending-api#/schemas/Supplier) for a given company and integration.\r\n\r\n[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\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/suppliers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingSupplier' + examples: + Sage Intacct: + value: + id: '73593' + supplierName: test 20230420 1004 + contactName: Joe Bloggs + status: Active + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateSupplierResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Create supplier + description: "The *Create supplier* endpoint creates a new [supplier](https://docs.codat.io/lending-api#/schemas/Supplier) for a given company's connection.\r\n\r\n[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\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 supplier model](https://docs.codat.io/lending-api#/operations/get-create-update-suppliers-model).\r\n" + operationId: create-supplier + x-speakeasy-group: loan-writeback.suppliers + '/companies/{companyId}/connections/{connectionId}/options/transfers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create transfer model + tags: + - Loan writeback + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + Exact (Netherlands): + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + contactRef: + type: Object + displayName: Contact Reference + description: The customer or supplier for this transfer if known + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: ContactRef.Id + details: Must match the ID of an existing customer or supplier. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: customers + type: String + displayName: customers + required: false + - value: suppliers + type: String + displayName: suppliers + required: false + required: true + required: false + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: From.Amount + details: Transfer Amount must be greater than zero. + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank or nominal account. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: chartOfAccounts + type: String + displayName: chartOfAccounts + required: false + required: true + required: true + validation: + warnings: + - field: From.AccountRef + details: Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account). + information: [] + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: To.Amount + details: Transfer Amount must be greater than zero. + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank or nominal account. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: chartOfAccounts + type: String + displayName: chartOfAccounts + required: false + required: true + required: true + validation: + warnings: + - field: To.AccountRef + details: Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account). + information: [] + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this transfer is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: false + required: false + required: true + Exact (UK): + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + contactRef: + type: Object + displayName: Contact Reference + description: The customer or supplier for this transfer if known + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: ContactRef.Id + details: Must match the ID of an existing customer or supplier. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: customers + type: String + displayName: customers + required: false + - value: suppliers + type: String + displayName: suppliers + required: false + required: true + required: false + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: From.Amount + details: Transfer Amount must be greater than zero. + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank or nominal account. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: chartOfAccounts + type: String + displayName: chartOfAccounts + required: false + required: true + required: true + validation: + warnings: + - field: From.AccountRef + details: Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account). + information: [] + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: To.Amount + details: Transfer Amount must be greater than zero. + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank or nominal account. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: chartOfAccounts + type: String + displayName: chartOfAccounts + required: false + required: true + required: true + validation: + warnings: + - field: To.AccountRef + details: Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account). + information: [] + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this transfer is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: false + required: false + required: true + FreeAgent: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank account. + information: [] + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: From.Amount + details: Must be provided and be greater than zero. + information: [] + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank account. + information: [] + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: false + validation: + warnings: + - field: To.Amount + details: 'If provided, must be greater than zero.' + - field: To.Amount + details: It will be taken into account just if the accounts are in different currencies and will override the automatic currency conversion. + information: [] + required: true + required: true + Oracle NetSuite: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: false + validation: + warnings: [] + information: + - field: Date + details: Will default to today's date if not provided + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Either the 'From' account or the 'To' account must be a bank account - the other must be an undeposited funds account + information: [] + required: true + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Either the 'From' account or the 'To' account must be a bank account - the other must be an undeposited funds account + information: [] + required: true + required: true + depositedRecordRefs: + type: Array + displayName: Deposited Record References + description: A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer. + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this transfer is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + validation: + warnings: + - field: TrackingCategoryRefs.Id + details: 'One location, one department and one classification may be provided' + information: [] + required: false + required: true + validation: + warnings: + - details: Currently only transfers between bank accounts and undeposited funds accounts are supported + information: [] + QuickBooks Desktop: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: From.Amount + details: Value should match To.Amount + - field: From.Amount + details: Value should be greater than zero + information: [] + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + validation: + warnings: + - field: From.Currency + details: 'This value is not used in the push, and will be ignored.' + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: To.Amount + details: Value should match To.Amount + - field: To.Amount + details: Value should be greater than zero + information: [] + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + validation: + warnings: + - field: To.Currency + details: 'This value is not used in the push, and will be ignored.' + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this transfer is being tracked against + required: false + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + validation: + warnings: + - field: Description + details: Max length of 4096 characters. + information: [] + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + contactRef: + type: Object + displayName: Contact Reference + description: The customer or supplier for this transfer if known + required: false + validation: + warnings: + - field: ContactRef + details: 'This value is not used in the push, and will be ignored.' + information: [] + sourceModifiedDate: + type: DateTime + displayName: Source Modified Date + description: The date the record was last changed in the originating system + required: true + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + required: true + depositedRecordRefs: + type: Array + displayName: Deposited Record References + description: A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer. + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: payments + type: String + displayName: Payments + required: false + - value: directIncomes + type: String + displayName: DirectIncomes + required: false + - value: journalEntries + type: String + displayName: JournalEntries + required: false + required: true + required: false + required: true + validation: + warnings: + - details: 'When pushing a transfer using two different currencies, the exchange rate will be calculated and passed to QuickBooks, QuickBooks performs rounding on this value which may affect the values in the transfer' + - details: Transfers between accounts in different currencies can only be made if multi-currency is enabled for company + - details: The currency of at least one of the accounts used must be the same as the company's currency + information: [] + QuickBooks Online: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + required: true + depositedRecordRefs: + type: Array + displayName: Deposited Record References + description: A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer. + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: payments + type: String + displayName: Payments + required: false + - value: directIncomes + type: String + displayName: DirectIncomes + required: false + - value: journalEntries + type: String + displayName: JournalEntries + required: false + required: true + required: false + required: true + validation: + warnings: + - details: 'When pushing a transfer using two different currencies, the exchange rate will be calculated and passed to QuickBooks, QuickBooks performs rounding on this value which may affect the values in the transfer' + - details: Transfers between accounts in different currencies can only be made if multi-currency is enabled for company + - details: The currency of at least one of the accounts used must be the same as the company's currency + information: [] + Sage Business Cloud Accounting: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + validation: + warnings: + - field: Description + details: Must be provided if pushing a bank deposit. + information: + - field: Description + details: Must not be longer than 2000 characters. + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + validation: + warnings: [] + information: + - field: Date + details: Must be provided. + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: Must be different from To.AccountRef.Id. + - field: AccountRef.Id + details: Must match the ID of an existing bank account in the company's base currency. + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: [] + information: + - field: From.Amount + details: Must be equal to To.Amount. + - field: From.Amount + details: Must be greater than zero. + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: Must be different from From.AccountRef.Id. + - field: AccountRef.Id + details: Must match the ID of an existing bank account in the company's base currency. + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: [] + information: + - field: To.Amount + details: Must be equal to From.Amount. + - field: To.Amount + details: Must be greater than zero. + required: true + required: true + Sandbox: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: true + contactRef: + type: Object + displayName: Contact Reference + description: The customer or supplier for this transfer if known + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + status: + type: String + displayName: Status + description: The status of the transfer in the account + required: true + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + status: + type: String + displayName: Status + description: The status of the transfer in the account + required: true + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this transfer is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + name: + type: String + displayName: Tracking Category Name + description: The name of the category referenced by the identifier + required: true + required: true + depositedRecordRefs: + type: Array + displayName: Deposited Record References + description: A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer. + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + Xero: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank account. + information: [] + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: From.Amount + details: Must be equal to To.Amount. + - field: From.Amount + details: Must be greater than zero. + information: [] + status: + type: String + displayName: Status + description: The status of the transfer in the account + options: + - value: Unknown + type: String + displayName: Unknown + required: false + - value: Unreconciled + type: String + displayName: Unreconciled + required: false + - value: Reconciled + type: String + displayName: Reconciled + required: false + required: true + validation: + warnings: [] + information: + - field: From.Status + details: Must be provided. + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank account. + information: [] + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: To.Amount + details: Must be equal to From.Amount. + - field: To.Amount + details: Must be greater than zero. + information: [] + status: + type: String + displayName: Status + description: The status of the transfer in the account + options: + - value: Unknown + type: String + displayName: Unknown + required: false + - value: Unreconciled + type: String + displayName: Unreconciled + required: false + - value: Reconciled + type: String + displayName: Reconciled + required: false + required: true + validation: + warnings: [] + information: + - field: To.Status + details: Must be provided. + required: true + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-transfers-model + x-speakeasy-group: loan-writeback.transfers + description: | + The *Get create transfer model* endpoint returns the expected data for the request payload when creating a [transfer](https://docs.codat.io/lending-api#/schemas/Transfer) for a given company and integration. + + [Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. + + **Integration-specific behavior** + + See the *response examples* for integration-specific indicative models. + '/companies/{companyId}/connections/{connectionId}/push/transfers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + summary: Create transfer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingTransfer' + examples: + QuickBooks Desktop: + value: + description: test transfers push 20230126 12.08 + contactRef: + id: 80000028-167239230944 + dataType: customers + date: '2023-01-26T11:51:18.104Z' + from: + accountRef: + id: 80000028-1671794219 + dataType: bankAccounts + amount: 12 + to: + accountRef: + id: 80000004-1671793811 + dataType: bankAccounts + amount: 12 + status: Unknown + trackingCategoryRefs: + - id: 80000001-1674553252 + name: Class 1 + metadata: + isDeleted: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateTransferResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Create transfer* endpoint creates a new [transfer](https://docs.codat.io/lending-api#/schemas/Transfer) for a given company's connection. + + [Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create transfer model](https://docs.codat.io/lending-api#/operations/get-create-transfers-model). + operationId: create-transfer + x-speakeasy-group: loan-writeback.transfers + '/companies/{companyId}/connections/{connectionId}/options/bankAccounts/{accountId}/bankTransactions': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingAccountId' + get: + tags: + - Loan writeback + summary: Get create bank account transactions model + description: |- + The *Get create bank account transactions model* endpoint returns the expected data for the request payload when creating [bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) for a given company and integration. + + [Bank account transactions](https://docs.codat.io/lending-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 + x-speakeasy-group: loan-writeback.bank-transactions + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/push/bankAccounts/{accountId}/bankTransactions': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingAccountId' + post: + tags: + - Loan writeback + summary: Create bank account transactions + description: | + The *Create bank account transactions* endpoint creates new [bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) for a given company's connection. + + [Bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create bank transaction model](https://docs.codat.io/lending-api#/operations/get-create-bankTransactions-model). + operationId: create-bank-transactions + x-speakeasy-group: loan-writeback.bank-transactions + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateBankTransactions' + examples: {} + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateBankTransactionsResponse' + 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}/options/directCosts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create direct cost model + tags: + - Loan writeback + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + Dynamics 365 Business Central: + value: + type: Object + displayName: Direct Cost + description: '' + properties: + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: false + validation: + warnings: [] + information: + - field: Note + details: is not supported and will be ignored + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + required: false + validation: + warnings: [] + information: + - field: ContactRef + details: is not supported and will be ignored + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + validation: + warnings: [] + information: + - field: Currency + details: 'If unspecified, base currency is assumed. Must agree with the bank account in PaymentAllocations' + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + validation: + warnings: [] + information: + - field: CurrencyRate + details: Required if the currency is not the base currency + subTotal: + type: Number + displayName: Sub Total Amount + description: The total amount of the direct transaction excluding any taxes + required: false + validation: + warnings: [] + information: + - field: SubTotal + details: is not supported and will be ignored + taxAmount: + type: Number + displayName: Tax Amount + description: The total amount of tax on the direct transaction + required: false + validation: + warnings: [] + information: + - field: TaxAmount + details: is not supported and will be ignored + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: false + validation: + warnings: [] + information: + - field: TotalAmount + details: is not supported and will be ignored + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: false + validation: + warnings: [] + information: + - field: LineItems.UnitAmount + details: is not supported and will be ignored + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: false + validation: + warnings: [] + information: + - field: LineItems.Quantity + details: is not supported and will be ignored + discountAmount: + type: Number + displayName: Discount Amount + description: 'The value, in the given currency, of any discounts applied' + required: false + validation: + warnings: [] + information: + - field: LineItems.DiscountAmount + details: is not supported and will be ignored + discountPercentage: + type: Number + displayName: Discount Percentage + description: The percentage rate of any discount that has been applied + required: false + validation: + warnings: [] + information: + - field: LineItems.DiscountPercentage + details: is not supported and will be ignored + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: false + validation: + warnings: [] + information: + - field: LineItems.SubTotal + details: Required if totalAmount is not specified + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: false + validation: + warnings: [] + information: + - field: LineItems.TaxAmount + details: is not supported and will be ignored + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + validation: + warnings: [] + information: + - field: LineItems.TotalAmount + details: Required if subTotal is not specified + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + name: + type: String + displayName: Name + description: Name of the account + required: false + validation: + warnings: [] + information: + - field: AccountRef.Name + details: is not supported and will be ignored + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + name: + type: String + displayName: Name + description: The name of the tax rate referenced by the identifier + required: false + validation: + warnings: [] + information: + - field: TaxRateRef.Name + details: is not supported and will be ignored + effectiveTaxRate: + type: Number + displayName: Effective Tax Rate + description: 'The total applied tax percentage, including compounding details' + required: false + validation: + warnings: [] + information: + - field: TaxRateRef.EffectiveTaxRate + details: is not supported and will be ignored + required: true + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + required: false + validation: + warnings: [] + information: + - field: LineItems.ItemRef + details: is not supported and will be ignored + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + required: false + validation: + warnings: [] + information: + - field: LineItems.TrackingCategoryRefs + details: is not supported and will be ignored + required: true + validation: + warnings: + - field: LineItems + details: Only one line is supported + information: [] + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + name: + type: String + displayName: Name + description: Name of the account + required: false + validation: + warnings: [] + information: + - field: AccountRef.Name + details: is not supported and will be ignored + required: true + currency: + type: String + displayName: Currency + description: The currency for the payment + required: false + validation: + warnings: [] + information: + - field: Payment.Currency + details: is not supported and will be ignored + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the base company + required: false + validation: + warnings: [] + information: + - field: Payment.CurrencyRate + details: is not supported and will be ignored + paidOnDate: + type: DateTime + displayName: Paid On Date + description: The date the payment was paid + required: false + validation: + warnings: [] + information: + - field: Payment.PaidOnDate + details: is not supported and will be ignored + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: false + validation: + warnings: [] + information: + - field: Payment.TotalAmount + details: is not supported and will be ignored + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: false + validation: + warnings: [] + information: + - field: Allocation.Currency + details: is not supported and will be ignored + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the transaction + required: false + validation: + warnings: [] + information: + - field: Allocation.CurrencyRate + details: is not supported and will be ignored + allocatedOnDate: + type: DateTime + displayName: Allocated On Date + description: The date the payment was allocated + required: false + validation: + warnings: [] + information: + - field: Allocation.AllocatedOnDate + details: is not supported and will be ignored + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: false + validation: + warnings: [] + information: + - field: Allocation.TotalAmount + details: is not supported and will be ignored + required: true + required: true + validation: + warnings: + - field: PaymentAllocations + details: Only one line is supported + information: [] + required: true + FreeAgent: + value: + type: Object + displayName: Direct Cost + description: '' + properties: + id: + type: String + displayName: Unique Direct Transaction ID + description: 'The identifier for the direct transaction, unique to the company' + required: false + validation: + warnings: + - field: Id + details: 'will be ignored on push. ' + information: [] + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + validation: + warnings: + - field: Reference + details: 'is not supported by FreeAgent and will not be mapped. ' + information: [] + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: true + validation: + warnings: [] + information: + - field: Note + details: must be provided + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: false + validation: + warnings: + - field: ContactRef.Id + details: 'is not supported by FreeAgent and will be ignored on push. ' + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: false + validation: + warnings: + - field: ContactRef.DataType + details: 'is not supported by FreeAgent and will be ignored on push. ' + information: [] + required: false + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + validation: + warnings: [] + information: + - field: IssueDate + details: must be provided + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + validation: + warnings: + - field: CurrencyRate + details: 'will be ignored on push. ' + information: [] + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + validation: + warnings: + - field: LineItems.Description + details: 'If a Note is provided, this field will be ignored on push. ' + information: [] + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: false + validation: + warnings: + - field: LineItems.UnitAmount + details: 'will be ignored on push. ' + information: [] + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: false + validation: + warnings: + - field: LineItems.Quantity + details: 'will be ignored on push. ' + information: [] + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: false + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: must be provided + name: + type: String + displayName: Name + description: Name of the account + required: false + validation: + warnings: + - field: AccountRef.Name + details: 'will be ignored on push. ' + information: [] + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: false + validation: + warnings: + - field: TaxRateRef.Id + details: 'will be ignored on push. ' + information: [] + name: + type: String + displayName: Name + description: The name of the tax rate referenced by the identifier + required: false + validation: + warnings: + - field: TaxRateRef.Name + details: 'will be ignored on push. ' + information: [] + effectiveTaxRate: + type: Number + displayName: Effective Tax Rate + description: 'The total applied tax percentage, including compounding details' + required: false + validation: + warnings: + - field: TaxRateRef.EffectiveTaxRate + details: 'will be ignored on push. ' + information: [] + required: false + required: true + validation: + warnings: + - field: LineItems + details: Exactly one line item must be specified + information: [] + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + id: + type: String + displayName: Identifier + description: The identifier for the allocated payment + required: false + note: + type: String + displayName: Note + description: Any additional text based information associated with the allocated payment + required: false + reference: + type: String + displayName: Reference + description: Reference associated with the allocated payment + required: false + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: must be provided + name: + type: String + displayName: Name + description: Name of the account + required: false + validation: + warnings: + - field: AccountRef.Name + details: 'will be ignored on push. ' + information: [] + required: true + currency: + type: String + displayName: Currency + description: The currency for the payment + required: false + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the base company + required: false + paidOnDate: + type: DateTime + displayName: Paid On Date + description: The date the payment was paid + required: false + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: false + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: false + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the transaction + required: false + allocatedOnDate: + type: DateTime + displayName: Allocated On Date + description: The date the payment was allocated + required: false + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: false + required: false + required: true + subTotal: + type: Number + displayName: Sub Total Amount + description: The total amount of the direct transaction excluding any taxes + required: false + taxAmount: + type: Number + displayName: Tax Amount + description: The total amount of tax on the direct transaction + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: false + modifiedDate: + type: DateTime + displayName: Modified Date + description: The date the record was last updated in the system cache + required: false + validation: + warnings: + - field: ModifiedDate + details: 'will be ignored on push. ' + information: [] + sourceModifiedDate: + type: DateTime + displayName: Source Modified Date + description: The date the record was last changed in the originating system + required: false + validation: + warnings: + - field: SourceModifiedDate + details: 'will be ignored on push. ' + information: [] + required: true + Oracle NetSuite: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: false + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: true + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: false + validation: + warnings: [] + information: + - field: LineItems.UnitAmount + details: Should have the same sign across all line items + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: false + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: false + validation: + warnings: + - field: LineItems.AccountRef + details: Should not be a bank account + - field: LineItems.AccountRef + details: Should only be specified when pushing an expense + information: [] + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the item + required: true + required: false + validation: + warnings: + - field: LineItems.ItemRef + details: Should only be specified when pushing an item (not an expense) + information: [] + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + required: false + validation: + warnings: + - field: LineItems.TaxRateRef + details: Should be specified when item type is not 'Discount' + information: [] + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + required: false + required: true + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing account of type 'Bank' OR type 'Credit Card' + information: [] + required: true + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + required: true + required: true + validation: + warnings: [] + information: + - field: PaymentAllocations + details: Must contain a single allocation + required: true + QuickBooks Desktop: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + validation: + warnings: + - field: Reference + details: Represents the check number + information: [] + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: false + validation: + warnings: + - field: Note + details: Max length of 4096 characters. + information: [] + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + required: false + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + validation: + warnings: + - field: Currency + details: Must be a three letter ISO code + - field: Currency + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + information: + - field: Currency + details: 'If not set, will default to the default currency' + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + validation: + warnings: [] + information: + - field: CurrencyRate + details: 'If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1.' + - field: CurrencyRate + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: true + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: true + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: false + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: true + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + required: true + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + required: true + required: true + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + id: + type: String + displayName: Identifier + description: The identifier for the allocated payment + required: true + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + required: true + validation: + warnings: [] + information: + - field: Payment.AccountRef + details: The account in which to make the deposit + reference: + type: String + displayName: Reference + description: Reference associated with the allocated payment + required: false + validation: + warnings: [] + information: + - field: Payment.Reference + details: Use to reference the check number of this deposit. + note: + type: String + displayName: Note + description: Any additional text based information associated with the allocated payment + required: true + currency: + type: String + displayName: Currency + description: The currency for the payment + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the base company + required: true + paidOnDate: + type: DateTime + displayName: Paid On Date + description: The date the payment was paid + required: true + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: true + required: true + required: true + validation: + warnings: + - field: PaymentAllocations + details: Must contain a single payment allocation + information: [] + taxAmount: + type: Number + displayName: Tax Amount + description: The total amount of tax on the direct transaction + required: true + subTotal: + type: Number + displayName: Sub Total Amount + description: The total amount of the direct transaction excluding any taxes + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: false + sourceModifiedDate: + type: DateTime + displayName: Source Modified Date + description: The date the record was last changed in the originating system + required: false + modifiedDate: + type: DateTime + displayName: Modified Date + description: The date the record was last updated in the system cache + required: false + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: Suppliers + type: String + displayName: Suppliers + required: false + required: true required: true - accountNumber: + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: false + validation: + warnings: [] + information: + - field: IssueDate + details: 'If the issue date is not supplied, the current date on the server is used.' + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + reference: type: String - displayName: Account Number - description: The account number for the bank account + displayName: Reference + description: User friendly reference for the direct transaction + required: false + validation: + warnings: + - field: Reference + details: Must be less than 22 characters. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + validation: + warnings: [] + information: + - field: Currency + details: Required if multi-currency is enabled for the company. + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: false + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: false + validation: + warnings: + - field: Allocation.TotalAmount + details: Must match the sum of the line items + information: [] + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: false + validation: + warnings: + - field: Allocation.Currency + details: Must match the Currency of the company + information: [] + required: false + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: false + validation: + warnings: + - field: Payment.TotalAmount + details: Must match the sum of the line items + information: [] + currency: + type: String + displayName: Currency + description: The currency for the payment + required: false + validation: + warnings: + - field: Payment.Currency + details: Must match the Currency of the company + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: 'Must be Bank, Cash or Asset account' + required: true + required: true + required: true + validation: + warnings: + - field: PaymentAllocations + details: Must have exactly one payment allocation. + information: [] + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + validation: + warnings: + - field: TrackingCategoryRefs.TrackingCategoryRefs + details: Must be a valid Id + information: [] + required: false + validation: + warnings: + - field: LineItems.TrackingCategoryRefs + details: Only one tracking category of type CLASS can be provided per item. + - field: LineItems.TrackingCategoryRefs + details: Only one tracking category of type DEPARTMENT can be provided per invoice. + - field: LineItems.TrackingCategoryRefs + details: All DEPARTMENT tracking categories must be the same + information: [] + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be an Expense or Income account + information: [] + required: false + validation: + warnings: + - field: LineItems.AccountRef + details: Must be set if ItemRef is not + information: [] + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the item + required: true + required: false + validation: + warnings: + - field: LineItems.ItemRef + details: Must be set if AccountRef is not + information: [] + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + validation: + warnings: + - field: LineItems.Description + details: Must be less than 4000 characters. + information: [] + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: true + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: false + validation: + warnings: + - field: LineItems.TaxAmount + details: Must be specified on all line items or none. If specified will override QBO tax calculations. + information: [] + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + validation: + warnings: [] + information: + - field: TaxRateRef.Id + details: 'If an organisation has Automated Sales Tax enabled for US locales, then only ''TAX'' (Automated Sales Tax) or ''NON'' (no tax) can be used. If Automated Sales Tax is disabled for US locales then ''TAX'' (Automated Sales Tax) will not be accepted and a different tax rate must be used.' + required: false + validation: + warnings: + - field: LineItems.TaxRateRef + details: Required for all companies except QuickBooks Online France companies. + information: [] + required: true + required: true + QuickBooks Online: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: Suppliers + type: String + displayName: Suppliers + required: false + required: true + required: true + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: false + validation: + warnings: [] + information: + - field: IssueDate + details: 'If the issue date is not supplied, the current date on the server is used.' + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + validation: + warnings: + - field: Reference + details: Must be less than 22 characters. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + validation: + warnings: [] + information: + - field: Currency + details: Required if multi-currency is enabled for the company. + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: false + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: false + validation: + warnings: + - field: Allocation.TotalAmount + details: Must match the sum of the line items + information: [] + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: false + validation: + warnings: + - field: Allocation.Currency + details: Must match the Currency of the company + information: [] + required: false + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: false + validation: + warnings: + - field: Payment.TotalAmount + details: Must match the sum of the line items + information: [] + currency: + type: String + displayName: Currency + description: The currency for the payment + required: false + validation: + warnings: + - field: Payment.Currency + details: Must match the Currency of the company + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: 'Must be Bank, Cash or Asset account' + required: true + required: true + required: true + validation: + warnings: + - field: PaymentAllocations + details: Must have exactly one payment allocation. + information: [] + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + validation: + warnings: + - field: TrackingCategoryRefs.TrackingCategoryRefs + details: Must be a valid Id + information: [] + required: false + validation: + warnings: + - field: LineItems.TrackingCategoryRefs + details: Only one tracking category of type CLASS can be provided per item. + - field: LineItems.TrackingCategoryRefs + details: Only one tracking category of type DEPARTMENT can be provided per invoice. + - field: LineItems.TrackingCategoryRefs + details: All DEPARTMENT tracking categories must be the same + information: [] + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be an Expense or Income account + information: [] + required: false + validation: + warnings: + - field: LineItems.AccountRef + details: Must be set if ItemRef is not + information: [] + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the item + required: true + required: false + validation: + warnings: + - field: LineItems.ItemRef + details: Must be set if AccountRef is not + information: [] + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + validation: + warnings: + - field: LineItems.Description + details: Must be less than 4000 characters. + information: [] + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: true + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: false + validation: + warnings: + - field: LineItems.TaxAmount + details: Must be specified on all line items or none. If specified will override QBO tax calculations. + information: [] + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + validation: + warnings: [] + information: + - field: TaxRateRef.Id + details: 'If an organisation has Automated Sales Tax enabled for US locales, then only ''TAX'' (Automated Sales Tax) or ''NON'' (no tax) can be used. If Automated Sales Tax is disabled for US locales then ''TAX'' (Automated Sales Tax) will not be accepted and a different tax rate must be used.' + required: false + validation: + warnings: + - field: LineItems.TaxRateRef + details: Required for all companies except QuickBooks Online France companies. + information: [] + required: true + required: true + Sage 50 (UK): + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + reference: + type: String + displayName: Reference + description: The user reference for this direct cost. + required: false + issueDate: + type: Number + displayName: Issue Date + description: The date this payment was issued. + required: true + currency: + type: String + displayName: Currency + description: The currency in which the direct cost is issued in. + required: true + validation: + warnings: + - field: currency + details: This must match the target account's default currency. + information: [] + currencyRate: + type: Number + displayName: Currency Rate + description: The currency rate associated with this transaction. + required: true + accountRef: + type: Object + displayName: Bank Account + description: The bank account to pay this direct cost from. + properties: + id: + type: String + displayName: Account Id + description: Nominal code of the bank account. + required: true + validation: + warnings: + - field: accountRef.id + details: Must match the ID of an existing bank account and have a max length of 8 characters. + information: [] + required: true + subTotal: + type: Number + displayName: Sub Total + description: The net amount being paid in this direct cost. + required: true + validation: + warnings: [] + information: + - details: This must equal the sum of the line net amounts + taxAmount: + type: Number + displayName: Tax Amount + description: The tax amount being paid in this direct cost. + required: true + validation: + warnings: [] + information: + - details: This must equal the sum of the line tax amounts + totalAmount: + type: Number + displayName: Total Amount + description: The total amount being paid in this direct cost. + required: true + validation: + warnings: [] + information: + - details: This must equal the sum of the line amounts + lineItems: + type: Array + displayName: Line Items + description: Line items of the direct cost. + properties: + description: + type: String + displayName: description + description: Description of the direct cost line item. + required: false + accountRef: + type: Object + displayName: Nominal Code + description: Target bank account for the direct cost line item. + properties: + id: + type: String + displayName: Id + description: The ID of the Account the line is linked to. + required: true + required: true + unitAmount: + type: Number + displayName: Unit Amount + description: Unit amount for the direct cost line item. + required: true + validation: + warnings: + - field: LineItems.unitAmount + details: Cannot equal 0 and will be set to Net amount if not provided accordingly. + information: [] + quantity: + type: Number + displayName: Quantity + description: Quantity for the direct cost line item. + required: true + validation: + warnings: + - field: LineItems.quantity + details: Must be 1 or -1. + information: [] + subTotal: + type: Number + displayName: Net Amount + description: 'Amount for the direct cost line item. Debit entries are considered positive, and credit entries are considered negative.' + required: true + validation: + warnings: + - field: LineItems.subTotal + details: Cannot have both subtotal and tax amount as 0 for line item. + information: [] + taxAmount: + type: Number + displayName: Tax Amount + description: Tax amount for the direct cost line item. + required: false + validation: + warnings: + - field: LineItems.taxAmount + details: Cannot have both tax amount and subtotal as 0 for line item. + information: [] + totalAmount: + type: Number + displayName: Total Amount + description: Total amount for the direct cost line item. + required: false + validation: + warnings: [] + information: + - field: LineItems.totalAmount + details: Will be auto populated using tax amount and net amount. + taxCode: + type: Number + displayName: Tax Code Id + description: The tax code ID associated with this transaction. + required: true + trackingCategoryRefs: + type: Object + displayName: Tracking Category References + description: Tracking categories associated with this transaction. + properties: + id: + type: String + displayName: Id + description: The ID of the tracking category associated with the transaction + required: true + validation: + warnings: + - field: id + details: 'A department is required. If a project reference is provided, the cost code for that project must also be provided.' + information: [] + required: true + required: true + required: true + validation: + warnings: [] + information: + - details: 'Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company.' + Sage Intacct: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: true + validation: + warnings: [] + information: + - field: Note + details: Must be used to provide payee's name and contain no more than 80 characters. + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + validation: + warnings: [] + information: + - field: TaxRateRef.Id + details: Must be an existing tax rate in Sage Intacct. + required: true + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: true + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + validation: + warnings: [] + information: + - field: LineItems.Description + details: Must not contain no more than 1000 characters. + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: false + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: false + name: + type: String + displayName: Tracking Category Name + description: The name of the category referenced by the identifier + required: false + required: false + required: true + validation: + warnings: [] + information: + - field: LineItems + details: Must contain at least one line item. + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + paidOnDate: + type: DateTime + displayName: Paid On Date + description: The date the payment was paid + required: true + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: true + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: false + validation: + warnings: [] + information: + - field: Payment.TotalAmount + details: 'If provided, must match the sum of the line items.' + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: false + validation: + warnings: [] + information: + - field: Allocation.TotalAmount + details: 'If provided, must match the sum of the line items.' + required: true + required: true + validation: + warnings: [] + information: + - field: PaymentAllocations + details: Must contain a single allocation. + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + validation: + warnings: + - field: Currency + details: When supplying a currency ensure that it exists in your Sage Intacct entity otherwise the request will fail. + information: [] + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + validation: + warnings: [] + information: + - field: Reference + details: Must not contain no more than 45 characters. + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: false + validation: + warnings: [] + information: + - field: TotalAmount + details: 'If provided, must match the sum of the line items.' + required: true + Sandbox: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: true + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: true + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: true + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: true + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + name: + type: String + displayName: Name + description: Name of the account + required: true + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + name: + type: String + displayName: Name + description: The name of the tax rate referenced by the identifier + required: true + effectiveTaxRate: + type: Number + displayName: Effective Tax Rate + description: 'The total applied tax percentage, including compounding details' + required: true + required: true + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: true + discountAmount: + type: Number + displayName: Discount Amount + description: 'The value, in the given currency, of any discounts applied' + required: true + discountPercentage: + type: Number + displayName: Discount Percentage + description: The percentage rate of any discount that has been applied + required: true + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: true + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: true + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: true + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the item + required: true + name: + type: String + displayName: Name + description: The name of the item referenced by the identifier + required: true + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + name: + type: String + displayName: Tracking Category Name + description: The name of the category referenced by the identifier + required: true + required: true + tracking: + type: Object + displayName: Tracking + description: Information this item is being tracked against + properties: + recordRefs: + type: Array + displayName: Record References + description: A collection of records this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + invoiceTo: + type: Object + displayName: Invoice To + description: The entity the record should be invoiced to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + required: true + required: true + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + id: + type: String + displayName: Identifier + description: The identifier for the allocated payment + required: true + note: + type: String + displayName: Note + description: Any additional text based information associated with the allocated payment + required: true + reference: + type: String + displayName: Reference + description: Reference associated with the allocated payment + required: true + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + name: + type: String + displayName: Name + description: Name of the account + required: true + required: true + currency: + type: String + displayName: Currency + description: The currency for the payment + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the base company + required: true + paidOnDate: + type: DateTime + displayName: Paid On Date + description: The date the payment was paid + required: true + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: true + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the transaction + required: true + allocatedOnDate: + type: DateTime + displayName: Allocated On Date + description: The date the payment was allocated + required: true + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: true + required: true + required: true + subTotal: + type: Number + displayName: Sub Total Amount + description: The total amount of the direct transaction excluding any taxes + required: true + taxAmount: + type: Number + displayName: Tax Amount + description: The total amount of tax on the direct transaction + required: true + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + Xero: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued required: true validation: - warnings: - - field: AccountNumber - details: Should not exceed the maximum length of 14 characters if the specified currency is GBP. - information: [] - sortCode: + warnings: [] + information: + - field: IssueDate + details: Must be provided. + reference: type: String - displayName: Sort Code - description: The sort code for the bank account + displayName: Reference + description: User friendly reference for the direct transaction 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: [] + warnings: [] + information: + - field: Reference + details: Must not exceed 255 characters. 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 + description: The currency of the direct transaction + required: true + validation: + warnings: [] + information: + - field: Currency + details: Must be provided. + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company required: false + taxAmount: + type: Number + displayName: Tax Amount + description: The total amount of tax on the direct transaction + required: true + validation: + warnings: [] + information: + - field: TaxAmount + details: Must be provided. + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: true + validation: + warnings: [] + information: + - field: TotalAmount + details: Must be provided. + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: ContactRef.Id + details: Must be a valid GUID. + - field: ContactRef.Id + details: Must match the ID of an existing contact. + information: + - field: ContactRef.Id + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: ContactRef + details: Must be provided. + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be a bank account. + - field: AccountRef.Id + details: Must match the ID of an existing bank account. + information: + - field: AccountRef.Id + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: Payment.AccountRef + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: PaymentAllocations.Payment + details: Must be provided. + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: true + validation: + warnings: + - field: Allocation.TotalAmount + details: Must be equal to the sum of line items. + information: + - field: Allocation.TotalAmount + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: PaymentAllocations.Allocation + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: PaymentAllocations + details: Must be provided. + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: true + validation: + warnings: [] + information: + - field: LineItems.Description + details: Must not be longer than 4000 characters long. + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: true + validation: + warnings: [] + information: + - field: LineItems.Quantity + details: Must be provided. + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + validation: + warnings: [] + information: + - field: LineItems.UnitAmount + details: Must be provided. + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + validation: + warnings: + - field: LineItems.TotalAmount + details: 'When negative, the push item will be converted to a DirectIncome and will be pushed accordingly.' + information: + - field: LineItems.TotalAmount + details: 'When one line is negative, all lines must be negative.' + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: true + validation: + warnings: [] + information: + - field: LineItems.TaxAmount + details: Must be provided. + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be a valid GUID. + - field: AccountRef.Id + details: Must match the ID of an existing account. + information: + - field: AccountRef.Id + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: LineItems.AccountRef + details: Must be provided. + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + validation: + warnings: [] + information: + - field: TrackingCategoryRefs.Id + details: Must be provided. + required: false + validation: + warnings: [] + information: + - field: LineItems.TrackingCategoryRefs + details: Tracking categories must not have the same parent tracking category. + - field: LineItems.TrackingCategoryRefs + details: Maximum of 2 Tracking Categories. + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: false + validation: + warnings: + - field: TaxRateRef.Id + details: Must match the ID of an existing tax rate. + information: + - field: TaxRateRef.Id + details: 'If not provided, will be set to the default tax rate for the line''s account.' + required: false + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the item + required: false + validation: + warnings: + - field: ItemRef.Id + details: Must be a valid GUID. + - field: ItemRef.Id + details: Must match the ID of an existing item. + information: [] + required: false + required: true + validation: + warnings: [] + information: + - field: LineItems + details: Must be provided. required: true - Exact (UK): + validation: + warnings: + - details: 'When negative, the push item will be converted to a DirectIncome and will be pushed accordingly.' + information: [] + Zoho Books: value: type: Object - displayName: Bank Account - description: An account that bank transactions may be recorded against + displayName: Direct Cost + description: Direct Cost properties: - accountName: + reference: type: String - displayName: Name - description: The name of the bank account in the originating system - required: true - accountNumber: + displayName: Reference + description: User friendly reference for the direct transaction + required: false + note: type: String - displayName: Account Number - description: The account number for the bank account + displayName: Note + description: The note attached to the direct transaction + required: false + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: false + required: false validation: - warnings: - - field: AccountNumber - details: Should not exceed the maximum length of 14 characters if the specified currency is GBP. - information: [] - sortCode: + warnings: [] + information: + - field: ContactRef + details: Required when pushing a negative direct cost & should reference either a Customer or Supplier when provided + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + validation: + warnings: [] + information: + - field: LineItems.TotalAmount + details: Should be provided when SubTotal is not provided + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: false + validation: + warnings: [] + information: + - field: LineItems.SubTotal + details: Should be provided when TotalAmount is not provided + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: false + required: false + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + required: false + required: true + currency: type: String - displayName: Sort Code - description: The sort code for the bank account + displayName: Currency + description: The currency of the direct transaction required: false + validation: + warnings: [] + information: + - field: Currency + details: Is required when pushing a negative direct cost + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + currency: + type: String + displayName: Currency + description: The currency for the payment + required: false + validation: + warnings: [] + information: + - field: Payment.Currency + details: Is required when pushing a negative direct cost + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: true + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: false + validation: + warnings: [] + information: + - field: Allocation.Currency + details: Is required when pushing a negative direct cost + required: true + required: true + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-directCosts-model + x-speakeasy-group: loan-writeback.direct-costs + description: | + The *Get create direct cost model* endpoint returns the expected data for the request payload when creating a [direct cost](https://docs.codat.io/lending-api#/schemas/DirectCost) for a given company and integration. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + + **Integration-specific behavior** + + See the *response examples* for integration-specific indicative models. + '/companies/{companyId}/connections/{connectionId}/push/directCosts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + summary: Create direct cost + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingDirectCost/definitions/directCostPrototype' + examples: + QuickBooks Desktop: + value: + reference: test ref + note: directCost 21/03 09.20 + contactRef: + id: 80000001-1671793885 + dataType: suppliers + issueDate: '2023-03-21T10:19:52.223Z' + currency: USD + lineItems: + - description: test description line 1 + unitAmount: 7 + quantity: 1 + discountAmount: 0 + discountPercentage: 0 + subTotal: 99 + taxAmount: 360 + totalAmount: 70 + accountRef: + id: 8000000D-1671793811 + name: Purchases - Hardware for Resale + itemRef: + id: 80000001-1674566705 + name: item test + trackingCategoryRefs: + - id: 80000001-1674553252 + name: Class 1 + paymentAllocations: + - payment: + note: payment allocations note + reference: payment allocations reference + accountRef: + id: 80000028-1671794219 + name: Bank Account 1 + paidOnDate: '2023-01-28T10:19:52.223Z' + totalAmount: 54 + allocation: + currencyRate: 0 + allocatedOnDate: '2023-01-29T10:19:52.223Z' + totalAmount: 88 + subTotal: 362 + taxAmount: 4 + totalAmount: 366 + Xero: + value: + reference: Scenario One neg DC + contactRef: + id: 699f0091-b127-4796-9f15-41a2f42abeb2 + dataType: suppliers + issueDate: '2023-02-25' + currency: GBP + lineItems: + - description: negative direct cost + unitAmount: 35 + quantity: -1 + subTotal: -35 + taxAmount: -7 + totalAmount: -42 + itemRef: + id: 965cfc0e-4d80-4059-9641-4a392f9ad549 + taxRateRef: + id: INPUT2 + paymentAllocations: + - payment: + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + currency: GBP + allocation: + totalAmount: -42 + subTotal: -35 + taxAmount: -7 + totalAmount: -42 + FreeAgent: + value: + issueDate: '2023-02-12' + currency: GBP + lineItems: + - unitAmount: 15 + quantity: 1 + subTotal: 15 + accountRef: + id: '288' + paymentAllocations: + - payment: + accountRef: + id: 750-1 + allocation: {} + subTotal: 15 + taxAmount: 0 + totalAmount: 15 + Sage Intacct: + value: + reference: test ref + note: Test 1 + issueDate: '2023-03-31T00:00:00' + currency: USD + currencyRate: 0.5 + lineItems: + - accountRef: + id: '195' + unitAmount: 9.99 + quantity: 1 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + paymentAllocations: + - payment: + id: '4355' + note: test note + reference: test reference + accountRef: + id: '348' + name: CMRR Renewal + currency: USD + paidOnDate: '2023-03-31T00:00:00' + totalAmount: 11.99 + allocation: + currency: USD + allocatedOnDate: '2023-03-31T00:00:00' + totalAmount: 11.99 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateDirectCostResponse' + examples: + FreeAgent: + value: + changes: [] + data: + id: '372060709' + issueDate: '2023-02-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '288' + unitAmount: 15 + quantity: 1 + subTotal: 15 + taxAmount: 3 + totalAmount: 18 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '372060709' + accountRef: + id: 750-1 + currency: GBP + paidOnDate: '2023-02-12T00:00:00' + totalAmount: 18 + allocation: + currency: GBP + allocatedOnDate: '2023-02-12T00:00:00' + totalAmount: 18 + subTotal: 15 + taxAmount: 3 + totalAmount: 18 + sourceModifiedDate: '2023-02-12T15:15:53Z' + dataType: directCosts + companyId: a23f79d6-7cc9-486c-b388-8ab88faea947 + pushOperationKey: 0659a24d-2b66-4979-971e-4b98c3ed7f61 + dataConnectionKey: 35e38cd5-66ea-41b8-b555-9efd5b792b68 + requestedOnUtc: '2023-02-12T15:15:51.1723204Z' + completedOnUtc: '2023-02-12T15:15:54.7161036Z' + status: Success + statusCode: 200 + Sage Intacct: + value: + changes: + - type: Created + recordRef: + dataType: directCosts + data: + reference: test ref + note: Test 1 + issueDate: '2023-03-31T00:00:00' + currency: USD + currencyRate: 0.5 + lineItems: + - accountRef: + id: '195' + taxRateRef: + id: '95' + unitAmount: 9.99 + quantity: 1 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '4355' + note: test note + reference: test reference + accountRef: + id: '348' + name: CMRR Renewal + currency: USD + paidOnDate: '2023-03-31T00:00:00' + totalAmount: 11.99 + allocation: + currency: USD + allocatedOnDate: '2023-03-31T00:00:00' + totalAmount: 11.99 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + dataType: directCosts + companyId: d7f743a9-1804-4116-8c8a-e606f7e2f66c + pushOperationKey: 0d74c1ad-00ad-4731-9e6e-98a86056959a + dataConnectionKey: fa139396-523a-4a58-bf2b-8da82c8a673f + requestedOnUtc: '2023-03-31T12:49:51.6503324Z' + status: Pending + statusCode: 202 + Xero: + value: + changes: [] + data: + reference: Scenario One neg DC + contactRef: + id: 699f0091-b127-4796-9f15-41a2f42abeb2 + dataType: suppliers + issueDate: '2023-02-25T00:00:00' + currency: GBP + lineItems: + - description: negative direct cost + taxRateRef: + id: INPUT2 + unitAmount: 35 + quantity: -1 + subTotal: -35 + taxAmount: -7 + totalAmount: -42 + itemRef: + id: 965cfc0e-4d80-4059-9641-4a392f9ad549 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + currency: GBP + paidOnDate: '0001-01-01T00:00:00' + totalAmount: 0 + allocation: + totalAmount: -42 + subTotal: 0 + taxAmount: -7 + totalAmount: -42 + dataType: directCosts + companyId: b5efee61-3fab-4a5d-9247-de03d6eda6db + pushOperationKey: 33347930-fcc5-4f95-aa13-4a0f7291b559 + dataConnectionKey: 1e355304-4476-422e-95cb-fa2a6d47fab4 + requestedOnUtc: '2023-02-24T13:43:26.5109173Z' + status: Pending + validation: + errors: [] + warnings: [] + statusCode: 202 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Create direct cost* endpoint creates a new [direct cost](https://docs.codat.io/lending-api#/schemas/DirectCost) for a given company's connection. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create direct cost model](https://docs.codat.io/lending-api#/operations/get-create-directCosts-model). + operationId: create-direct-cost + x-speakeasy-group: loan-writeback.direct-costs + '/companies/{companyId}/connections/{connectionId}/options/payments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create payment model + tags: + - Loan writeback + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + FreeAgent: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing account. + information: [] + required: true + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true validation: warnings: - - field: 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. + - field: TotalAmount + details: Must match the sum of the line amounts. 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 + description: Currency of the payment + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company + required: true + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + validation: + warnings: [] + information: + - field: Lines.Amount + details: Must match the sum of the link amounts. + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: CreditNote + required: false + - value: Other + type: String + displayName: Other + required: false + required: true + required: true + required: true + validation: + warnings: + - field: Lines + details: Only one line may be specified + information: [] required: true - FreeAgent: + FreshBooks: value: type: Object - displayName: Bank Account - description: An account that bank transactions may be recorded against + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) properties: - accountName: - type: String - displayName: Name - description: The name of the bank account in the originating system + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + required: true + required: true + validation: + warnings: + - field: Lines.Links + details: Payment Amount must not exceed Invoice Amount Due or available Customer Credit + - field: Lines.Links + details: Must be a Payment with one Invoice of PaymentOnAccount Link or two links of types Invoice and PaymentOnAccount + information: [] required: true - 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 + - field: Lines + details: Only one line is supported 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 + description: Currency of the payment options: - value: AED - type: String + type: Array displayName: AED required: false + - value: AFN + type: Array + displayName: AFN + required: false + - value: ALL + type: Array + displayName: ALL + required: false - value: AMD - type: String + type: Array displayName: AMD required: false + - value: ANG + type: Array + displayName: ANG + required: false - value: AOA - type: String + type: Array displayName: AOA required: false - value: ARS - type: String + type: Array displayName: ARS required: false - value: AUD - type: String + type: Array displayName: AUD required: false - value: AWG - type: String + type: Array displayName: AWG required: false - value: AZN - type: String + type: Array displayName: AZN required: false + - value: BAM + type: Array + displayName: BAM + required: false - value: BBD - type: String + type: Array displayName: BBD required: false - value: BDT - type: String + type: Array displayName: BDT required: false - value: BGN - type: String + type: Array displayName: BGN required: false + - value: BHD + type: Array + displayName: BHD + required: false + - value: BIF + type: Array + displayName: BIF + required: false + - value: BMD + type: Array + displayName: BMD + required: false + - value: BND + type: Array + displayName: BND + required: false + - value: BOB + type: Array + displayName: BOB + required: false - value: BRL - type: String + type: Array displayName: BRL required: false + - value: BSD + type: Array + displayName: BSD + required: false + - value: BTN + type: Array + displayName: BTN + required: false - value: BWP - type: String + type: Array displayName: BWP required: false + - value: BYR + type: Array + displayName: BYR + required: false + - value: BZD + type: Array + displayName: BZD + required: false - value: CAD - type: String + type: Array displayName: CAD required: false + - value: CDF + type: Array + displayName: CDF + required: false - value: CHF - type: String + type: Array displayName: CHF required: false - value: CLP - type: String + type: Array displayName: CLP required: false - value: CNY - type: String + type: Array displayName: CNY required: false - value: COP - type: String + type: Array displayName: COP required: false - value: CRC - type: String + type: Array displayName: CRC required: false - value: CUC - type: String + type: Array displayName: CUC required: false - value: CUP - type: String + type: Array displayName: CUP required: false + - value: CVE + type: Array + displayName: CVE + required: false - value: CZK - type: String + type: Array displayName: CZK required: false + - value: DJF + type: Array + displayName: DJF + required: false - value: DKK - type: String + type: Array displayName: DKK required: false - value: DOP - type: String + type: Array displayName: DOP required: false + - value: DZD + type: Array + displayName: DZD + required: false - value: EGP - type: String + type: Array displayName: EGP required: false + - value: ERN + type: Array + displayName: ERN + required: false + - value: ETB + type: Array + displayName: ETB + required: false - value: EUR - type: String + type: Array displayName: EUR required: false - value: FJD - type: String + type: Array displayName: FJD required: false + - value: FKP + type: Array + displayName: FKP + required: false - value: GBP - type: String + type: Array displayName: GBP required: false - value: GEL - type: String + type: Array displayName: GEL required: false + - value: GGP + type: Array + displayName: GGP + required: false - value: GHS - type: String + type: Array displayName: GHS required: false + - value: GIP + type: Array + displayName: GIP + required: false + - value: GMD + type: Array + displayName: GMD + required: false + - value: GNF + type: Array + displayName: GNF + required: false - value: GTQ - type: String + type: Array displayName: GTQ required: false - value: GYD - type: String + type: Array displayName: GYD required: false - value: HKD - type: String + type: Array displayName: HKD required: false - value: HNL - type: String + type: Array displayName: HNL required: false - value: HRK - type: String + type: Array displayName: HRK required: false + - value: HTG + type: Array + displayName: HTG + required: false - value: HUF - type: String + type: Array displayName: HUF required: false - value: IDR - type: String + type: Array displayName: IDR required: false - value: ILS - type: String + type: Array displayName: ILS required: false + - value: IMP + type: Array + displayName: IMP + required: false - value: INR - type: String + type: Array displayName: INR required: false + - value: IQD + type: Array + displayName: IQD + required: false + - value: IRR + type: Array + displayName: IRR + required: false - value: ISK - type: String + type: Array displayName: ISK required: false + - value: JEP + type: Array + displayName: JEP + required: false - value: JMD - type: String + type: Array displayName: JMD required: false + - value: JOD + type: Array + displayName: JOD + required: false - value: JPY - type: String + type: Array displayName: JPY required: false - value: KES - type: String + type: Array displayName: KES required: false + - value: KGS + type: Array + displayName: KGS + required: false + - value: KHR + type: Array + displayName: KHR + required: false + - value: KMF + type: Array + displayName: KMF + required: false + - value: KPW + type: Array + displayName: KPW + required: false - value: KRW - type: String + type: Array displayName: KRW required: false - value: KWD - type: String + type: Array displayName: KWD required: false - value: KYD - type: String + type: Array displayName: KYD required: false - value: KZT - type: String + type: Array displayName: KZT required: false - value: LAK - type: String + type: Array displayName: LAK required: false - value: LBP - type: String + type: Array displayName: LBP required: false - value: LKR - type: String + type: Array displayName: LKR required: false - - value: LTL - type: String - displayName: LTL + - value: LRD + type: Array + displayName: LRD required: false - - value: LVL - type: String - displayName: LVL + - value: LSL + type: Array + displayName: LSL + required: false + - value: LYD + type: Array + displayName: LYD required: false - value: MAD - type: String + type: Array displayName: MAD required: false - value: MDL - type: String + type: Array displayName: MDL required: false - value: MGA - type: String + type: Array displayName: MGA required: false + - value: MKD + type: Array + displayName: MKD + required: false + - value: MMK + type: Array + displayName: MMK + required: false + - value: MNT + type: Array + displayName: MNT + required: false + - value: MOP + type: Array + displayName: MOP + required: false + - value: MRO + type: Array + displayName: MRO + required: false - value: MUR - type: String + type: Array displayName: MUR required: false - value: MVR - type: String + type: Array displayName: MVR required: false - value: MWK - type: String + type: Array displayName: MWK required: false - value: MXN - type: String + type: Array displayName: MXN required: false - value: MYR - type: String + type: Array displayName: MYR required: false - value: MZN - type: String + type: Array displayName: MZN required: false - value: NAD - type: String + type: Array displayName: NAD required: false - value: NGN - type: String + type: Array displayName: NGN required: false + - value: NIO + type: Array + displayName: NIO + required: false - value: NOK - type: String + type: Array displayName: NOK required: false - value: NPR - type: String + type: Array displayName: NPR required: false - value: NZD - type: String + type: Array displayName: NZD required: false - value: OMR - type: String + type: Array displayName: OMR required: false + - value: PAB + type: Array + displayName: PAB + required: false - value: PEN - type: String + type: Array displayName: PEN required: false + - value: PGK + type: Array + displayName: PGK + required: false - value: PHP - type: String + type: Array displayName: PHP required: false - value: PKR - type: String + type: Array displayName: PKR required: false - value: PLN - type: String + type: Array displayName: PLN required: false + - value: PYG + type: Array + displayName: PYG + required: false - value: QAR - type: String + type: Array displayName: QAR required: false - value: RON - type: String + type: Array displayName: RON required: false - value: RSD - type: String + type: Array displayName: RSD required: false - value: RUB - type: String + type: Array displayName: RUB required: false - value: RWF - type: String + type: Array displayName: RWF required: false - value: SAR - type: String + type: Array displayName: SAR required: false + - value: SBD + type: Array + displayName: SBD + required: false - value: SCR - type: String + type: Array displayName: SCR required: false + - value: SDG + type: Array + displayName: SDG + required: false - value: SEK - type: String + type: Array displayName: SEK required: false - value: SGD - type: String + type: Array displayName: SGD required: false + - value: SHP + type: Array + displayName: SHP + required: false + - value: SLL + type: Array + displayName: SLL + required: false + - value: SOS + type: Array + displayName: SOS + required: false + - value: SPL + type: Array + displayName: SPL + required: false + - value: SRD + type: Array + displayName: SRD + required: false + - value: STD + type: Array + displayName: STD + required: false + - value: SVC + type: Array + displayName: SVC + required: false + - value: SYP + type: Array + displayName: SYP + required: false + - value: SZL + type: Array + displayName: SZL + required: false - value: THB - type: String + type: Array displayName: THB required: false + - value: TJS + type: Array + displayName: TJS + required: false + - value: TMT + type: Array + displayName: TMT + required: false - value: TND - type: String + type: Array displayName: TND required: false + - value: TOP + type: Array + displayName: TOP + required: false - value: TRY - type: String + type: Array displayName: TRY required: false - value: TTD - type: String + type: Array displayName: TTD required: false + - value: TVD + type: Array + displayName: TVD + required: false - value: TWD - type: String + type: Array displayName: TWD required: false - value: TZS - type: String + type: Array displayName: TZS required: false - value: UAH - type: String + type: Array displayName: UAH required: false - value: UGX - type: String + type: Array displayName: UGX required: false - value: USD - type: String + type: Array displayName: USD required: false - value: UYU - type: String + type: Array displayName: UYU required: false + - value: UZS + type: Array + displayName: UZS + required: false - value: VEF - type: String + type: Array displayName: VEF required: false - value: VND - type: String + type: Array displayName: VND required: false - value: VUV - type: String + type: Array displayName: VUV required: false + - value: WST + type: Array + displayName: WST + required: false - value: XAF - type: String + type: Array displayName: XAF required: false - value: XCD - type: String + type: Array displayName: XCD required: false + - value: XDR + type: Array + displayName: XDR + required: false - value: XOF - type: String + type: Array displayName: XOF required: false + - value: XPF + type: Array + displayName: XPF + required: false + - value: YER + type: Array + displayName: YER + required: false - value: ZAR - type: String + type: Array displayName: ZAR required: false - - value: ZMK - type: String - displayName: ZMK + - value: ZMW + type: Array + displayName: ZMW required: false + - value: ZWD + type: Array + displayName: ZWD + required: false + required: false + validation: + warnings: + - field: Currency + details: Can be used for Payments on Account only + information: [] + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + required: true + MYOB AccountRight and Essentials: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + validation: + warnings: + - field: CustomerRef.Id + details: Must be a valid GUID. + - field: CustomerRef.Id + details: Must match the ID of an existing customer. + information: + - field: CustomerRef.Id + details: Must be provided. required: true - balance: + validation: + warnings: [] + information: + - field: CustomerRef + details: Must be provided. + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be a valid GUID. + - field: AccountRef.Id + details: Must match the ID of an existing account. + information: + - field: AccountRef.Id + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: AccountRef + details: Must be provided. + totalAmount: type: Number - displayName: Balance - description: The balance of the bank account + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: Precision must be maximum of two decimal places. + - field: TotalAmount + details: Must be greater than zero. + information: + - field: TotalAmount + details: Must be provided and must equal the sum of the link items amount. + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + validation: + warnings: [] + information: + - field: Date + details: Must be provided. + reference: + type: String + displayName: Reference + description: A user friendly reference for the payment required: false validation: warnings: [] information: - - field: Balance - details: 'The opening balance, in the account currency' - institution: - type: String - displayName: Institution - description: The institution of the bank account - required: false + - field: Reference + details: Must not be greater than 8 characters long. + currency: + type: String + displayName: Currency + description: Currency of the payment + options: + - value: AUD + type: String + displayName: Australian Dollar + required: false + required: true + validation: + warnings: [] + information: + - field: Currency + details: Must be provided. + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + validation: + warnings: [] + information: + - field: Lines.Amount + details: Must be provided. + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + validation: + warnings: [] + information: + - field: Links.Id + details: Must be provided. + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + validation: + warnings: [] + information: + - field: Links.Amount + details: Precision must be maximum of two decimal places. + - field: Links.Amount + details: Must be provided. + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + required: false + required: true + validation: + warnings: [] + information: + - field: Links.Type + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: Lines.Links + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: Lines + details: Must be provided. required: true - KashFlow: + Oracle NetSuite: value: type: Object - displayName: Bank Account - description: An account that bank transactions may be recorded against + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) properties: - accountName: - type: String - displayName: Account Name - description: Name of the bank account as it appears in Kashflow. + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true required: true - balance: - type: Number - displayName: Balance - description: 'The opening balance, in the account currency.' + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing account of type 'Bank' OR type 'Asset' (with category 'FixedAsset'/'OthAsset'/'OthCurrAsset') OR type 'Liability' (with category 'LongTermLiab'/'OthCurrLiab') OR type 'Expense' (with category 'Expense'/'OthExpense') + information: [] required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: Must be greater than zero + - field: TotalAmount + details: Must be provided and must be equal to the sum of the lines amounts + information: [] + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true currency: type: String displayName: Currency - description: The currency of the bank account. + description: Currency of the payment + required: false + validation: + warnings: + - field: Currency + details: If the currency is set make sure it's the same as the 'Invoice' and/or 'CreditMemo' currency + information: [] + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + reference: + type: String + displayName: Reference + description: A user friendly reference for the payment + required: false + validation: + warnings: + - field: Reference + details: The id format should be 'location-' + information: + - field: Reference + details: This field can be used to provide a tracking category id (Location only) + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + validation: + warnings: + - field: Links.Id + details: If the Link Type specified is an 'Invoice' or 'CreditNote' make sure the status is either 'PartiallyPaid' or 'Submitted' + information: [] + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: Credit Note + required: false + - value: PaymentOnAccount + type: String + displayName: Payment On Account + required: false + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + required: true required: true required: true QuickBooks Desktop: value: type: Object - displayName: Bank Account - description: An account that bank transactions may be recorded against + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) properties: - nominalCode: - type: String - displayName: Nominal Code - description: The external reference given to each nominal account for a business + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + validation: + warnings: + - field: CustomerRef.Id + details: Must match the ID of an existing supplier. + information: [] required: true - 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 + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing 'Bank' or 'Other Current Asset' account. + information: + - field: AccountRef.Id + details: Not required if total amount of the payment is 0. + required: true + date: + type: DateTime + displayName: Date + description: The date the payment was recorded required: true + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + reference: + type: String + displayName: Reference + description: A user friendly reference for the payment + required: false validation: warnings: - - field: AccountName - details: Max length of 31 characters. + - field: Reference + details: Max length of 20 characters. information: [] currency: type: String displayName: Currency - description: The currency of the bank account + description: Currency of the payment 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 + details: Must be a three letter ISO code that matches the currency of the customer. - field: Currency details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. information: - field: Currency - details: 'If not set, will default to the base currency of the QuickBooks Desktop company' - balance: + details: 'If not set, will default to the default currency of the customer.' + currencyRate: type: Number - displayName: Balance - description: The balance of the bank account + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company required: false + validation: + warnings: [] + information: + - field: CurrencyRate + details: 'If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1.' + - field: CurrencyRate + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: Must match the sum of amounts in the lines + information: [] + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + validation: + warnings: + - field: Lines.Amount + details: Amount plus the sum of amounts in the links must equal 0 + information: [] + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: Credit Note + required: false + - value: PaymentOnAccount + type: String + displayName: Payment On Account + required: false + required: true + validation: + warnings: + - field: Links.Type + details: 'Only 1 link with type ''PaymentOnAccount'' may be specified per line, this line may contain no other links' + - field: Links.Type + details: Only 1 link with type 'Invoice' may be specified per line + information: [] + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + required: true + required: true required: true QuickBooks Online Sandbox: value: type: Object - displayName: Bank Account - description: An account that bank transactions may be recorded against + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) properties: - accountName: + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + required: true + validation: + warnings: [] + information: + - field: CustomerRef + details: 'Must be the ID of the Customer associated with the Invoice, Credit Note or Payment On Account.' + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: false + validation: + warnings: [] + information: + - field: AccountRef + details: Must match the ID of an existing Account. + paymentMethodRef: + type: Object + displayName: Payment Method Reference + description: Reference to the method of this payment + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the payment method + required: true + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + currency: type: String - displayName: Account Name - description: Name of account as it appears in the chart of accounts or general ledger. + displayName: Currency + description: Currency of the payment + required: false + validation: + warnings: [] + information: + - field: Currency + details: Required if multi-currency is enabled for the company + date: + type: DateTime + displayName: Date + description: The date the payment was recorded required: true - accountNumber: + note: 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. + displayName: Note + description: Any additional text based information associated with the payment + required: false + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: Credit Note + required: false + - value: PaymentOnAccount + type: String + displayName: Payment On Account + required: false + required: true + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + required: true + required: false + required: true + QuickBooks Online: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + required: true + validation: + warnings: [] + information: + - field: CustomerRef + details: 'Must be the ID of the Customer associated with the Invoice, Credit Note or Payment On Account.' + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: false + validation: + warnings: [] + information: + - field: AccountRef + details: Must match the ID of an existing Account. + paymentMethodRef: + type: Object + displayName: Payment Method Reference + description: Reference to the method of this payment + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the payment method + required: true + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + currency: + type: String + displayName: Currency + description: Currency of the payment + required: false + validation: + warnings: [] + information: + - field: Currency + details: Required if multi-currency is enabled for the company + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: Credit Note + required: false + - value: PaymentOnAccount + type: String + displayName: Payment On Account + required: false + required: true + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + required: true + required: false + required: true + Sage 50 (UK): + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + accountRef: + type: Object + displayName: Bank Account + description: The bank account to pay this invoice from. + properties: + id: + type: String + displayName: Account Id + description: Nominal code of the bank account. + required: true + validation: + warnings: + - field: accountRef.id + details: Must match the ID of an existing bank account and have a max length of 8 characters. + information: [] + required: true + customerRef: + type: Object + displayName: Customer + description: Customer to be paid. + properties: + id: + type: String + displayName: Customer Id + description: Identifier of the customer. + required: true + validation: + warnings: + - field: customerRef.id + details: Must match the ID of an existing customer and have a max length of 8 characters. + information: [] + required: true + totalAmount: + type: Number + displayName: Total Amount + description: The total amount being paid to the customer. + required: true + validation: + warnings: [] + information: + - details: This must equal the sum of the line amounts + reference: + type: Number + displayName: Reference + description: The user reference for this invoice payment. + required: false + date: + type: Number + displayName: Issue Date + description: The date this payment was issued. + required: true + note: + type: Number + displayName: Note + description: A description of the payment. + required: false + lines: + type: Array + displayName: Line Items + description: Line items of the payment. + properties: + amount: + type: Number + displayName: Amount + description: The amount of this line item + required: true + validation: + warnings: [] + information: + - details: this must equal the negative of the sum of the link amounts + links: + type: Array + displayName: Links + description: Links to the invoice being paid. + properties: + amount: + type: Number + displayName: Amount + description: The amount to be added to the value of the invoice + required: true + validation: + warnings: [] + information: + - details: 'When paying off an invoice, this value will be negative' + id: + type: String + displayName: Invoice Id + description: The ID of the invoice to pay + required: true + type: + type: String + displayName: Payment Link Type + description: The type of the item to be paid + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: PaymentOnAccount + type: String + displayName: Payment On Account + required: false + - value: Refund + type: String + displayName: Refund + required: false + - value: CreditNote + type: String + displayName: Credit Note + required: false + - value: Payment + type: String + displayName: Payment + required: false + required: true + required: true required: true + validation: + warnings: [] + information: + - details: Sage 50 only supports one line item per invoice payment so all lines will be merged together in the response. + required: true + validation: + warnings: [] + information: + - details: 'Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company.' + Sage Business Cloud Accounting: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing Account. + information: + - field: AccountRef.Id + details: Must be provided. + required: false + validation: + warnings: + - field: AccountRef + details: Required unless the Payment is only allocating a Credit Note. + information: [] + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + validation: + warnings: + - field: CustomerRef.Id + details: Must match the ID of an existing Customer. + information: + - field: CustomerRef.Id + details: Must be provided. + required: true + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + validation: + warnings: [] + information: + - field: Date + details: Must be provided. + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: Must be zero when allocating against Invoices using a Credit Note only. + - field: TotalAmount + details: Must equal the sum of the link items amount. + information: + - field: TotalAmount + details: Must be provided. + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + validation: + warnings: + - field: Note + details: Should not be longer than 25 characters. + information: [] currency: type: String displayName: Currency - description: Currency of the bank account. + description: Currency of the payment + required: false + validation: + warnings: [] + information: + - field: Currency + details: 'If supplied, must match the currency of the customer.' + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company + required: false + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + validation: + warnings: [] + information: + - field: Links.Id + details: Must be provided. + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + validation: + warnings: + - field: Links.Amount + details: Must be greater than zero except when Type is Invoice + information: + - field: Links.Amount + details: Must be provided. + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: PaymentOnAccount + type: String + displayName: PaymentOnAccount + required: false + - value: Refund + type: String + displayName: Refund + required: false + - value: CreditNote + type: String + displayName: CreditNote + required: false + required: true + validation: + warnings: [] + information: + - field: Links.Type + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: Lines.Links + details: Must be provided. required: true required: true - Sage Business Cloud Accounting: + Sage Intacct: value: type: Object - displayName: Bank Account - description: An account that bank transactions may be recorded against + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) properties: - accountName: - type: String - displayName: Name - description: The name of the bank account in the originating system + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' required: true validation: warnings: [] information: - - field: AccountName - details: Must be provided. - - field: AccountName - details: Should not be longer than 50 characters. - currency: + - field: TotalAmount + details: Must equal the sum of Lines.Amount. + note: type: String - displayName: Currency - description: The currency of the bank account - required: true + displayName: Note + description: Any additional text based information associated with the payment + required: false validation: warnings: [] information: - - field: Currency - details: Must be provided. - - field: Currency - details: Must match the company's base currency. - sortCode: + - field: Note + details: Must be less than 1000 characters. + paymentMethodRef: + type: Object + displayName: Payment Method Reference + description: Reference to the method of this payment + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the payment method + options: + - value: '1' + type: String + displayName: Printed Check + required: false + - value: '3' + type: String + displayName: Credit Card + required: false + - value: '5' + type: String + displayName: EFT + required: false + - value: '6' + type: String + displayName: Cash + required: false + required: true + required: true + reference: type: String - displayName: Sort Code - description: The sort code for the bank account + displayName: Reference + description: A user friendly reference for the payment required: false validation: warnings: [] information: - - field: SortCode - details: Should be a 6 digit number. - accountNumber: + - field: Reference + details: Can be used to set the Document/Check No. in Sage Intacct. + currency: type: String - displayName: Account Number - description: The account number for the bank account + displayName: Currency + description: Currency of the payment + required: false + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company required: false validation: warnings: [] information: - - field: 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 + - field: CurrencyRate + details: Is required if currency is provided. + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true validation: warnings: [] information: - - field: 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 + - field: Date + details: Must occur after the date the invoice was created. + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + validation: + warnings: [] + information: + - field: CustomerRef.Id + details: Must be an existing customer ID in Sage Intacct. + required: true + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: For undeposited payments use the GL account record number to charge. + - field: AccountRef.Id + details: 'To charge either a savings, checking or credit card account use its associated GL account number.' + required: true + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + validation: + warnings: [] + information: + - field: Lines.Amount + details: When added together with the sum of the Links.Amount the total must be zero. + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + validation: + warnings: [] + information: + - field: Links.Id + details: 'Must be a valid Record No. from accounts receivable of either an invoice for an ''Invoice'', adjustment for a ''CreditNote'' or an advance for a ''PaymentOnAccount'' in Sage Intacct.' + - field: Links.Id + details: Must be an integer. + - field: Links.Id + details: Must related to CustomerRef.Id in Sage Intacct. + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + required: true + validation: + warnings: [] + information: + - field: Links.Type + details: Must be one of Invoiceor CreditNoteor PaymentOnAccount. + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + validation: + warnings: [] + information: + - field: Links.Amount + details: Must not be more than the total amount due for an invoice or the available funds in the account to be charged. + required: true + validation: + warnings: [] + information: + - field: Lines.Links + details: No more than two links can exist when paying for an invoice via a CreditNoteor PaymentOnAccount. + - field: Lines.Links + details: Must contain only one Invoice. + required: true validation: warnings: [] information: - - field: NominalCode - details: Should be a number between 1 and 99999999. + - field: Lines + details: Must contain at least one payment line. required: true + validation: + warnings: [] + information: + - details: Sage Intacct handles allocated payments only. Sandbox: value: type: Object - displayName: Bank Account - description: An account that bank transactions may be recorded against + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) 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 + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + companyName: + type: String + displayName: Name + description: The name of the customer referenced by the identifier + required: true required: true - sortCode: - type: String - displayName: Sort Code - description: The sort code for the bank account + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + name: + type: String + displayName: Name + description: Name of the account + required: true required: true - accountNumber: - type: String - displayName: Account Number - description: The account number for the bank account + paymentMethodRef: + type: Object + displayName: Payment Method Reference + description: Reference to the method of this payment + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the payment method + required: true + name: + type: String + displayName: Name + description: The name of the payment method referenced by the identifier + required: true required: true - iBan: - type: String - displayName: IBAN - description: The international bank account number of the account. Often used when making or receiving international payments + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' required: true currency: type: String displayName: Currency - description: The currency of the bank account + description: Currency of the payment required: true - balance: + currencyRate: type: Number - displayName: Balance - description: The balance of the bank account + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company required: true - availableBalance: - type: Number - displayName: Available Balance - description: The available balance of the bank account + date: + type: DateTime + displayName: Date + description: The date the payment was recorded required: true - overdraftLimit: - type: Number - displayName: Overdraft Limit - description: The pre-arranged overdraft limit of the account + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment required: true - institution: + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + required: true + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the currency of the linked transaction + required: true + required: true + allocatedOnDate: + type: DateTime + displayName: Allocated On Date + description: The date the payment was allocated + required: true + required: true + reference: type: String - displayName: Institution - description: The institution of the bank account + displayName: Reference + description: A user friendly reference for the payment required: true metadata: type: Object @@ -2153,6 +74545,759 @@ paths: required: true required: true required: true + Xero: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + validation: + warnings: + - field: CustomerRef.Id + details: Must be a valid GUID. + - field: CustomerRef.Id + details: Must match the ID of an existing account. + information: + - field: CustomerRef.Id + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: CustomerRef + details: Must be provided. + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be a valid GUID. + - field: AccountRef.Id + details: Must match the ID of an existing account. + information: + - field: AccountRef.Id + details: Must be either a type of BANK account or enable payments must be switched on. + required: true + validation: + warnings: [] + information: + - field: AccountRef + details: Must be provided. + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: 'Must be greater than 0, unless the payment is a credit note allocation.' + information: + - field: TotalAmount + details: Must be provided and must equal the sum of the link items amount. + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + validation: + warnings: [] + information: + - field: Date + details: Must be provided. + reference: + type: String + displayName: Reference + description: A user friendly reference for the payment + required: false + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company + required: false + currency: + type: String + displayName: Currency + description: Currency of the payment + required: true + validation: + warnings: [] + information: + - field: Currency + details: Must be provided. + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + validation: + warnings: [] + information: + - field: Lines.Amount + details: Must be provided. + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + validation: + warnings: + - field: Links.Id + details: Must be a valid GUID. + information: + - field: Links.Id + details: Invoice and Credit Note ID must be provided in order to allocate a Credit Note to an Invoice. + - field: Links.Id + details: Must be provided. + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + validation: + warnings: [] + information: + - field: Links.Amount + details: Must be provided. + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: CreditNote + required: false + - value: Payment + type: String + displayName: Payment + required: false + required: true + validation: + warnings: [] + information: + - field: Links.Type + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: Lines.Links + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: Lines + details: Must be provided. + required: true + Zoho Books: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: AccountRef.ID is required when making a payment to an invoice and/or a payment on account + information: [] + required: true + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + required: true + currency: + type: String + displayName: Currency + description: Currency of the payment + required: true + validation: + warnings: + - field: Currency + details: must match the currency of any invoices or credit notes + information: [] + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company + required: true + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: must be greater than or equal to 0 + information: [] + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + validation: + warnings: + - field: Links.Amount + details: the sum of all link amounts must equal the negated total amount of the payment + information: [] + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - type: Array + displayName: Invoice + required: false + - type: Array + displayName: CreditNote + required: false + - type: Array + displayName: PaymentOnAccount + required: false + required: true + required: true + validation: + warnings: + - field: Lines.Links + details: 'if a credit note link is provided, exactly one invoice link must be provided, otherwise unlimited invoice links and one payment on account link are allowed' + information: [] + required: true + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-payment-model + x-speakeasy-group: loan-writeback.payments + description: |- + The *Get create payment model* endpoint returns the expected data for the request payload when creating a [payment](https://docs.codat.io/lending-api#/schemas/Payment) for a given company and integration. + + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. + + **Integration-specific behavior** + + See the *response examples* for integration-specific indicative models. + '/companies/{companyId}/connections/{connectionId}/push/payments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + summary: Create payment + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingPayment' + examples: + QuickBooks Desktop: + value: + customerRef: + id: 80000002-1674552702 + companyName: string + accountRef: + id: '8000002E-1675267199' + name: Undeposited Funds + paymentMethodRef: + id: string + name: string + totalAmount: 28 + currency: USD + currencyRate: 1 + date: '2023-02-10T11:47:04.792Z' + note: note 14/02 1147 + lines: + - amount: 28 + links: + - type: Invoice + id: 181-1676374586 + amount: -28 + currencyRate: 1 + allocatedOnDate: '2023-02-11T11:47:04.792Z' + reference: ref 14/02 1147 + Sage 50 (UK): + value: + customerRef: + id: CUST1 + accountRef: + id: '1200' + name: Bank Current Account + paymentMethodRef: + id: '4405' + totalAmount: 4 + currency: GBP + currencyRate: 1 + date: '2023-03-17T11:47:04.792Z' + note: note 07/03 14.31 + lines: + - amount: 4 + links: + - type: Invoice + id: INV-31 + amount: -4 + currencyRate: 1 + allocatedOnDate: '2023-02-11T11:47:04.792Z' + reference: ref + Sage Business Cloud Accounting: + value: + customerRef: + id: 30444c5bd4964fd787c7f8e2e5301ce1 + companyName: Stanley test customer + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + totalAmount: 0.17 + currency: GBP + currencyRate: 1 + date: '2023-03-20T11:47:04.792Z' + note: Need to send products asap. + lines: + - amount: 0.17 + links: + - type: Invoice + id: bb85db9226d7450fb99eb83e7fb37505 + amount: -0.17 + currencyRate: 1 + allocatedOnDate: '2023-02-11T11:47:04.792Z' + reference: normal payment 20/03 17.05 + Sage Intacct: + value: + customerRef: + id: '19' + accountRef: + id: '81' + date: '2022-03-12T00:00:00' + totalAmount: 0 + lines: + - amount: 0 + links: + - id: '246' + type: Invoice + amount: -1.1 + - id: '280' + type: CreditNote + amount: 1.1 + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreatePaymentResponse' + examples: + Sage Intacct: + value: + data: + customerRef: + id: '19' + accountRef: + id: '81' + totalAmount: 0 + date: '2022-03-12T00:00:00' + lines: + - amount: 0 + links: + - type: Invoice + id: '246' + amount: -1.1 + - type: CreditNote + id: '280' + amount: 1.1 + dataType: payments + companyId: ffa6368e-fde4-4165-9a0a-4bda1a6f916e + pushOperationKey: 673f5d97-1c53-41ef-b9c8-cc9a8415d17c + dataConnectionKey: bbecdbf3-913a-43ae-9c91-e830b3686657 + requestedOnUtc: '0001-01-01T00:00:00' + status: Pending + statusCode: 202 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Create payment* endpoint creates a new [payment](https://docs.codat.io/lending-api#/schemas/Payment) for a given company's connection. + + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create payment model](https://docs.codat.io/lending-api#/operations/get-create-payments-model). + operationId: create-payment + x-speakeasy-group: loan-writeback.payments + '/companies/{companyId}/push/{pushOperationKey}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/pushOperationKey' + get: + summary: Get create operation + tags: + - Loan writeback + operationId: get-create-operation + x-speakeasy-group: loan-writeback.create-operations + description: Retrieve create operation. + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOperation' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/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: + - Loan writeback + operationId: list-create-operations + x-speakeasy-group: loan-writeback.create-operations + description: List create operations. + 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}/bankStatements/upload/configuration': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Bank statements + summary: Get upload configuration + description: |- + Use the *Get upload configuration* endpoint to view the existing bank statement upload configuration for the specified data connection. + + With this configuration, you set the source of the data you plan to upload, the ID of the account in third-party banking platform, and a provider ID, if required. This lets us determine the expected format of the data and any source-specific requirements. + + When you use the [*Upload data*](https://docs.codat.io/lending-api#/operations/upload-bank-statement-data) endpoint next, you must upload the data for the account you configured. + operationId: get-bank-statement-upload-configuration + x-speakeasy-name-override: get-upload-configuration + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankStatementUploadConfiguration' + examples: + Codat: + $ref: '#/components/examples/CodatBankStatementUploadConfiguration' + '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' + post: + tags: + - Bank statements + summary: Set upload configuration + description: |- + Use the *Set upload configuration* endpoint to create bank statement upload configuration for the specified data connection. + + With this configuration, you set the source of the data you plan to upload, the ID of the account in third-party banking platform, and a provider ID, if required. This lets us determine the expected format of the data and any source-specific requirements. + + Each data connection can only have one configuration for each company and external account ID combination. You will receive a Bad Request response if you try to set it again. + operationId: set-bank-statement-upload-configuration + x-speakeasy-name-override: set-upload-configuration + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BankStatementUploadConfiguration' + examples: + Codat: + $ref: '#/components/examples/CodatBankStatementUploadConfiguration' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankStatementUploadConfiguration' + examples: + Codat: + $ref: '#/components/examples/CodatBankStatementUploadConfiguration' + '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}/bankStatements/upload/startSession': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Bank statements + summary: Start upload session + description: |- + Use the *Start upload session* endpoint to initiate a bank statement upload session for a given company. + + A session is a one-time process that enables you to upload bank statements to Codat. It will time out after 90 minutes if no data is uploaded. + + You can only have one active session per data type at a time. You can complete or cancel a session using the [*End upload session*](https://docs.codat.io/lending-api#/operations/end-bank-statement-upload-session) endpoint. + operationId: start-bank-statement-upload-session + x-speakeasy-name-override: start-upload-session + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StartUploadSessionRequest' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/PullOperation' + '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}/bankStatements/upload/dataset/{datasetId}/upload': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/datasetId' + - $ref: '#/components/parameters/path' + post: + tags: + - Bank statements + summary: Upload data + description: |- + During an active session, use the **Upload data* endpoint to uploads a page of bank accounts or bank transactions data to the session. + + Make sure you created configuration for the account using the [*Set upload configuration*](https://docs.codat.io/lending-api#/operations/set-bank-statement-upload-configuration) endpoint before attempting an upload. + operationId: upload-bank-statement-data + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/BankingAccount' + - $ref: '#/components/schemas/BankingTransactions' + - $ref: '#/components/schemas/ThirdPartySchema' + responses: + '200': + description: Success + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/bankStatements/upload/dataset/{datasetId}/endSession': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/datasetId' + post: + tags: + - Bank statements + summary: End upload session + description: |- + Use the *End upload session* endpoint to finalize a bank statement upload session. Include a `status` in the request body to indicate if you want to cancel the processing of the dataset or trigger the ingestion and enrichment of the data. + + A session is a one-time process that enables you to upload bank statements to Codat. It will time out after 90 minutes if no data is uploaded. + operationId: end-bank-statement-upload-session + x-speakeasy-name-override: end-upload-session + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EndUploadSessionRequest' + responses: + '200': + description: Success + '400': + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -2167,2150 +75312,9106 @@ 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}/reports/{reportType}': parameters: - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/reportType' + post: + tags: + - Manage reports + summary: Generate report + description: |- + Use the *Generate report* endpoint to initiate the generation of a report specified by the `reportType` parameter. + + This action triggers the system to refresh and pull the necessary data from the company's data sources to ensure the report contains the most up-to-date information. + operationId: generate-report + x-speakeasy-name-override: generate-report + responses: + '202': + description: Accepted (pending) + content: + application/json: + schema: + $ref: '#/components/schemas/ReportOperation' + examples: + Report: + $ref: '#/components/examples/SingleReportExample' + '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' + '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}/reports/{reportType}/{reportId}/status': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportType' + - $ref: '#/components/parameters/reportId' + - $ref: '#/components/parameters/maxAge' + get: + tags: + - Manage reports + summary: Get report status + description: |+ + Use the *Get report status* endpoint to return the metadata about report generation, such as its current status, date of request, and date of generation. + + You can either provide the ID of a report or use `latest` as the ID value to get the most recent generated *reportName* report for the company. + + operationId: get-report-status + x-speakeasy-name-override: get-report-status + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ReportOperation' + examples: + Report: + $ref: '#/components/examples/SingleReportExample' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/categorizedBankStatement/{reportId}/transactions': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportId' + - $ref: '#/components/parameters/maxAge' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + get: + tags: + - Bank statements + summary: Get categorized bank statement transactions + description: |- + The *Get categorized bank statement transactions* endpoint returns fully categorized bank transactions for a company. Transaction data is obtained from the company's connected bank accounts. + + Before using it, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `categorizedBankStatement`. + operationId: get-categorized-bank-statement-transactions + x-speakeasy-name-override: get-categorized-bank-statement-transactions + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CategorizedBankStatementTransactions' + example: + pageNumber: 1 + pageSize: 100 + totalResults: 2194 + _links: + self: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions + current: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=1&pageSize=100 + next: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=2&pageSize=100 + results: + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: ab5e07a0-5578-4d91-8421-2dc72713b74f + date: '2022-11-08T00:00:00' + description: Payment m86SDGpQr3 + amount: -6905.44 + currency: GBP + transactionCategory: + confidence: 52.53 + levels: + - Expense + - Operating + confidences: + - 56 + - 52.53 + platformName: Shopify + counterpartyNames: + - Shopify + modifiedDate: '2022-11-08T12:00:00' + isRecurring: true + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: 9846bbed-46d3-472c-a848-1ce8ebea7213 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 4332.84 + currency: GBP + transactionCategory: + confidence: 88 + levels: + - Expense + confidences: + - 88 + platformName: Amazon + counterpartyNames: + - Amazon + - Amazon Marketplace + modifiedDate: '2022-11-08T12:00:00' + isRecurring: false + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 94b213fb-d742-435e-90f1-bfe723a076d5 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 4034.3 + currency: GBP + transactionCategory: + confidence: 61.08 + levels: + - Income + - Revenue + confidences: + - 65 + - 61.08 + platformName: Shopify + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + isRecurring: null + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: cfceb7ff-eaa2-45b6-aca7-fa0e0b439161 + date: '2022-11-08T00:00:00' + description: Payment to supplier 78792d13-90a0-4ea2-8e07-81c3c893997e + amount: -313.76 + currency: GBP + transactionCategory: + confidence: 40.98 + levels: + - Expense + - CostOfSales + confidences: + - 40.98 + - 99.9 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + isRecurring: true + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: ba814f14-0fe3-41d0-9308-57f40642ac75 + date: '2022-11-08T00:00:00' + description: Payment to supplier 46d2e1fb-b4e9-469c-814a-21ff8105a26e + amount: -614.4 + currency: GBP + transactionCategory: + confidence: 55.84 + levels: + - Income + - Revenue + confidences: + - 55.84 + - 75.5 + platformName: Zettle + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + isRecurring: false + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: e67cc30e-fd5c-4eea-8365-ec40dfdd3ef6 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 5199.62 + currency: GBP + transactionCategory: + confidence: 57.85 + levels: + - Expense + confidences: + - 57.85 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + isRecurring: null + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: e0f08a0b-3575-4dde-98c4-3c854028d2d2 + date: '2022-11-08T00:00:00' + description: Payment to supplier 18ac18dc-945b-4083-9013-e8a100b999fa + amount: -21420.94 + currency: GBP + transactionCategory: + confidence: 70.58 + levels: + - Expense + - Operating + confidences: + - 70.58 + - 100 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + isRecurring: true + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 4b70d379-8284-4f44-bb37-c7935df950cc + date: '2022-11-08T00:00:00' + description: Payment to supplier 630a3f16-5f01-4986-ae6b-82333ec49449 + amount: -30924.22 + currency: GBP + transactionCategory: + confidence: 48.26 + levels: + - Income + confidences: + - 48.26 + platformName: DoorDash + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + isRecurring: false + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 76b73373-9345-472e-8edf-5be849d797fe + date: '2022-11-08T00:00:00' + description: Payment to supplier bQATU4eSb9 + amount: -568.78 + currency: GBP + transactionCategory: + confidence: 65.21 + levels: + - Income + - Revenue + confidences: + - 65.21 + - 100 + platformName: Uber + counterpartyNames: + - Uber + modifiedDate: '2022-11-08T12:00:00' + isRecurring: true + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: ee92fd6f-e0f7-4391-85fd-4b50921b973f + date: '2022-11-08T00:00:00' + description: Payment to supplier 9c37eb21-579a-4886-8296-3a853076b7bd + amount: -13050.79 + currency: GBP + transactionCategory: + confidence: 92.33 + levels: + - Income + - Revenue + confidences: + - 92.33 + - 92.33 + platformName: DoorDash + counterpartyNames: + - DoorDash + modifiedDate: '2022-11-08T12:00:00' + isRecurring: false + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/categorizedBankStatement/{reportId}/accounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportId' + - $ref: '#/components/parameters/maxAge' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + get: + tags: + - Bank statements + summary: List categorized bank statement accounts + description: |- + The *Get categorized bank statement accounts* endpoint returns a list of bank accounts associated with categorized transactions for a company. + + Before using it, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `categorizedBankStatement`. + operationId: list-categorized-bank-statement-accounts + x-speakeasy-name-override: list-categorized-bank-statement-accounts + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CategorizedBankStatementAccounts' + example: + pageNumber: 1 + pageSize: 10 + totalResults: 15 + _links: + self: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions + current: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=1&pageSize=10 + next: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=2&pageSize=10 + results: + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Savings Account + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Banking - Business Credit Card + accountType: Credit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Undeposited Funds + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Current Account + accountType: Debit + currency: GBP + currentBalance: 0 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/categorizedBankStatement/{reportId}/excel': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportId' + - $ref: '#/components/parameters/maxAge' + get: + tags: + - Bank statements + summary: Download categorized bank statement Excel + description: |- + Use the *Download categorized bank statement Excel* endpoint to download the categorized bank statement Excel file. + + Before using it, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `categorizedBankStatement`. + operationId: download-categorized-bank-statement-excel + x-speakeasy-name-override: download-categorized-bank-statement-excel + responses: + '200': + description: OK + content: + application/octet-stream: + schema: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/creditModel/{reportId}/excel': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportId' + - $ref: '#/components/parameters/maxAge' + get: + tags: + - Financial summary + summary: Download credit model Excel + description: |- + > **Available as beta release** + > + > This endpoint is part of a beta release. Please contact your account manager if you want to enable it. + + Use the *Download Credit Model Excel* endpoint to download the credit model Excel file. + + Before using it, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `creditModel`. + operationId: download-credit-model-excel + x-speakeasy-name-override: download-credit-model-excel + responses: + '200': + description: OK + content: + application/octet-stream: + schema: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + get: + tags: + - Manage reports + summary: List reports + description: 'Use the *List reports* endpoint to return details (such as generation''s current status, date of request, and date of generation) about all reports generated for a company. The query parameter can be used to filter the results.' + operationId: list-reports + x-speakeasy-name-override: list-reports + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ReportOperation/definitions/reports' + example: + pageNumber: 1 + pageSize: 4 + totalResults: 15 + _links: + self: + href: /companies/0f591937-4ea9-48c4-847a-fe65fb24bb41/reports + current: + href: /companies/0f591937-4ea9-48c4-847a-fe65fb24bb41/reports?page=1&pageSize=4 + next: + href: /companies/0f591937-4ea9-48c4-847a-fe65fb24bb41/reports?page=2&pageSize=4 + results: + - id: c0d52c82-777f-4309-81a0-d935aea0562b + status: InProgress + type: categorizedBankStatement + requested: '2024-10-15T07:00:00Z' + updated: '2024-10-15T15:31:45Z' + - id: 79ef0451-edbd-4108-82ff-0b991444f1ec + status: Complete + type: categorizedBankStatement + requested: '2024-09-10T05:50:00Z' + updated: '2024-09-11T14:37:12Z' + - id: ae125b45-ed37-4bb4-bb4a-d55383fd56b2 + status: Complete + type: categorizedBankStatement + requested: '2024-09-06T07:47:10Z' + updated: '2024-09-20T14:42:15Z' + - id: ebfaf90c-31fe-407f-a016-bc2b3e60894a + status: Error + type: categorizedBankStatement + requested: '2024-07-15T04:45:14Z' + updated: '2024-07-15T17:41:45Z' + errorMessage: Failed to generate the report because.... + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/creditModel/{reportId}/financialSummary': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportId' + get: + tags: + - Financial summary + summary: Get financial summary insights + description: |- + > **Available as beta release** + > + > This endpoint is part of a beta release. Please contact your account manager if you want to enable it. + + Financial summary insights provide high-level indicators about the accuracy and completeness of a business’s financial data. These insights include: + - Closed Books Indicator – An estimate of the most recent accounting period officially closed by a business + - Accounting Score – An evaluation of the quality and completeness of a business’s bookkeeping + + Before accessing this endpoint, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `creditModel`. + + > Please note that missing elements might be disabled for the account. Please contact account manager for more details. + operationId: get-financial-summary + x-speakeasy-name-override: get-financial-summary + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/FinancialSummary' + example: + booksClosedDate: + date: '2025-05-31T00:00:00Z' + reason: + - One or more accounts show a deviation from expected movements for March 2025 + - One of the marketing accounts haven't been booked for February 2025 + - One of the inventory accounts haven't been booked for March 2025 + accountingScore: + score: 90 + reason: + - Balance sheet is unbalanced. + - Negative Tangible Assets on Balance Sheet + - Negative Accounts Receivable on Balance Sheet + '204': + description: No content + '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' +webhooks: + Account categories updated: + post: + requestBody: + description: Triggered when a company's accounts are categorized. + content: + application/json: + schema: + $ref: '#/components/schemas/AccountCategoriesUpdatedWebhook' + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + client.rateLimit.reached: + post: + description: Called when your client’s request count to Codat's API surpasses the allocated quota. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClientRateLimitWebhook' + examples: + Reached: + value: + id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b + eventType: client.rateLimit.reached + generatedDate: '2024-09-01T00:00:00Z' + payload: + dailyQuota: 12000 + quotaRemaining: 0 + expiryDate: '2024-09-01T12:14:14Z' + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + client.rateLimit.reset: + post: + description: 'Called when your client''s rate limit quota is reset, allowing additional requests to Codat''s API.' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClientRateLimitWebhook' + examples: + Reset: + value: + id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b + eventType: client.rateLimit.reset + generatedDate: '2024-09-01T00:00:00Z' + payload: + dailyQuota: 12000 + quotaRemaining: 11993 + expiryDate: '2024-09-01T23:59:99Z' + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + reports.categorizedBankStatement.generate.successful: + post: + description: Called when a categorized bank statement is successfully generated for a company. + requestBody: + content: + application/json: + schema: + $ref: '#/webhooks/reports.creditModel.generate.successful/post/requestBody/content/application~1json/schema' + examples: + Successful: + value: + id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 + eventType: reports.categorizedBankStatement.generate.successful + generatedDate: '2023-05-03T10:00:23.000Z' + payload: + id: bb42ce7e-720a-4ac5-b640-f24f53ff47c8 + referenceCompany: + id: 0498e921-9b53-4396-a412-4f2f5983b0a2 + name: Bank of Dave + description: internal_id_mxO7rLfo + links: + portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary' + tags: + customerRegion: us + uid: 335a086e-8563-4b03-94e3-39544225ecb6 + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + reports.categorizedBankStatement.generate.unsuccessful: + post: + description: Called when a categorized bank statement has failed to be generated for a company. + requestBody: + content: + application/json: + schema: + $ref: '#/webhooks/reports.creditModel.generate.successful/post/requestBody/content/application~1json/schema' + examples: + Unsuccessful: + value: + id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 + eventType: reports.categorizedBankStatement.generate.unsuccessful + generatedDate: '2023-05-03T10:00:23.000Z' + payload: + id: bb42ce7e-720a-4ac5-b640-f24f53ff47c8 + referenceCompany: + id: 0498e921-9b53-4396-a412-4f2f5983b0a2 + name: Bank of Dave + description: internal_id_mxO7rLfo + links: + portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary' + tags: + customerRegion: us + uid: 335a086e-8563-4b03-94e3-39544225ecb6 + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + reports.creditModel.generate.successful: + post: + description: Called when a credit model report is successfully generated. + requestBody: + content: + application/json: + schema: + title: Report generation webhook + type: object + properties: + id: + type: string + format: uuid + example: ba29118f-5406-4e59-b05c-ba307ca38d01 + description: Unique identifier of the event. + eventType: + type: string + description: The type of event. + examples: + - reports.categorizedBankStatement.generate.successful + - reports.creditModel.generate.successful + generatedDate: + $ref: '#/components/schemas/DateTime' + description: The date time in UTC the event was generated in Codat. + payload: + $ref: '#/webhooks/reports.creditModel.generate.successful/post/requestBody/content/application~1json/schema/definitions/ReportGenerationPayload' + definitions: + ReportGenerationPayload: + title: Report generation payload + type: object + properties: + id: + type: string + format: uuid + example: a78e2625-7190-4d94-ae3b-071320451026 + description: Unique identifier of the report. + referenceCompany: + $ref: '#/components/schemas/Company/definitions/companyReference' + examples: + Successful: + value: + id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 + eventType: reports.creditModel.generate.successful + generatedDate: '2023-05-03T10:00:23.000Z' + payload: + id: bb42ce7e-720a-4ac5-b640-f24f53ff47c8 + referenceCompany: + id: 0498e921-9b53-4396-a412-4f2f5983b0a2 + name: Bank of Dave + description: Looking for a loan. + links: + portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary' + tags: + customerRegion: us + uid: 335a086e-8563-4b03-94e3-39544225ecb6 + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + reports.creditModel.generate.unsuccessful: post: + description: Called when a credit model report has failed to be generated for a company. + requestBody: + content: + application/json: + schema: + $ref: '#/webhooks/reports.creditModel.generate.successful/post/requestBody/content/application~1json/schema' + examples: + Unsuccessful: + value: + id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 + eventType: reports.creditModel.generate.unsuccessful + generatedDate: '2023-05-03T10:00:23.000Z' + payload: + id: bb42ce7e-720a-4ac5-b640-f24f53ff47c8 + referenceCompany: + id: 0498e921-9b53-4396-a412-4f2f5983b0a2 + name: Bank of Dave + description: Looking for a loan. + links: + portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary' + tags: + customerRegion: us + uid: 335a086e-8563-4b03-94e3-39544225ecb6 + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. +components: + schemas: + AccountCategoriesUpdatedWebhook: + title: Account categories updated webhook + description: Webhook request body for the "Account categories updated" event. + x-internal: true + type: object + properties: + ClientId: + title: Client ID + type: string + format: uuid + description: Unique identifier for your client in Codat. + ClientName: + type: string + description: Name of your client in Codat. + CompanyId: + $ref: '#/components/parameters/companyId/schema' + DataConnectionId: + $ref: '#/components/parameters/connectionId/schema' + RuleId: + type: string + format: uuid + description: Unique identifier for the rule. + deprecated: true + RuleType: + type: string + x-stoplight: + id: 34d52a089f08a + description: The type of rule. + AlertId: + type: string + format: uuid + description: Unique identifier of the webhook event. + Message: + type: string + description: A human-readable message about the webhook. + Data: + $ref: '#/components/schemas/AccountCategoriesUpdatedWebhook/definitions/AccountCategoriesUpdatedWebhookData' + definitions: + AccountCategoriesUpdatedWebhookData: + type: object + title: Account categories updated webhook data + properties: + modifiedDate: + $ref: '#/components/schemas/SourceAccountV2/properties/feedStartDate' + description: The date on which the company's account categories were last modified in Codat. + examples: + - ClientId: bae71d36-ff47-420a-b4a6-f8c9ddf41140 + ClientName: Bank of Dave + CompanyId: 8a210b68-6988-11ed-a1eb-0242ac120002 + DataConnectionId: 2e9d2c44-f675-40ba-8049-353bfcb5e171 + RuleId: 70af3071-65d9-4ec3-b3cb-5283e8d55dac + RuleType: Account Categories Updated + AlertId: a9367074-b5c3-42c4-9be4-be129f43577e + Message: Account categories updated for company f1c35bdc-1546-41b9-baf4-3f31135af968. + Data: + modifiedDate: '2019-08-24T14:15:22Z' + AccountingAccount: + title: 'Accounting: Account' + description: "\uFEFF> **Language tip:** Accounts are also referred to as **chart of accounts**, **nominal accounts**, and **general ledger**.\n\n## Overview\n\nAccounts are the categories a business uses to record accounting transactions. From the Accounts endpoints, you can retrieve a list of all accounts for a specified company.\n\nThe categories for an account include:\n* Asset\n* Expense\n* Income\n* Liability\n* Equity.\n\nThe same account may have a different category based on the integration it is used in. For example, a current account (known as checking in the US) should be categorized as `Asset.Current` for Xero, and `Asset.Bank.Checking` for QuickBooks Online.\n\nAt the same time, each integration may have its own requirements to the categories. For example, a Paypal account in Xero is of the `Asset.Bank` category and therefore requires additional properties to be provided.\n\nTo determine the list of allowed categories for a specific integration, you can:\n- Follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide and use the [Get create account model](https://docs.codat.io/lending-api#/operations/get-create-chartOfAccounts-model).\n- Refer to the integration's own documentation.\n\n> **Accounts with no category**\n>\n> If an account is pulled from the chart of accounts and its nominal code does not lie within the category layout for the company's accounts, then the **type** is `Unknown`. The **fullyQualifiedCategory** and **fullyQualifiedName** fields return `null`.\n>\n> This approach gives a true representation of the company's accounts whilst preventing distorting financials such as a company's profit and loss and balance sheet reports." + allOf: + - properties: + id: + type: string + description: 'Identifier for the account, unique for the company.' + example: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + - $ref: '#/components/schemas/AccountingAccount/definitions/accountPrototype' + - properties: + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + accountPrototype: + title: Account prototype + type: object + properties: + nominalCode: + type: string + nullable: true + description: Reference given to each nominal account for a business. It ensures money is allocated to the correct account. This code isn't a unique identifier in the Codat system. + example: '610' + name: + type: string + nullable: true + description: Name of the account. + example: Accounts Receivable + description: + type: string + nullable: true + description: Description for the account. + example: Invoices the business has issued but has not yet collected payment on. + fullyQualifiedCategory: + type: string + nullable: true + description: "Full category of the account. \r\n\r\nFor example, `Liability.Current` or `Income.Revenue`. To determine a list of possible categories for each integration, see our examples, follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide, or refer to the integration's own documentation." + example: Asset.Current + fullyQualifiedName: + type: string + nullable: true + description: |- + Full name of the account, for example: + - `Cash On Hand` + - `Rents Held In Trust` + - `Fixed Asset` + examples: + - Cash On Hand + - Fixed Asset + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + currentBalance: + type: number + format: decimal + nullable: true + description: Current balance in the account. + example: 0 + type: + $ref: '#/components/schemas/AccountingAccount/definitions/accountType' + status: + $ref: '#/components/schemas/AccountingAccount/definitions/accountStatus' + isBankAccount: + type: boolean + description: Confirms whether the account is a bank account or not. + validDatatypeLinks: + type: array + nullable: true + description: 'The validDatatypeLinks can be used to determine whether an account can be correctly mapped to another object; for example, accounts with a `type` of `income` might only support being used on an Invoice and Direct Income. For more information, see [Valid Data Type Links](/lending-api#/schemas/ValidDataTypeLinks).' + items: + title: Valid data type links + description: |- + When querying Codat's data model, some data types return `validDatatypeLinks` metadata in the JSON response. This indicates where that object can be used as a reference—a _valid link_—when creating or updating other data. + + For example, `validDatatypeLinks` might indicate the following references: + + - Which tax rates are valid to use on the line item of a bill. + - Which items can be used when creating an invoice. + + You can use `validDatatypeLinks` to present your SMB customers with only valid choices when selecting objects from a list, for example. + + ## `validDatatypeLinks` example + + The following example uses the `Accounting.Accounts` data type. It shows that, on the linked integration, this account is valid as the account on a payment or bill payment; and as the account referenced on the line item of a direct income or direct cost. Because there is no valid link to Invoices or Bills, using this account on those data types will result in an error. + + ```json validDatatypeLinks for an account + { + "id": "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", + "nominalCode": "090", + "name": "Business Bank Account", + #... + "validDatatypeLinks": [ + { + "property": "Id", + "links": [ + "Payment.AccountRef.Id", + "BillPayment.AccountRef.Id", + "DirectIncome.LineItems.AccountRef.Id", + "DirectCost.LineItems.AccountRef.Id" + ] + } + ] + } + ``` + + + + ## Support for `validDatatypeLinks` + + Codat currently supports `validDatatypeLinks` for some data types on our Xero, QuickBooks Online, QuickBooks Desktop, Exact (NL), and Sage Business Cloud integrations. + + If you'd like us to extend support to more data types or integrations, suggest or vote for this on our Product Roadmap. + type: object + properties: + property: + type: string + nullable: true + description: The property from the account that can be linked. + links: + type: array + nullable: true + description: Supported `dataTypes` that the record can be linked to. + items: + type: string + supplementalData: + $ref: '#/components/schemas/SupplementalData' + accountRef: + title: Account reference + type: object + description: 'Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.' + properties: + id: + type: string + description: '''id'' from the Accounts data type.' + name: + type: string + description: '''name'' from the Accounts data type.' + accountType: + title: Account type + enum: + - Unknown + - Asset + - Expense + - Income + - Liability + - Equity + type: string + description: Type of account + example: Asset + accountStatus: + title: Account status + enum: + - Unknown + - Active + - Archived + - Pending + type: string + description: Status of the account + example: Active + type: object + AccountingAccounts: + title: 'Accounting: Accounts' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingAccount' + - $ref: '#/components/schemas/PagingInfo' + AccountingAccountTransaction: + title: 'Accounting: Account transaction' + description: |- + > **Language tip:** In Codat, account transactions represent all transactions posted to a bank account within an accounting software. For bank transactions posted within a banking platform, refer to [Banking transactions](https://docs.codat.io/lending-api#/operations/list-all-banking-transactions). + + ## Overview + + In Codat’s data model, account transactions represent bank activity within an accounting software. All transactions that go through a bank account are recorded as account transactions. + + Account transactions are created as a result of different business activities, for example: + + * Payments: for example, receiving money for payment against an invoice. + * Bill payments: for example, spending money for a payment against a bill. + * Direct costs: for example, withdrawing money from a bank account, either for cash purposes or to make a payment. + * Direct incomes: for example, selling an item directly to a contact and receiving payment at point of sale. + * Transfers: for example, transferring money between two bank accounts. + + Account transactions is the parent data type of [payments](https://docs.codat.io/lending-api#/schemas/Payment), [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment), [direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost), [direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome), and [transfers](https://docs.codat.io/lending-api#/schemas/Transfer). + type: object + allOf: + - type: object + properties: + id: + type: string + description: Identifier of the direct cost (unique to the company). + transactionId: + type: string + nullable: true + description: Identifier of the transaction (unique to the company). + note: + type: string + nullable: true + description: 'Additional information about the account transaction, if available.' + bankAccountRef: + $ref: '#/components/schemas/AccountingBankAccount/definitions/bankAccountRef' + description: Reference to the bank account the account transaction is recorded against. + date: + $ref: '#/components/schemas/DateTime' + description: The date the account transaction was recorded in the platform. + status: + enum: + - Unknown + - Unreconciled + - Reconciled + - Void + type: string + description: The status of the account transaction. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lines: + type: array + nullable: true + description: Array of account transaction lines. + items: + $ref: '#/components/schemas/AccountingAccountTransaction/definitions/accountTransactionLine' + totalAmount: + type: number + format: decimal + description: 'Total amount of the account transactions, inclusive of tax.' + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + accountTransactionLine: + type: object + properties: + description: + type: string + nullable: true + description: Description of the account transaction. + recordRef: + $ref: '#/components/schemas/AccountingAccountTransaction/definitions/accountTransactionLineRecordRef' + amount: + type: number + format: decimal + description: Amount in the bill payment currency. + accountTransactionLineRecordRef: + type: object + title: Record reference + description: Links an account transaction line to the underlying record that created it. + properties: + id: + type: string + description: '''id'' of the underlying record or data type.' + dataType: + type: string + description: Name of underlying data type. + enum: + - bankTransactions + - billCreditNotes + - billPayments + - bills + - creditNotes + - directCosts + - directIncomes + - invoices + - journalEntries + - payments + - transfers + example: transfers + AccountingAccountTransactions: + title: 'Accounting: Account transactions' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingAccountTransaction' + - $ref: '#/components/schemas/PagingInfo' + AccountingAddress: + title: 'Accounting: Address' + x-internal: true + type: object + properties: + type: + $ref: '#/components/schemas/AccountingAddress/definitions/accountingAddressType' + line1: + type: string + nullable: true + description: Line 1 of the customer address. + line2: + type: string + nullable: true + description: Line 2 of the customer address. + city: + type: string + nullable: true + description: City of the customer address. + region: + type: string + nullable: true + description: Region of the customer address. + country: + type: string + nullable: true + description: Country of the customer address. + postalCode: + type: string + nullable: true + description: Postal code or zip code. + required: + - type + definitions: + accountingAddressType: + description: The type of the address + type: string + enum: + - Unknown + - Billing + - Delivery + AccountingAgedCreditorReport: + title: 'Accounting: Aged creditors report' + description: |- + The Aged Creditors report shows the total balance owed by a business to its suppliers over time. + + You can generate it for a company based on recently synced data from your customers' accounting software. The report is available in the **Reports** tab in the Codat portal. + + Total assets or liabilities are grouped into 30-day periods for each supplier, up to the current date. You can adjust the report date, period length, and number of periods to show on each report. The data can be grouped by customer or currency. + + > It is not guaranteed that write-offs are included in the Aged Creditors report. + + ## Underlying data + + The Aged Creditors report is generated from a set of required data types: [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier), [Bills](https://docs.codat.io/lending-api#/schemas/Bill), [Bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote), and [Bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment). + + To generate the report, the underlying data types must have been synced within 24 hours of each other. Otherwise an error is displayed when you try to run the report. Sync the required data types by clicking the link in the error, and then run the report again. + + > The Aged Creditor report runs based on the **issue dates** of the underlying data types rather than the due date. + + ## Accessing the Aged Creditors report in Portal + + Apart from returning the report via the API as JSON and query, you can also return the Aged Creditors report in the Codat portal. + + 1. In the navigation bar, click **Companies**. + 2. Click the name of the company you want to generate the report for. The company's data page is displayed. + 3. Click the **Accounting** tab then click **Reports**. + 4. Select **Aged Creditors**. + 5. _(Optional)_ Edit the default reporting parameters. + a. You can change the report date in the **Date** box. By default, the report includes transactions that occurred up to, but not including, today's date. To include transactions for today, enter tomorrow's date. + b. In the **Period Length Days** box, select the default period length for each column (the default is 30 days). + b. In the **Number of Periods** box, enter the number of periods to show as columns in the report (the default is 4 periods). + 6. To run the report, click **Load aged creditors**. + 7. The report is generated and displayed at the bottom of the page. + + The report will be grouped per supplier and depending on the periods requested. The details indicates whether the amounts owed come from outstanding bills or bill credit notes. + type: object + properties: + generated: + $ref: '#/components/schemas/DateTime' + description: Date and time the report was generated. + reportDate: + $ref: '#/components/schemas/DateTime' + description: Date the report is generated up to. + data: + type: array + description: Array of aged creditor. + items: + $ref: '#/components/schemas/AccountingAgedCreditorReport/definitions/agedCreditor' + examples: + - generated: '2022-10-23T00:00:00Z' + reportDate: '2022-10-23T00:00:00Z' + data: + - customerId: f594cefb-7750-4c3a-bab2-b5322026dee9 + customerName: John Doe + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2022-10-01T00:00:00Z' + toDate: '2022-10-31T00:00:00Z' + amount: 1547.5 + details: + - name: Bills + amount: 1547.5 + definitions: + agedCreditor: + title: Aged creditor + type: object + properties: + supplierId: + type: string + description: Supplier ID of the aged creditor. + example: f594cefb-7750-4c3a-bab2-b5322026dee9 + supplierName: + type: string + description: Supplier name of the aged creditor. + example: John Doe + agedCurrencyOutstanding: + type: array + description: Array of aged creditors by currency. + items: + $ref: '#/components/schemas/AgedCurrencyOutstanding' + AccountingAgedDebtorReport: + type: object + title: 'Accounting: Aged debtors report' + description: |- + The Aged Debtors report shows the total outstanding balance due from customers to the business over time. + + You can generate it for a company based on recently synced data from your customers' accounting software. The report is available in the **Reports** tab in the Codat portal. + + Total assets or liabilities are grouped into 30-day periods for each customer, up to the current date. You can adjust the report date, period length, and number of periods to show on each report. The data can be grouped by customer or currency. + + > It is not guaranteed that write-offs are included in the Aged Debtors report. + + ## Underlying data + + The Aged Debtors report is generated from a set of required data types: [Customers](https://docs.codat.io/lending-api#/schemas/Customer), [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice), [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote), and [Payments](https://docs.codat.io/lending-api#/schemas/Payment). + + To generate the report, the underlying data types must have been synced within 24 hours of each other. Otherwise an error is displayed when you try to run the report. Sync the required data types by clicking the link in the error, and then run the report again. + + > The Aged Debtors report runs based on the **issue dates** of the underlying data types rather than the due date. + + ## Accessing the Aged Debtors report in Portal + + Apart from returning the report via the API as JSON and query, you can also return the Aged Debtors report in the Codat portal. + + 1. In the navigation bar, click **Companies**. + 2. Click the name of the company you want to generate the report for. The company's data page is displayed. + 3. Click the **Accounting** tab then click **Reports**. + 4. Select **Aged Debtors**. + 5. _(Optional)_ Edit the default reporting parameters. + a. You can change the report date in the **Date** box. By default, the report includes transactions that occurred up to, but not including, today's date. To include transactions for today, enter tomorrow's date. + b. In the **Period Length Days** box, select the default period length for each column (the default is 30 days). + b. In the **Number of Periods** box, enter the number of periods to show as columns in the report (the default is 4 periods). + 6. To run the report, click **Load aged debtors**. + 7. The report is generated and displayed at the bottom of the page. + + The report will be grouped per supplier and depending on the periods requested. The details indicates whether the amounts owed come from outstanding invoices or credit notes. + properties: + generated: + $ref: '#/components/schemas/DateTime' + description: Date and time the report was generated. + reportDate: + $ref: '#/components/schemas/DateTime' + description: Date the report is generated up to. + data: + type: array + description: Array of aged debtors. + items: + $ref: '#/components/schemas/AccountingAgedDebtorReport/definitions/agedDebtor' + definitions: + agedDebtor: + title: Aged debtor + type: object + properties: + customerId: + type: string + description: Customer ID of the aged debtor. + example: f594cefb-7750-4c3a-bab2-b5322026dee9 + customerName: + type: string + description: Customer name of the aged debtor. + example: John Doe + agedCurrencyOutstanding: + type: array + description: Array of aged debtors by currency. + items: + $ref: '#/components/schemas/AgedCurrencyOutstanding' + examples: + - generated: '2022-10-23T00:00:00Z' + reportDate: '2022-10-23T00:00:00Z' + data: + - customerId: f594cefb-7750-4c3a-bab2-b5322026dee9 + customerName: John Doe + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2022-10-01T00:00:00Z' + toDate: '2022-10-31T00:00:00Z' + amount: 1547.5 + details: + - name: Invoices + amount: 1547.5 + AccountingAttachment: + title: 'Accounting: Attachment' + description: | + The Codat API supports pulling and pushing of file attachments for invoices, bills, direct costs, and direct incomes. + + > **Retrieving attachments** + > + > If a company is authorized, you can query the Codat API to read, download, and upload attachments without requiring a fresh sync of data. + + Unlike other data types, Codat doesn't support [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for attachments. + + Note that different integrations have different requirements to file size and extension of attachments. + + | Integration | File size | File extension | + |-------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------| + | Xero | 4 MB | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF, ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX, ZIP | + | QuickBooks Online | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML | + | NetSuite | 100 MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP | + | Dynamics 365 Business Central | 350 MB | Dynamics do not explicitly outline which file types are supported but they do state here that "You can attach any type of file, such as text, image, or video files". | + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the attachment, unique for the company in the accounting software.' + name: + type: string + nullable: true + description: Name of the attachment file. + contentType: + type: string + nullable: true + description: |- + File type of the attachment. This is represented by appending the file type to the [IETF standard file naming requirements](https://tools.ietf.org/html/rfc6838). For example, for a jpeg file the output is **image/jpeg**. + + Supported file types vary per platform. + dateCreated: + $ref: '#/components/schemas/DateTime' + fileSize: + type: integer + format: int32 + nullable: true + description: 'File size in bytes. For example, if this reads **46153**, then the file size is 46kb.' + includeWhenSent: + type: boolean + description: 'If `true`, then the attachment is included with the associated invoice, bill or direct costs when it is printed, emailed, or sent to a customer, if the underlying accounting software allows this.' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + examples: [] + definitions: + attachments: + title: Attachments + type: object + properties: + attachments: + description: An array of attachments related to the record. + type: array + items: + $ref: '#/components/schemas/AccountingAttachment' + nullable: true + AccountingBalanceSheet: + title: 'Accounting: Balance sheet' + description: |- + ## Overview + + The balance sheet is a snapshot of a company's accounts at a single point in time that provides a statement of the assets, liabilities and equity of an organization. It gives interested parties an idea of the company's financial position, in addition to displaying what the company owns and owes. + + > **Balance sheet or profit and loss report?** + > + > A profit and loss report summarises the total revenue, expenses, and profit or loss during a specified time period. A balance sheet report shows the financial position of a company at a specific moment in time. + + **Structure of this report** + This report will reflect the structure and line descriptions that the business has set in their own accounting software. + + **History** + By default, Codat pulls (up to) 24 months of balance sheets for a company. You can adjust this to fetch more history, where available, by updating the `monthsToSync` value for `balanceSheet` on the [data type settings endpoint](https://docs.codat.io/lending-api#/operations/update-sync-settings). + + **Want to pull this in a standardised structure?** + Our [Enhanced Financials](https://docs.codat.io/lending/features/financial-statements-overview) endpoints provide the same report under standardized headings, allowing you to pull it in the same format for all of your business customers. + type: object + additionalProperties: false + properties: + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the balance sheet. + reports: + type: array + description: An array of balance sheet reports. + items: + $ref: '#/components/schemas/AccountingBalanceSheet/definitions/balanceSheet' + mostRecentAvailableMonth: + $ref: '#/components/schemas/DateTime' + nullable: true + description: Most recent available monthly report data. + earliestAvailableMonth: + $ref: '#/components/schemas/DateTime' + nullable: true + description: Earliest available monthly report data. + required: + - reports + definitions: + balanceSheet: + type: object + properties: + date: + $ref: '#/components/schemas/DateTime' + description: Point in time when a snapshot of a company's financial position is taken. + assets: + $ref: '#/components/schemas/ReportLine' + description: 'ReportLines for assets. For example, fixed and current assets.' + liabilities: + $ref: '#/components/schemas/ReportLine' + description: 'ReportLines for liabilities. For example, current liabilities.' + netAssets: + type: number + format: decimal + description: Value of net assets for a company in their base currency. + equity: + $ref: '#/components/schemas/ReportLine' + description: 'ReportLines for equities. For example, retained and current year earnings. See below.' + required: + - netAssets + AccountingBankAccount: + 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/lending-api#/schemas/Account) data type. + + ## Overview + + A list of bank accounts associated with a company and a specific data connection. + + Bank accounts data includes: + * The name and ID of the account in the accounting software. + * The currency and balance of the account. + * The sort code and account number. + type: object + allOf: + - properties: + id: + type: string + description: 'Identifier for the account, unique for the company in the accounting software.' + - $ref: '#/components/schemas/AccountingBankAccount/definitions/bankAccountPrototype' + - properties: + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + 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: + $ref: '#/components/schemas/AccountingBankAccountType' + 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/AccountingBankAccount/definitions/bankAccountStatus' + bankAccountCreateResponse: + title: Create bank account response + allOf: + - properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingBankAccount' + - 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/AccountingBankAccount' + - $ref: '#/components/schemas/PagingInfo' + bankAccountStatus: + title: Account status + enum: + - Unknown + - Active + - Archived + - Pending + type: string + description: Status of the bank account. + example: Active + AccountingBankAccounts: + x-internal: true + title: 'Accounting: Bank accounts' + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingBankAccount' + - $ref: '#/components/schemas/PagingInfo' + AccountingBankAccountType: + 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. + AccountingBankTransaction: + title: 'Accounting: Bank account transaction' + 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: Transaction](https://docs.codat.io/lending-api#/operations/list-transactions) data type. + + ## Overview + + Transactional banking data for a specific company and account. + + Bank transactions include the: + * Amount of the transaction. + * Current account balance. + * Transaction type, for example, credit, debit, or transfer. + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the bank transaction, unique to the company in the accounting software.' + accountId: + type: string + nullable: true + description: Unique identifier to the `accountId` the bank transactions originates from. + clearedOnDate: + $ref: '#/components/schemas/DateTime' + description: + type: string + nullable: true + description: Description of the bank transaction. + reconciled: + type: boolean + description: '`True` if the bank transaction has been [reconciled](https://www.xero.com/uk/guides/what-is-bank-reconciliation/) in the accounting software.' + amount: + type: number + format: decimal + description: The amount transacted in the bank transaction. + balance: + type: number + format: decimal + description: The remaining balance in the account with ID `accountId`. + transactionType: + $ref: '#/components/schemas/AccountingBankTransaction/definitions/bankTransactionType' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + bankTransactionType: + title: Bank transaction type + description: Type of transaction for the bank statement line. + type: string + enum: + - Unknown + - Credit + - Debit + - Int + - Div + - Fee + - SerChg + - Dep + - Atm + - Pos + - Xfer + - Check + - Payment + - Cash + - DirectDep + - DirectDebit + - RepeatPmt + - Other + AccountingBankTransactions: + title: 'Accounting: Accounting bank transactions' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingBankTransaction' + - $ref: '#/components/schemas/PagingInfo' + AccountingBill: + title: 'Accounting: Bill' + description: |- + > **Invoices or bills?** + > + > We distinguish between invoices where the company *owes money* vs. *is owed money*. If the company has received an invoice, and owes money to someone else (accounts payable) we call this a Bill. + > + > See [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) for the accounts receivable equivalent of bills. + + ## Overview + + In Codat, a bill contains details of: + * When the bill was recorded in the accounting system. + * How much the bill is for and the currency of the amount. + * Who the bill was received from — the *supplier*. + * What the bill is for — the *line items*. + + Some accounting software give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's *expenses*. + + You can find these types of transactions in our [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) data model. + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the bill, unique for the company in the accounting software.' + reference: + type: string + nullable: true + description: User-friendly reference for the bill. + supplierRef: + $ref: '#/components/schemas/AccountingSupplier/definitions/supplierRef' + purchaseOrderRefs: + type: array + nullable: true + items: + title: Purchase order Reference + type: object + additionalProperties: false + properties: + id: + type: string + description: 'Identifier for the purchase order, unique for the company in the accounting software.' + purchaseOrderNumber: + type: string + nullable: true + description: 'Friendly reference for the purchase order, commonly generated by the accounting software.' + issueDate: + allOf: + - description: Date of the bill as recorded in the accounting software. + - $ref: '#/components/schemas/DateTime' + dueDate: + allOf: + - description: Date the supplier is due to be paid. + - $ref: '#/components/schemas/DateTime' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + nullable: true + description: Array of Bill line items. + items: + $ref: '#/components/schemas/AccountingBill/definitions/billLineItem' + withholdingTax: + type: array + nullable: true + items: + type: object + properties: + name: + minLength: 1 + type: string + description: Name assigned to withheld tax. + amount: + type: number + format: decimal + description: Amount of tax withheld. + required: + - amount + - name + status: + $ref: '#/components/schemas/AccountingBill/definitions/billStatus' + subTotal: + type: number + format: decimal + description: 'Total amount of the bill, excluding any taxes.' + taxAmount: + type: number + format: decimal + description: Amount of tax on the bill. + totalAmount: + type: number + format: decimal + description: 'Amount of the bill, including tax.' + amountDue: + type: number + format: decimal + nullable: true + description: Amount outstanding on the bill. + note: + type: string + nullable: true + description: 'Any private, company notes about the bill, such as payment information.' + paymentAllocations: + type: array + nullable: true + description: An array of payment allocations. + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - issueDate + - status + - subTotal + - taxAmount + - totalAmount + definitions: + billStatus: + description: Current state of the bill. + type: string + enum: + - Unknown + - Open + - PartiallyPaid + - Paid + - Void + - Draft + billLineItem: + title: Bill line item + type: object + properties: + lineNumber: + type: string + nullable: true + description: The bill line's number. + description: + type: string + nullable: true + description: Friendly name of the goods or services received. + unitAmount: + type: number + format: decimal + description: Price of each unit of goods or services. + quantity: + type: number + format: decimal + description: Number of units of goods or services received. + unitOfMeasurement: + type: string + nullable: true + description: 'The measurement which defines a unit for this item (e.g. ''kilogram'', ''litre'').' + discountAmount: + type: number + format: decimal + nullable: true + description: |- + Numerical value of any discounts applied. + + Do not use to apply discounts in Oracle NetSuite—see Oracle NetSuite integration reference. + subTotal: + type: number + format: decimal + nullable: true + description: 'Amount of the line, inclusive of discounts but exclusive of tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: Amount of tax for the line. + totalAmount: + type: number + format: decimal + nullable: true + description: 'Total amount of the line, including tax.' + discountPercentage: + type: number + format: decimal + nullable: true + description: Percentage rate of any discount applied to the bill. + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Reference to the account to which the line item is linked. + nullable: true + taxRateRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/taxRateRef' + description: Reference to the tax rate to which the line item is linked. + itemRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/itemRef' + description: 'Reference to the product, service type, or inventory item to which the line item is linked.' + purchaseOrderLineRef: + allOf: + - type: object + x-internal: true + title: Record line reference + description: |- + Links the current record line to the underlying record line that created it. + + For example, if a bill is generated from a purchase order, this property allows you to connect the bill line item to the purchase order line item in our data model. + properties: + id: + type: string + description: '''id'' of the underlying record.' + dataType: + type: string + description: Allowed name of the 'dataType'. + enum: + - purchaseOrders + - bills + lineNumber: + type: string + description: Line number of the underlying record. + - description: Reference to the purchase order line this line was generated from. + trackingCategoryRefs: + type: array + nullable: true + description: Collection of categories against which this item is tracked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + tracking: + $ref: '#/components/schemas/AccountsPayableTracking' + isDirectCost: + type: boolean + description: The bill is a direct cost if `True`. + AccountingBillCreditNote: + title: 'Accounting: Bill credit note' + description: |- + > **Bill credit notes or credit notes?** + > + > In Codat, bill credit notes represent accounts payable only. For accounts receivable, see [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote). + + ## Overview + + A bill credit note is issued by a supplier for the purpose of recording credit. For example, if a supplier was unable to fulfil an order that was placed by a business, or delivered damaged goods, they would issue a bill credit note. A bill credit note reduces the amount a business owes to the supplier. It can be refunded to the business or used to pay off future bills. + + In the Codat API, a bill credit note is an accounts payable record issued by a [supplier](https://docs.codat.io/lending-api#/schemas/Supplier). + + A bill credit note includes details of: + * The original and remaining credit. + * Any allocations of the credit against other records, such as [bills](https://docs.codat.io/lending-api#/schemas/Bill). + * The supplier that issued the bill credit note. + type: object + allOf: + - type: object + properties: + id: + type: string + description: Identifier for the bill credit note that is unique to a company in the accounting software. + example: 1509398f-98e2-436d-8a5d-c042e0c74ffc + billCreditNoteNumber: + type: string + nullable: true + description: Friendly reference for the bill credit note. + example: 91fe2a83-e161-4c21-929d-c5c10c4b07e5 + supplierRef: + $ref: '#/components/schemas/AccountingSupplier/definitions/supplierRef' + withholdingTax: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingBill/allOf/0/properties/withholdingTax/items' + totalAmount: + type: number + format: decimal + description: 'Total amount of credit that has been applied to the business'' account with the supplier, including discounts and tax.' + example: 805.78 + totalDiscount: + type: number + format: decimal + description: Total value of any discounts applied. + example: 0 + subTotal: + type: number + format: decimal + description: 'Total amount of the bill credit note, including discounts but excluding tax.' + example: 805.78 + totalTaxAmount: + type: number + format: decimal + description: Amount of tax included in the bill credit note. + example: 0 + discountPercentage: + type: number + format: decimal + description: Percentage rate of any discount applied to the bill credit note. + example: 0 + remainingCredit: + type: number + format: decimal + description: Amount of the bill credit note that is still outstanding. + example: 0 + status: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteStatus' + issueDate: + $ref: '#/components/schemas/DateTime' + description: Date the bill credit note was issued by the supplier. + example: '2022-03-15T00:00:00' + allocatedOnDate: + $ref: '#/components/schemas/DateTime' + nullable: true + description: Date the bill credit note was fully refunded or allocated. + example: '2022-09-15T16:35:00' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the bill credit note. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + nullable: true + description: 'An array of line ' + items: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem' + paymentAllocations: + nullable: true + type: array + description: An array of payment allocations. + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + createdFromRefs: + nullable: true + type: array + description: An array of records the credit note was created from. + items: + $ref: '#/components/schemas/AccountingRecordRef' + note: + type: string + nullable: true + description: Any additional information about the bill credit note. + example: 'Bill Credit Note with 1 line items, totaling 805.78' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - totalAmount + - totalDiscount + - subTotal + - totalTaxAmount + - discountPercentage + - status + definitions: + billCreditNoteStatus: + type: string + description: Current state of the bill credit note + enum: + - Unknown + - Draft + - Submitted + - Paid + - Void + - PartiallyPaid + example: Paid + billCreditNoteLineItem: + type: object + properties: + description: + type: string + nullable: true + description: 'Friendly name of each line item. For example, the goods or service for which credit has been received.' + unitAmount: + type: number + format: decimal + description: Unit price of the goods or service. + quantity: + type: number + format: decimal + description: Number of units of the goods or service for which credit has been received. + unitOfMeasurement: + type: string + nullable: true + description: 'The measurement which defines a unit for this item (e.g. ''kilogram'', ''litre'').' + discountAmount: + type: number + format: decimal + nullable: true + description: Value of any discounts applied. + subTotal: + type: number + format: decimal + nullable: true + description: 'Amount of credit associated with the line item, including discounts but excluding tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: Amount of tax associated with the line item. + totalAmount: + type: number + format: decimal + nullable: true + description: 'Total amount of the line item, including discounts and tax.' + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + discountPercentage: + type: number + format: decimal + nullable: true + description: Percentage rate of any discount applied to the line item. + taxRateRef: + title: Tax rate reference + type: object + description: |- + Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate. + + Found on: + + - Bill line items + - Bill Credit Note line items + - Credit Note line items + - Direct incomes line items + - Invoice line items + - Items + properties: + id: + type: string + description: Unique identifier for the tax rate in the accounting software. + name: + type: string + description: Name of the tax rate in the accounting software. + effectiveTaxRate: + type: number + format: decimal + description: Applicable tax rate. + itemRef: + description: Reference to the item the line is linked to. + title: Item reference + type: object + properties: + id: + minLength: 1 + type: string + description: Unique identifier for the item in the accounting software. + name: + type: string + nullable: true + description: Name of the item in the accounting software. + required: + - id + createdFromLineRef: + $ref: '#/components/schemas/AccountingBill/definitions/billLineItem/properties/purchaseOrderLineRef/allOf/0' + description: Reference to the line of the item that the current line was created from. + trackingCategoryRefs: + type: array + nullable: true + deprecated: true + description: Reference to the tracking categories to which the line item is linked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + tracking: + $ref: '#/components/schemas/AccountsPayableTracking' + required: + - unitAmount + - quantity + examples: + - id: 6a0e9dfb-87b0-47d3-aaaf-9753ae9e757d + billCreditNoteNumber: '14763237' + totalAmount: 693 + remainingCredit: 693 + status: Submitted + issueDate: '2019-02-18T16:03:07.268Z' + note: Track separately + currency: USD + lineItems: + - description: AcmeMagnet + unitAmount: 25 + discountAmount: 0 + quantity: 4 + subTotal: 100 + taxAmount: 10 + totalAmount: 110 + itemRef: + id: '3' + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + accountRef: + id: 3f267b10-757d-44c0-bef9-20f70cc8fbe3 + trackingCategoryRefs: + - id: department_1 + name: ACMERockets + - id: costcode_2 + name: ACM2-ACMESigns + createdFromLineRef: + - id: '8462' + dataType: bill + lineNumber: 1 + - description: ACMEDisintegratingPistol + unitAmount: 25 + discountAmount: 0 + quantity: 3 + subTotal: 75 + taxAmount: 7.5 + totalAmount: 82.5 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + accountRef: + id: 3f267b10-757d-44c0-bef9-20f70cc8fbe3 + - description: ACMEWhippedCreamDispenser + unitAmount: 52 + discountAmount: 0 + quantity: 6 + subTotal: 312 + taxAmount: 31.2 + totalAmount: 343.2 + itemRef: + id: 3691f3d9-0ff7-4358-8a93-bed31c1b4b03 + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + accountRef: + id: 3f267b10-757d-44c0-bef9-20f70cc8fbe3 + - description: ACMEJetPropelledPogoStick + unitAmount: 130 + discountAmount: 0 + quantity: 1 + subTotal: 130 + taxAmount: 27.3 + totalAmount: 157.3 + itemRef: + id: 075410d4-7edc-4936-ba52-9e1e43cbe300 + taxRateRef: + id: d606732b-db18-44d7-823b-7f15f42c32ea + accountRef: + id: 3f267b10-757d-44c0-bef9-20f70cc8fbe3 + supplierRef: + id: 67C6A7A1-5E84-4AC4-B950-24A114E379D0 + supplierName: Chin's Gas and Oil + createdFromLineRef: + id: '8462' + dataType: bills + line: 1 + AccountingBillCreditNotes: + title: 'Accounting: Bill credit notes' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingBillCreditNote' + - $ref: '#/components/schemas/PagingInfo' + AccountingBillPayment: + title: 'Accounting: Bill payment' + description: | + > **Bill payments or payments?** + > + > We distinguish between transactions where the company received money vs. paid money. If the transaction represents a company spending money (accounts payable) we call this a Bill payment. + > + > See [payments](https://docs.codat.io/lending-api#/schemas/Payment) for the accounts receivable equivalent of Bill payments, which covers [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote). + + ## Overview + + Bill payments include all accounts payable transaction data ([bills](https://docs.codat.io/lending-api#/schemas/Bill) and [credit notes against bills](https://docs.codat.io/lending-api#/schemas/BillCreditNote)). + + A bill payment in Codat usually represents an allocation of money within any customer accounts payable account. This includes, but is not strictly limited to: + + - A payment made against a bill — for example, a credit card payment, cheque payment, or cash payment. + - An allocation of a supplier's credit note to a bill or perhaps a refund. + - A bill payment made directly to an accounts payable account. This could be an overpayment or a prepayment, or a refund of a payment made directly to an accounts payable account. + + Depending on the bill payments which are allowed by the underlying accounting software, some of these types may be combined. Please see the example data section for samples of what these cases look like. + + In Codat, a bill payment contains details of: + + - When the bill payment was recorded in the accounting system. + - How much it is for and in the currency. + - Who the payment has been paid to, the _supplier_. + - The types of bill payments, the _line items_. + + Some accounting software give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's _expenses_. You can find these types of transactions in our [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) data model. + + Bill payments is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). + + --- + + ## Bill payment types + + ### Payment of a bill + + A payment paying a single bill should have the following properties: + + - A `totalAmount` indicating the amount of the bill that was paid. This is always positive. + - A `lines` array containing one element with the following properties: + - An `amount` equal to the `totalAmount` above. + - A `links` array containing one element with the following properties: + - A `type` indicating the type of link, in this case a `Bill`. + - An `id` containing the ID of the bill that was paid. + - An amount of `-totalAmount` (negative `totalAmount`), indicating that the entirety of the paid amount is allocated to the bill. + + ### Payment of multiple bills + + It is possible for one payment to pay multiple bills. This can be represented using two possible formats, depending on how the supplier keeps their books: + + 1. The payment has multiple entries in its **lines** array, one for each bill that is paid. Each line will follow the above example for paying a bill, and the rules detailed in the data model. + 2. The payment has a line with multiple links to each bill. This occurs when the proportion of the original payment allocated to each bill is not available. + + Each line is the same as those described above, with the **amount** indicating how much of the payment is allocated to the bill. The **amount** on the lines sum to the **totalAmount** on the payment. + + > Pushing batch payments to Xero + > + > When pushing a single bill payment to Xero to pay multiple bills, only the first format is supported—multiple entries in the payment **lines** array. + + ### Payments and refunds on account + + A payment on account, that is a payment that doesn’t pay a specific bill, has one entry in its lines array. + + The line has the following properties: + + - A **totalAmount** indicating the amount paid by a supplier or refunded to them by a company. A payment to the supplier is always negative. A refund is always positive. + - A **links** array containing one element with the following properties: + - A **type** indicating the type of link. For a payment this is `PaymentOnAccount`. For a refund this is `Refund`. + - The **id** containing the ID of the supplier. + - An amount for the link is `0` **totalAmount** or the amount of the payment or refund. + + It is possible to have a payment that is part on account and part allocated to a bill. Each line should follow the examples above. + + ### Using a credit note to pay a bill + + The payment of a bill using a credit note has one entry in its `lines` array. This **line** has the following properties: + + - An **amount** indicating the amount of money moved, which in this case is `0`, as the credit note and bill allocation must balance each other. + - A **links** array containing two elements: + - The first link has: + - A **type** indicating the type of link, in this case a `Bill`. + - An **id** containing the ID of the bill that was paid. + - The second link has: + - A **type** indicating the type of link, in this case a `CreditNote`. + - An **id** containing the ID of the credit note used by this payment. + + The **amount** field on the **line** equals the **totalAmount** on the payment. + + ### Refunding a credit note + + A bill payment refunding a credit note has one entry in its **lines** array. This line has the following properties: + + - An **amount** indicating the amount of the credit note that was refunded. This is always negative, indicating that it is a refund. + - A **links** array containing one element with the following properties: + - A **type** indicating the type of `link`, in this case a `CreditNote`. + - An **id** containing the ID of the credit note that was refunded. + + The **totalAmount** field on the payment equals the line's **amount** field. These are both negative, as this is money leaving accounts payable. + + ### Refunding a payment + + If a payment is refunded, for example, when a company overpaid a bill and the overpayment is returned, there are two payment records: + + - One for the incoming overpayment. + - Another for the outgoing refund. + + The payment issuing the refund is identified by the fact that the **totalAmount** is negative. This payment has one entry in its lines array that have the following properties: + + - An **amount** indicating the amount that was refunded. This is always negative. + - A **links** array containing one element with the following properties: + - A **type** indicating the type of a the link, in this case a `BillPayment`. + - An **id** containing the ID of the payment that was refunded. + + The **amount** field on the line equals the **totalAmount** on the payment and is negative as this is money leaving accounts payable. + + The payment that was refunded can be identified as it has a line where the `amount` on its `line` is positive and the type of the link is `Refund`. This payment may have several entries in its **lines** array if it was partly used to pay an bill. For example, a £1,050 payment paying a £1,000 bill with a refund of £50 has two lines: + + - One for £1,000 linked to the bill that was paid + - Another for £50 linked to the payment that refunded the over payment. This link is of type `Refund` but the ID corresponds to a bill payment. + + The line linked to the bill payment has the following properties: + + - An **amount** indicating the amount that was refunded. This is positive as its money that was added to accounts payable, but is balanced out by the negative amount of the refund. + - A **links** array containing one element with the following properties: + - A **type** indicating the type of the link, in this case a `Refund`. + - An **id** containing the ID of the payment that refunded this line. + + > Linked payments + > + > Not all accounting software support linked payments in this way. In these platforms you may see a payment on account and a refund on account. + + ## Foreign currencies + + There are two types of currency rate that are detailed in the bill payments data type: + + Payment currency rate: + + - Base currency of the accounts payable account. + - Foreign currency of the bill payment. + + Payment line link currency rate: + + - Base currency of the item that the link represents. + - Foreign currency of the payment. + + These two rates allow the calculation of currency loss or gain for any of the transactions affected by the payment lines. The second rate is used when a bill payment is applied to an item in a currency that does not match either: + + - The base currency for the accounts payable account. + - The currency of the item. + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the bill payment, unique for the company in the accounting software.' + example: 3d5a8e00-d108-4045-8823-7f342676cffa + supplierRef: + allOf: + - $ref: '#/components/schemas/AccountingSupplier/definitions/supplierRef' + - description: Supplier against which the payment is recorded in the accounting software. + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Account the payment is linked to in the accounting software. + totalAmount: + type: number + format: decimal + description: Amount of the payment in the payment currency. This value never changes and represents the amount of money that is paid into the supplier's account. + example: 1329.54 + currency: + allOf: + - $ref: '#/components/schemas/SourceAccount/properties/currency' + - description: ISO currency code in which the bill payment is recorded in the accounting software. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + date: + allOf: + - $ref: '#/components/schemas/DateTime' + - description: Date the bill payment was recorded in the accounting software. + note: + type: string + nullable: true + description: Additional information associated with the payment. + example: Bill Payment against bill c13e37b6-dfaa-4894-b3be-9fe97bda9f44 + paymentMethodRef: + allOf: + - $ref: '#/components/schemas/PaymentMethodRef' + - description: The Payment Method to which the payment is linked in the accounting software. + lines: + type: array + nullable: true + description: An array of bill payment lines. + items: + $ref: '#/components/schemas/AccountingBillPayment/definitions/billPaymentLine' + reference: + type: string + nullable: true + description: Additional information associated with the payment. + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - date + definitions: + billPaymentLine: + type: object + properties: + amount: + type: number + format: decimal + description: Amount in the bill payment currency. + links: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingBillPayment/definitions/billPaymentLineLink' + allocatedOnDate: + $ref: '#/components/schemas/DateTime' + description: AllocatedOnDate must be specified and be later than the issue date of the bill. + required: + - amount + billPaymentLineLink: + type: object + properties: + type: + $ref: '#/components/schemas/AccountingBillPayment/definitions/billPaymentLineLinkType' + id: + type: string + nullable: true + description: Unique identifier of the transaction represented by the link. + amount: + type: number + format: decimal + nullable: true + description: |- + Amount by which the balance of the linked entity is altered, in the currency of the linked entity. + + - A negative link amount reduces the outstanding amount on the accounts payable account. + - A positive link amount increases the outstanding amount on the accounts payable account. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + required: + - type + billPaymentLineLinkType: + description: Types of links to bill payment lines. + type: string + enum: + - Unknown + - Unlinked + - Bill + - Other + - CreditNote + - BillPayment + - PaymentOnAccount + - Refund + - ManualJournal + - Discount + examples: + - totalAmount: 1000 + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + - totalAmount: 0 + lines: + - amount: 0 + links: + - type: Bill + id: x + amount: -1000 + - type: CreditNote + id: 'y' + amount: 1000 + - totalAmount: 2000 + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + - amount: 1000 + links: + - type: PaymentOnAccount + id: 'y' + amount: -1000 + - totalAmount: -1000 + lines: + - amount: -1000 + links: + - type: CreditNote + id: 'y' + amount: 1000 + - totalAmount: -1000 + lines: + - amount: -1000 + links: + - type: PaymentOnAccount + id: 'y' + amount: 1000 + - totalAmount: 250 + lines: + - amount: 0 + links: + - type: Bill + id: x + amount: -750 + - type: CreditNote + id: 'y' + amount: 750 + - amount: 250 + links: + - type: Bill + id: x + amount: -250 + - totalAmount: 1000 + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + modifiedDate: '2022-10-23T00:00:00Z' + sourceModifiedDate: '2022-10-23T00:00:00Z' + - totalAmount: 2000 + lines: + - amount: 0 + links: + - type: Bill + id: x + amount: -1000 + - type: CreditNote + id: 'y' + amount: 1000 + - amount: 0 + links: + - type: Bill + id: x + amount: -1000 + - type: CreditNote + id: z + amount: 1000 + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + - amount: 1000 + links: + - type: PaymentOnAccount + id: customer-001 + amount: -1000 + - totalAmount: 0 + lines: + - amount: 0 + links: + - type: Bill + id: w + amount: -1000 + - type: Bill + id: x + amount: -1000 + - type: CreditNote + id: 'y' + amount: 1000 + - type: CreditNote + id: z + amount: 1000 + - totalAmount: 1000 + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + modifiedDate: '2022-10-23T00:00:00Z' + sourceModifiedDate: '2022-10-23T00:00:00Z' + - id: '001' + totalAmount: 5000 + date: '1901-01-01' + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + - amount: 4000 + links: + - type: PaymentOnAccount + id: 'y' + amount: -4000 + - id: '001' + totalAmount: 5000 + date: '1901-01-01' + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + - amount: 1000 + links: + - type: Bill + id: 'y' + amount: -1000 + - amount: 3000 + links: + - type: PaymentOnAccount + id: 'y' + amount: -3000 + - totalAmount: 500 + lines: + - amount: 500 + links: + - type: Bill + id: a + amount: -1000 + - type: Bill + id: b + amount: -1000 + - type: CreditNote + id: 'y' + amount: 750 + - type: CreditNote + id: z + amount: 750 + AccountingBillPayments: + title: 'Accounting: Bill payments' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingBillPayment' + - $ref: '#/components/schemas/PagingInfo' + AccountingBills: + title: 'Accounting: Bills' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingBill' + - $ref: '#/components/schemas/PagingInfo' + AccountingCashFlowStatement: + title: 'Accounting: Cash flow statement' + description: |- + > **Operating activities only** + > + > Currently, the cash flow statement shows cash that flows into and out of the company from operating activities *only*. Operating activities generate cash from the sale of goods or services. + + ## Overview + + A cash flow statement is a financial report that records all cash that is received or spent by a company during a given period. It gives you a clearer picture of the company’s performance, and their ability to pay creditors and finance growth. + + > **Cash flow statement or balance sheet?** + > + > Look at the cash flow statement to understand a company's ability to pay its bills. Although the balance sheet may show healthy earnings at a specific point in time, the cash flow statement allows you to see whether the company is meeting its financial commitments, such as paying creditors or its employees. + type: object + properties: + reports: + description: Array of cash flow statements. + type: array + items: + $ref: '#/components/schemas/AccountingCashFlowStatement/definitions/cashFlowStatement' + reportBasis: + $ref: '#/components/schemas/AccountingCashFlowStatement/definitions/reportBasis' + reportInput: + $ref: '#/components/schemas/AccountingCashFlowStatement/definitions/reportInput' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of all values in the cash flow statement. + mostRecentAvailableMonth: + $ref: '#/components/schemas/DateTime' + nullable: true + earliestAvailableMonth: + $ref: '#/components/schemas/DateTime' + nullable: true + required: + - reports + - reportBasis + - reportInput + definitions: + reportBasis: + title: Report basis + description: 'Accounting method used when aggregating the report data. In this case, `Cash`.' + type: string + enum: + - Unknown + - Accrual + - Cash + reportInput: + description: Accounting method used to prepare the cash flow statement. + type: string + enum: + - Unknown + - Indirect + - Direct + cashFlowStatement: + title: Cash flow statement + type: object + properties: + fromDate: + $ref: '#/components/schemas/DateTime' + description: Start date for the reporting period. + toDate: + $ref: '#/components/schemas/DateTime' + description: End date for the reporting period. + cashReceipts: + $ref: '#/components/schemas/ReportLine' + description: ReportLines for cash receipts from the sale of goods. + cashPayments: + $ref: '#/components/schemas/ReportLine' + description: ReportLines for cash payments to suppliers for the purchase of goods or services. + AccountingCompanyInfo: + title: 'Accounting: Company information' + description: |- + Company info provides standard details about a linked company such as their address, phone number, and company registration. + + > **Company information or companies?** + > + > Company information is standard information that is held in the accounting software about a company. `Companies` is an endpoint that lists businesses in the Codat system that have linked and shared their data sources. + type: object + properties: + companyName: + type: string + nullable: true + description: Name of the linked company. + accountingPlatformRef: + type: string + nullable: true + description: Identifier or reference for the company in the accounting software. + companyLegalName: + type: string + nullable: true + description: Registered legal name of the linked company. + addresses: + type: array + nullable: true + description: An array of Addresses. + items: + $ref: '#/components/schemas/AccountingAddress' + phoneNumbers: + type: array + nullable: true + description: An array of phone numbers. + items: + $ref: '#/components/schemas/PhoneNumber' + webLinks: + type: array + nullable: true + description: An array of weblinks. + items: + $ref: '#/components/schemas/WebLink' + ledgerLockDate: + $ref: '#/components/schemas/DateTime' + description: 'If set in the accounting software, the date (in the ISO 8601 date/time format) after which accounting transactions cannot be edited. Commonly used when books are closed at year-end.' + registrationNumber: + type: string + nullable: true + description: Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House. + taxNumber: + type: string + nullable: true + description: Company tax number. + financialYearStartDate: + $ref: '#/components/schemas/DateTime' + description: Start date of the financial year for the company. + baseCurrency: + type: string + nullable: true + description: Currency set in the accounting software of the linked company. Used by the currency rate. + sourceUrls: + type: object + additionalProperties: + type: string + nullable: true + nullable: true + description: |- + URL addresses for the accounting source. + + For example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero). + createdDate: + $ref: '#/components/schemas/DateTime' + description: Date the linked company was created in the accounting software. + supplementalData: + $ref: '#/components/schemas/SupplementalData' + examples: + - companyName: ACME Corporation + accountingPlatformRef: 4444e827-401b-4925-92cb-d79086bf3b6b + companyLegalName: ACME Corporation Ltd. + addresses: + - type: Billing + line1: Warner House + line2: 98 Theobald's Road + city: London + region: '' + country: United Kingdom + postalcode: WC1X 8WB + - type: Unknown + line1: 123 Sierra Way + line2: '' + city: San Pablo + region: CA + country: '' + postalCode: '87999' + phoneNumbers: + - number: 010 1234 5678 + type: Landline + webLinks: + - type: Website + url: 'https://www.wbsl.com/' + ledgerLockDate: '2019-03-04T12:08:01.881Z' + registrationNumber: '1234567890' + taxNumber: GB 123456789 + financialYearStartDate: '2019-04-01T00:00:00Z' + baseCurrency: USD + sourceUrls: + url1: 'https://go.xero.com/organisationlogin/default.aspx?shortcode=!rxs0Q' + url2: 'https://reporting.xero.com/!rxs0Q' + createdDate: '2020-02-03T16:42:02Z' + AccountingCreateAccountResponse: + title: 'Accounting: Create account response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingAccount' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreateBankAccountResponse: + title: 'Accounting: Create bank account response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingBankAccount' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreateBankTransactions: + title: 'Accounting: Create bank account transactions' + type: object + properties: + accountId: + type: string + description: Unique identifier for a bank account. + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - '7110701885' + - EILBDVJVNUAGVKRQ + - Checking 0202 + transactions: + type: array + items: + $ref: '#/components/schemas/AccountingCreateBankTransactions/definitions/CreateBankAccountTransaction' + definitions: + CreateBankAccountTransaction: + title: Bank account transaction + type: object + properties: + id: + type: string + description: 'Identifier for the bank account transaction, unique for the company in the accounting software.' + amount: + type: number + format: decimal + description: The amount transacted in the bank transaction. + date: + $ref: '#/components/schemas/DateTime' + description: + nullable: false + type: string + description: Description of the bank transaction. + balance: + type: number + format: decimal + description: The remaining balance in the account with ID `accountId`. + AccountingCreateBankTransactionsResponse: + title: 'Accounting: Create/update bank transaction response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingCreateBankTransactions' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreateDirectCostResponse: + title: 'Accounting: Create direct cost response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingDirectCost' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreatePaymentResponse: + title: 'Accounting: Create payment response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingPayment' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreateSupplierResponse: + title: 'Accounting: Create supplier response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingSupplier' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreateTransferResponse: + title: 'Accounting: Create transfer response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingTransfer' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreditNote: + title: 'Accounting: Credit note' + description: |- + ## Overview + + Think of a credit note as a voucher issued to a customer. It is a reduction that can be applied against one or multiple invoices. A credit note can either reduce the amount owed or cancel out an invoice entirely. + + In the Codat system a credit note is issued to a [customer's](https://docs.codat.io/lending-api#/schemas/Customer) accounts receivable. + + It contains details of: + * The amount of credit remaining and its status. + * Payment allocations against the payments type, in this case an invoice. + * Which customers the credit notes have been issued to. + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the credit note, unique to the company in the accounting software.' + creditNoteNumber: + type: string + nullable: true + description: Friendly reference for the credit note. + customerRef: + $ref: '#/components/schemas/AccountingCustomer/definitions/accountingCustomerRef' + description: Reference to the customer the credit note has been issued to. + withholdingTax: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingBill/allOf/0/properties/withholdingTax/items' + totalAmount: + type: number + format: decimal + description: Total amount of credit that has been applied to the customer's accounts receivable + totalDiscount: + type: number + format: decimal + description: Any discounts applied to the credit note amount. + subTotal: + type: number + format: decimal + description: 'Value of the credit note, including discounts and excluding tax.' + additionalTaxAmount: + type: number + format: decimal + description: Additional tax amount applied to credit note. + additionalTaxPercentage: + type: number + format: decimal + description: Percentage rate of any additional tax applied to the credit note. + totalTaxAmount: + type: number + format: decimal + description: Any tax applied to the credit note amount. + discountPercentage: + type: number + format: decimal + description: Percentage rate (from 0 to 100) of discounts applied to the credit note. + remainingCredit: + type: number + format: decimal + description: Unused balance of totalAmount originally raised. + status: + $ref: '#/components/schemas/AccountingCreditNote/definitions/creditNoteStatus' + description: Current state of the credit note. + issueDate: + $ref: '#/components/schemas/DateTime' + description: Date of the credit note as recorded in the accounting system. + allocatedOnDate: + $ref: '#/components/schemas/DateTime' + description: Date on which the credit note was fully allocated. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the credit note. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingCreditNote/definitions/creditNoteLineItem' + paymentAllocations: + type: array + nullable: true + description: An array of payment allocations. + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + note: + type: string + nullable: true + description: 'Any additional information about the credit note. Where possible, Codat links to a data field in the accounting software that is publicly available. This means that the contents of the note field are included when a credit note is emailed from the accounting software to the customer.' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - totalAmount + - totalDiscount + - subTotal + - totalTaxAmount + - discountPercentage + - remainingCredit + - status + definitions: + creditNoteStatus: + title: Credit note status + description: Current state of the credit note. + type: string + enum: + - Unknown + - Draft + - Submitted + - Paid + - Void + - PartiallyPaid + creditNoteLineItem: + type: object + properties: + description: + type: string + nullable: true + description: 'Friendly name of each line item. For example, the goods or service for which credit has been issued.' + unitAmount: + type: number + format: decimal + description: Unit price of the goods or service. + quantity: + type: number + format: decimal + description: Number of units of the goods or service for which credit has been issued. + discountAmount: + type: number + format: decimal + nullable: true + description: Value of any discounts applied. + subTotal: + type: number + format: decimal + nullable: true + description: 'Amount of credit associated with the line item, including discounts but excluding tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: Amount of tax associated with the line item. + totalAmount: + type: number + format: decimal + nullable: true + description: 'Total amount of the line item, including discounts and tax.' + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Reference to the account to which the line item is linked. + discountPercentage: + type: number + format: decimal + nullable: true + description: Percentage rate of any discount applied to the line item. + taxRateRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/taxRateRef' + description: Reference to the tax rate to which the line item is linked. + itemRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/itemRef' + description: Reference to the item the line is linked to. + trackingCategoryRefs: + type: array + nullable: true + deprecated: true + description: Reference to the tracking categories to which the line item is linked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + tracking: + $ref: '#/components/schemas/AccountsReceivableTracking' + isDirectIncome: + type: boolean + description: The credit note is a direct income if `True`. + required: + - unitAmount + - quantity + examples: + - - id: 0316bd24-8a01-4a3a-a0e5-a73f14ebcbec + creditNoteNumber: '5239277' + customerRef: + id: b5511228-b9ef-4713-91b1-ad2cf60eadb1 + companyName: Tool Hire Company + totalAmount: 550 + totalDiscount: 0 + subTotal: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 550 + status: Submitted + issueDate: '2018-03-28T21:28:58.249Z' + allocatedOnDate: null + note: More information available on request. + currency: USD + currencyRate: null + lineItems: + - description: Anvil10000Lb + unitAmount: 50 + quantity: 10 + discountAmount: 0 + subTotal: 500 + taxAmount: 50 + totalAmount: 550 + accountRef: + id: 3f267b10-757d-44c0-bef9-20f70cc8fbe3 + name: null + discountPercentage: null + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: null + itemRef: + id: '1' + name: null + paymentAllocations: [] + modifiedDate: null + sourceModifiedDate: null + AccountingCreditNotes: + title: 'Accounting: Credit notes' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingCreditNote' + - $ref: '#/components/schemas/PagingInfo' + AccountingCustomer: + title: 'Accounting: Customer' + description: | + ## Overview + + A customer is a person or organisation that buys goods or services. From the Customers endpoints, you can retrieve a [list of all the customers of a company](https://api.codat.io/swagger/index.html#/Customers/get_companies__companyId__data_customers). + + Customers' data links to accounts receivable [invoices](https://docs.codat.io/lending-api#/schemas/Invoice). + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the customer, unique to the company in the accounting software.' + customerName: + type: string + nullable: true + description: 'Name of the customer as recorded in the accounting system, typically the company name.' + contactName: + type: string + nullable: true + description: Name of the main contact for the identified customer. + emailAddress: + type: string + nullable: true + description: Email address the customer can be contacted by. + defaultCurrency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Default currency the transactional data of the customer is recorded in. + phone: + type: string + nullable: true + description: Phone number the customer can be contacted by. + addresses: + type: array + nullable: true + description: An array of Addresses. + items: + $ref: '#/components/schemas/AccountingAddress' + contacts: + type: array + nullable: true + description: An array of Contacts. + items: + $ref: '#/components/schemas/AccountingCustomer/definitions/contact' + registrationNumber: + type: string + nullable: true + description: 'Company number. In the UK, this is typically the Companies House company registration number.' + taxNumber: + type: string + nullable: true + description: Company tax number. + status: + $ref: '#/components/schemas/AccountingCustomer/definitions/customerStatus' + description: Current state of the customer. + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - status + definitions: + accountingCustomerRef: + type: object + properties: + id: + minLength: 1 + type: string + description: '`id` from the Customers data type' + companyName: + type: string + nullable: true + description: '`customerName` from the Customer data type' + required: + - id + customerStatus: + description: Status of customer. + type: string + enum: + - Unknown + - Active + - Archived + contact: + type: object + properties: + name: + type: string + nullable: true + description: Name of a contact for a customer. + email: + type: string + nullable: true + description: Email of a contact for a customer. + phone: + type: array + nullable: true + description: An array of Phone numbers. + items: + $ref: '#/components/schemas/PhoneNumber' + address: + $ref: '#/components/schemas/AccountingAddress' + description: An object of Address information. + status: + $ref: '#/components/schemas/AccountingCustomer/definitions/customerStatus' + modifiedDate: + $ref: '#/components/schemas/DateTime' + required: + - status + AccountingCustomers: + title: 'Accounting: Customers' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingCustomer' + - $ref: '#/components/schemas/PagingInfo' + AccountingDirectCost: + title: 'Accounting: Direct cost' + description: |- + > **Language tip:** Direct costs may also be referred to as **Spend transactions**, **Spend money transactions**, or **Payments** in various accounting software. + + ## Overview + + Direct costs are money that leave the business without impacting Accounts Payable, and refunds associated with such transactions. + + Direct costs include: + * Purchasing an item and paying it off at the point of the purchase + * Receiving cash from a refunded item if the refund is made by the supplier + + Direct costs is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier of the direct cost, unique for the company.' + - $ref: '#/components/schemas/AccountingDirectCost/definitions/directCostPrototype' + - properties: + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + directCostPrototype: + type: object + properties: + reference: + type: string + nullable: true + description: User-friendly reference for the direct cost. + note: + type: string + nullable: true + description: A note attached to the direct cost. + contactRef: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine/properties/contactRef' + description: A customer or supplier associated with the direct cost. + issueDate: + $ref: '#/components/schemas/DateTime' + description: Date of the direct cost as recorded in the accounting software.Date of the direct cost as recorded in the accounting software. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the direct cost. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + description: An array of line items. + items: + $ref: '#/components/schemas/AccountingDirectCost/definitions/directCostLineItem' + paymentAllocations: + type: array + description: An array of payment allocations. + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + subTotal: + type: number + format: decimal + description: 'The total amount of the direct costs, excluding any taxes.' + taxAmount: + type: number + format: decimal + description: The total amount of tax on the direct costs. + totalAmount: + type: number + format: decimal + description: 'The amount of the direct costs, inclusive of tax.' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + required: + - issueDate + - currency + - lineItems + - paymentAllocations + - subTotal + - taxAmount + - totalAmount + directCostLineItem: + type: object + properties: + description: + type: string + nullable: true + description: Friendly name of the goods or services. + unitAmount: + type: number + format: decimal + description: |- + Price of each unit of goods or services. + Note: If the platform does not provide this information, the unit amount will be mapped to the total amount. + quantity: + type: number + format: decimal + description: |- + Number of units of goods or services received. + + Note: If the platform does not provide this information, the quantity will be mapped as 1. + discountAmount: + type: number + format: decimal + nullable: true + description: Discount amount for the line before tax. + discountPercentage: + type: number + format: decimal + nullable: true + description: Discount percentage for the line before tax. + subTotal: + type: number + format: decimal + nullable: true + description: 'Amount of the line, inclusive of discounts but exclusive of tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: Amount of tax for the line. + totalAmount: + type: number + format: decimal + nullable: true + description: 'Total amount of the line, including tax.' + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Reference to the account to which the line item is linked. + taxRateRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/taxRateRef' + description: Reference to the tax rate to which the the line item is linked. + itemRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/itemRef' + description: 'Reference to the product, service type, or inventory item to which the direct cost is linked.' + trackingCategoryRefs: + type: array + nullable: true + deprecated: true + description: Collection of categories against which this direct cost is tracked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + tracking: + $ref: '#/components/schemas/AccountingDirectCost/definitions/tracking' + required: + - unitAmount + - quantity + tracking: + title: Invoiceable tracking + required: + - recordRefs + type: object + properties: + recordRefs: + type: array + items: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine/properties/tracking/definitions/trackingRecordRef' + invoiceTo: + $ref: '#/components/schemas/AccountingRecordRef' + additionalProperties: false + invoiceTo: + type: object + title: Invoice to + description: Links to the customer the direct cost is associated. + properties: + id: + type: string + description: '''id'' of the underlying record or data type.' + dataType: + type: string + description: Name of underlying data type. + enum: + - customers + example: customers + AccountingDirectCosts: + title: 'Accounting: Direct costs' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingDirectCost' + - $ref: '#/components/schemas/PagingInfo' + AccountingDirectIncome: + title: 'Accounting: Direct income' + description: | + > **Language tip:** Direct incomes may also be referred to as **Receive transactions**, **Receive money transactions**, **Sales receipts**, or **Cash sales** in various accounting software. + + ## Overview + + Direct incomes are incomes received directly from the business' operations. For example, cash sales of items to a customer, referral commissions, and service fee refunds are considered direct incomes made at the point of sale. + + Direct incomes include: + + - Selling an item directly to a contact, and receiving payment at the point of the sale. + - Refunding an item sold at the point of sale in cash to a contact. + + Direct incomes is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier of the direct income, unique for the company.' + reference: + type: string + nullable: true + description: User-friendly reference for the direct income. + note: + type: string + nullable: true + description: An optional note on the direct income that can be used to assign the direct income with a reference ID in your application. + contactRef: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine/properties/contactRef' + description: A customer or supplier associated with the direct income. + issueDate: + $ref: '#/components/schemas/DateTime' + description: The date of the direct income as recorded in the accounting software. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency of the direct income. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + description: An array of line items. + items: + $ref: '#/components/schemas/AccountingDirectIncome/definitions/directIncomeLineItem' + paymentAllocations: + type: array + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + subTotal: + type: number + format: decimal + description: 'The total amount of the direct incomes, excluding any taxes.' + taxAmount: + type: number + format: decimal + description: The total amount of tax on the direct incomes. + totalAmount: + type: number + format: decimal + description: 'The amount of the direct incomes, inclusive of tax.' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - issueDate + - currency + - lineItems + - paymentAllocations + - subTotal + - taxAmount + - totalAmount + definitions: + directIncomeLineItem: + type: object + properties: + description: + type: string + nullable: true + description: A user-friendly name of the goods or services. + unitAmount: + type: number + format: decimal + description: |- + The price of each unit of goods or services. + Note: If the platform does not provide this information, the unit amount will be mapped to the total amount. + quantity: + type: number + format: decimal + description: |- + The number of units of goods or services received. + + Note: If the platform does not provide this information, the quantity will be mapped as 1. + discountAmount: + type: number + format: decimal + nullable: true + description: Discount amount for the line before tax. + discountPercentage: + type: number + format: decimal + nullable: true + description: Discount percentage for the line before tax. + subTotal: + type: number + format: decimal + nullable: true + description: 'The amount of the line, inclusive of discounts, but exclusive of tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: |- + The amount of tax for the line. + Note: If the platform does not provide this information, the quantity will be mapped as 0.00. + totalAmount: + type: number + format: decimal + nullable: true + description: 'The total amount of the line, including tax.' + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Reference to the account to which the line item is linked. + taxRateRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/taxRateRef' + description: Reference to the tax rate to which the line item is linked. + itemRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/itemRef' + description: 'Reference to the product, service type, or inventory item to which the direct cost is linked.' + trackingCategoryRefs: + type: array + nullable: true + description: An array of categories against which this direct cost is tracked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + required: + - unitAmount + - quantity + AccountingDirectIncomes: + title: 'Accounting: Direct incomes' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingDirectIncome' + - $ref: '#/components/schemas/PagingInfo' + AccountingInvoice: + title: 'Accounting: Invoice' + description: |- + > **Invoices or bills?** + > + > We distinguish between invoices where the company *owes money* vs. *is owed money*. If the company issued an invoice, and is owed money (accounts receivable) we call this an Invoice. + > + > See [Bills](https://docs.codat.io/lending-api#/schemas/Bill) for the accounts payable equivalent of bills. + + ## Overview + + An invoice is an itemized record of goods sold or services provided to a [customer](https://docs.codat.io/lending-api#/schemas/Customer). + + In Codat, an invoice contains details of: + + - The timeline of the invoice—when it was raised, marked as paid, last edited, and so on. + - How much the invoice is for, what portion of the invoice is tax or discounts, and what currency the amounts are represented in. + - Who the invoice has been raised to; the _customer_. + - The breakdown of what the invoice is for; the _line items_. + - Any [payments](https://docs.codat.io/lending-api#/schemas/Payment) assigned to the invoice; the _payment allocations_. + + > **Invoice PDF downloads** + > + > You can download a PDF version of an invoice for supported integrations. + > + > The filename will be invoice-{number}.pdf. + + > **Referencing an invoice in Sage 50 and ClearBooks** + > + > In Sage 50 and ClearBooks, you may prefer to use the **invoiceNumber** to identify an invoice rather than the invoice **id**. Each time a draft invoice is submitted or printed, the draft **id** becomes void and a submitted invoice with a new **id** exists in its place. In both platforms, the **invoiceNumber** should remain the same. + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the invoice, unique to the company in the accounting software.' + invoiceNumber: + type: string + nullable: true + description: 'Friendly reference for the invoice. If available, this appears in the file name of invoice attachments.' + customerRef: + $ref: '#/components/schemas/AccountingCustomer/definitions/accountingCustomerRef' + description: Reference to the customer the invoice has been issued to. + salesOrderRefs: + type: array + nullable: true + description: List of references to related Sales orders. + items: + title: Sales order reference + type: object + properties: + id: + type: string + description: Unique identifier to a record in `dataType`. + dataType: + type: string + description: The underlying data type associated to the reference `id`. + enum: + - salesOrders + issueDate: + $ref: '#/components/schemas/DateTime' + description: Date of the invoice as recorded in the accounting system. + dueDate: + $ref: '#/components/schemas/DateTime' + description: Date the customer is due to be paid by. + paidOnDate: + $ref: '#/components/schemas/DateTime' + description: 'Date the invoice was marked as paid in the accounting system. If this field is not available from the accounting software, it is calculated by Codat using associated payments.' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the invoice. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + nullable: true + description: An array of line items. + items: + $ref: '#/components/schemas/AccountingInvoice/definitions/invoiceLineItem' + paymentAllocations: + type: array + nullable: true + description: An array of payment allocations. + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + withholdingTax: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingBill/allOf/0/properties/withholdingTax/items' + totalDiscount: + type: number + format: decimal + nullable: true + description: Numerical value of discounts applied to the invoice. + subTotal: + type: number + format: decimal + nullable: true + description: Total amount of the invoice excluding any taxes. + additionalTaxAmount: + type: number + format: decimal + description: Additional tax amount applied to invoice. + additionalTaxPercentage: + type: number + format: decimal + description: Percentage rate of any additional tax applied to the invoice. + totalTaxAmount: + type: number + format: decimal + description: Amount of tax on the invoice. + totalAmount: + type: number + format: decimal + description: 'Amount of the invoice, inclusive of tax.' + amountDue: + type: number + format: decimal + description: Amount outstanding on the invoice. + discountPercentage: + type: number + format: decimal + nullable: true + description: 'Percentage rate (from 0 to 100) of discounts applied to the invoice. For example: A 5% discount will return a value of `5`, not `0.05`.' + status: + $ref: '#/components/schemas/AccountingInvoice/definitions/invoiceStatus' + note: + type: string + nullable: true + description: 'Any additional information about the invoice. Where possible, Codat links to a data field in the accounting software that is publicly available. This means that the contents of the note field are included when an invoice is emailed from the accounting software to the customer.' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - issueDate + - totalTaxAmount + - totalAmount + - amountDue + - status + definitions: + invoiceLineItem: + type: object + properties: + description: + type: string + nullable: true + description: Friendly name of the goods or services provided. + unitAmount: + type: number + format: decimal + description: Price of each unit of goods or services. + quantity: + type: number + format: decimal + description: Number of units of goods or services provided. + discountAmount: + type: number + format: decimal + nullable: true + description: Numerical value of any discounts applied. + subTotal: + type: number + format: decimal + nullable: true + description: 'Amount of the line, inclusive of discounts but exclusive of tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: Amount of tax for the line. + totalAmount: + type: number + format: decimal + nullable: true + description: 'Total amount of the line, including tax. When pushing invoices to Xero, the total amount is exclusive of tax to allow automatic calculations if a tax rate or tax amount is not specified.' + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Reference to the account to which the line item is linked. + discountPercentage: + type: number + format: decimal + nullable: true + description: Percentage rate (from 0 to 100) of any discounts applied to the unit amount. + taxRateRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/taxRateRef' + description: Reference to the tax rate to which the line item is linked. + itemRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/itemRef' + description: Reference to the item the line is linked to. + trackingCategoryRefs: + type: array + nullable: true + description: Reference to the tracking categories to which the line item is linked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + tracking: + $ref: '#/components/schemas/AccountsReceivableTracking' + isDirectIncome: + type: boolean + description: The invoice is a direct income if `True`. + required: + - unitAmount + - quantity + invoiceStatus: + type: string + enum: + - Unknown + - Draft + - Submitted + - PartiallyPaid + - Paid + - Void + description: |- + Current state of the invoice: + + - `Draft` - Invoice hasn't been submitted to the supplier. It may be in a pending state or is scheduled for future submission, for example by email. + - `Submitted` - Invoice is no longer a draft. It has been processed and, or, sent to the customer. In this state, it will impact the ledger. It also has no payments made against it, meaning `amountDue` will usually equal `totalAmount` (unless tax is witheld). + - `PartiallyPaid` - The balance paid against the invoice is positive, but less than the total invoice amount, meaning `0 < amountDue < totalAmount`. + - `Paid` - Invoice is paid in full. This includes if the invoice has been credited or overpaid, meaning `amountDue == 0`. + - `Void` - An invoice can become Void when it's deleted, refunded, written off, or cancelled. A voided invoice may still be PartiallyPaid, and so all outstanding amounts on voided invoices are removed from the accounts receivable account. + AccountingInvoices: + title: 'Accounting: Invoices' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingInvoice' + - $ref: '#/components/schemas/PagingInfo' + AccountingJournal: + title: 'Accounting: Journal' + description: | + > **Language tip:** For line items, or individual transactions, of a company's financial documents, refer to the [Journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) data type + + ## Overview + + In accounting software, journals are used to record all the financial transactions of a company. Each transaction in a journal is represented by a separate [journal entry](https://docs.codat.io/lending-api#/schemas/JournalEntry). These entries are used to create the general ledger, which is then used to create the financial statements of a business. + + When a company records all their transactions in a single journal, it can become large and difficult to maintain and track. This is why large companies often use multiple journals (also known as subjournals) to categorize and manage journal entries. + + Such journals can be divided into two categories: + + - Special journals: journals used to record specific types of transactions; for example, a purchases journal, a sales journal, or a cash management journal. + - General journals: journals used to record transactions that fall outside the scope of the special journals. + + Multiple journals or subjournals are used in the following Codat integrations: + + - [Sage Intacct](https://docs.codat.io/integrations/accounting/sage-intacct/accounting-sage-intacct) (mandatory) + - [Exact Online](https://docs.codat.io/integrations/accounting/exact-online/accounting-exact-online) (mandatory) + - [Oracle NetSuite](https://docs.codat.io/integrations/accounting/netsuite/accounting-netsuite) (optional) + + > When pushing journal entries to an accounting software that doesn’t support multiple journals (multi-book accounting), the entries will be linked to the platform-generic journal. The Journals data type will only include one object. + type: object + allOf: + - type: object + properties: + id: + type: string + description: Journal ID. + - $ref: '#/components/schemas/AccountingJournal/definitions/journalPrototype' + - properties: + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + journalPrototype: + type: object + properties: + journalCode: + type: string + nullable: true + description: Native journal number or code. + name: + type: string + nullable: true + description: |- + Journal name. + The maximum length for a journal name is 256 characters. All characters above that number will be truncated. + type: + type: string + nullable: true + description: The type of the journal. + parentId: + type: string + nullable: true + description: |- + Parent journal ID. + If the journal is a parent journal, this value is not present. + hasChildren: + type: boolean + description: 'If the journal has child journals, this value is true. If it doesn’t, it is false.' + createdOn: + $ref: '#/components/schemas/DateTime' + description: Journal creation date. + status: + $ref: '#/components/schemas/AccountingJournal/definitions/journalStatus' + journalRef: + title: Journal reference + type: object + additionalProperties: false + description: Links journal entries to the relevant journal in accounting integrations that use multi-book accounting (multiple journals). + properties: + id: + minLength: 1 + type: string + description: GUID of the underlying journal. + name: + type: string + maxLength: 256 + nullable: true + description: Name of journal + required: + - id + journalStatus: + type: string + description: Current journal status. + enum: + - Unknown + - Active + - Archived + AccountingJournalEntries: + title: 'Accounting: Journal entries' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingJournalEntry' + - $ref: '#/components/schemas/PagingInfo' + AccountingJournalEntry: + title: 'Accounting: Journal entry' + description: |- + > **Language tip:** For the top-level record of a company's financial transactions, refer to the [Journals](https://docs.codat.io/lending-api#/schemas/Journal) data type + + ## Overview + + A journal entry report shows the entries made in a company's general ledger, or [accounts](https://docs.codat.io/lending-api#/schemas/Account), when transactions are approved. The journal line items for each journal entry should balance. + + A journal entry line item is a single transaction line on the journal entry. For example: + + - When a journal entry is recording a receipt of cash, the credit to accounts receivable and the debit to cash are separate line items. + - When a company needs to recognise revenue from an annual contract on a monthly basis, on receipt of cash for month one, they make a debit to deferred income and a credit to revenue. + + In Codat a journal entry contains details of: + + - The date on which the entry was created and posted. + - Itemised lines, including amounts and currency. + - A reference to the associated accounts. + - A reference to the underlying record. For example, the invoice, bill, or other data type that triggered the posting of the journal entry to the general ledger. + + > **Pushing journal entries** + > Codat only supports journal entries in the base currency of the company that are pushed into accounts denominated in the same base currency. + type: object + allOf: + - type: object + properties: + id: + type: string + description: Unique identifier of the journal entry for the company in the accounting software. + description: + type: string + nullable: true + description: Optional description of the journal entry. + postedOn: + $ref: '#/components/schemas/DateTime' + description: |- + Date on which the journal entry was posted to the accounting software, and had an impact on the general ledger. This may be different from the creation date. + + For example, a user creates a journal entry on Monday and saves it as draft, which has no impact on the general ledger. On Thursday, they return to the entry and post it. + + The **createdOn** date shows as Monday. + The **postedOn** date shows as Thursday. + Journal entries can also be backdated, so the **postedOn** date may be earlier than the **createdOn** date. + createdOn: + $ref: '#/components/schemas/DateTime' + description: Date on which the journal was created in the accounting software. + updatedOn: + $ref: '#/components/schemas/DateTime' + description: Date on which the journal was last updated in the accounting software. + journalRef: + $ref: '#/components/schemas/AccountingJournal/definitions/journalRef' + journalLines: + type: array + nullable: true + description: An array of journal lines. + items: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine' + recordRef: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalEntryRecordRef' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + journalLine: + type: object + properties: + description: + type: string + nullable: true + description: Description of the journal line item. + netAmount: + type: number + format: decimal + description: 'Amount for the journal line. Debit entries are considered positive, and credit entries are considered negative.' + transactionAmount: + type: number + format: decimal + description: The amount in the original transaction currency. + currency: + type: string + nullable: true + description: Currency for the journal line item. + transactionCurrency: + type: string + nullable: true + description: Currency of the original transaction. + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + tracking: + description: 'List of record refs associated with the tracking information for the line (eg to a Tracking Category, or customer etc.)' + title: Tracking + type: object + properties: + recordRefs: + type: array + items: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine/properties/tracking/definitions/trackingRecordRef' + nullable: true + definitions: + trackingRecordRef: + type: object + title: Record reference + description: Links to the customer or tracking category. + properties: + id: + type: string + description: '''id'' of the underlying record or data type.' + dataType: + type: string + description: Name of underlying data type. + enum: + - customers + - suppliers + - trackingCategories + example: trackingCategories + contactRef: + title: Contact reference + type: object + properties: + id: + minLength: 1 + type: string + description: Unique identifier for a customer or supplier. + dataType: + type: string + nullable: true + description: Allowed name of the 'dataType'. + enum: + - customers + - suppliers + required: + - id + required: + - netAmount + journalEntryRecordRef: + type: object + title: Record reference + description: Links a journal entry to the underlying record that created it. + properties: + id: + type: string + description: '''id'' of the underlying record or data type.' + dataType: + type: string + description: Name of underlying data type. + enum: + - bankTransactions + - billCreditNotes + - billPayments + - bills + - creditNotes + - directCosts + - directIncomes + - invoices + - journalEntries + - payments + - transfers + example: transfers + AccountingJournals: + title: 'Accounting: Journals' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingJournal' + - $ref: '#/components/schemas/PagingInfo' + AccountingPayment: + title: 'Accounting: Payment' + description: "\uFEFF> **Payments or bill payments?**\n>\n> In Codat, payments represent accounts receivable only. For accounts payable, see [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment). These include [bills](https://docs.codat.io/lending-api#/schemas/Bill) and credit notes against bills.\n\n## Overview\n\nPayments include all accounts receivable transaction data. This includes [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote).\n\nA payment in Codat usually represents an allocation of money within any customer accounts receivable account. This includes, but is not strictly limited to:\n\n- A payment made against an invoice, like a credit card, cheque, or cash payment.\n- An allocation of a customer's credit note, either to an invoice or maybe a refund.\n- A payment made directly to that accounts receivable account. This might be an overpayment or a prepayment. It might also be the refund of a payment made directly to an accounts receivable account.\n\nDepending on the payments allowed by the underlying accounting software, some payment types may be combined. Please see the example for more details.\n\nIn Codat, a payment contains details of:\n\n- When the payment was recorded in the accounting system.\n- How much it is for and in what currency that amount is in.\n- Who the payment was _paid by_ – the _customer_.\n- The payment method used.\n- The breakdown of the types of payments – the _line items_.\n\nPayments is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).\n\n## Payment types\n\n## Payment of an invoice\n\nA payment paying a single invoice has one entry in its `lines` array. This **line** has the following properties:\n\n- An _amount_ that indicates the amount of the invoice that was paid. This is always positive.\n- A **links** array containing one element with the following properties:\n - A **type** that indicates the type of **link**, in this case an `Invoice`.\n - An **id** that contains the ID of the invoice that was paid.\n - An **amount** for the link. The sum of the **line.amount** and the **links.amount** must equal `0`.\n\nThe **amount** field on the **line** equals the **totalAmount** on the payment.\n\n## Payment of multiple invoices\n\nA single payment can pay multiple invoices. This can be represented in one of two formats depending on how the customer keeps their books:\n\n- The payment has multiple entries in its **lines** array, one for each invoice that is paid. Each line follows the example and rules described in [Payment of an invoice](#payment-of-an-invoice).\n- The payment has a line with multiple links to each invoice. This occurs when the proportion of the original payment allocated to each invoice is not available.\n\nEach **line** has the same properties as those described in [Payment of an invoice](#payment-of-an-invoice), with the **amount** indicating how much of the payment was allocated to the invoice. The sum of line amounts equals the **totalAmount** on the payment.\n\n## Payments and refunds on account\n\nA payment on account, that is a payment that doesn’t pay a specific invoice, has one entry in its lines array. The **line** has the following properties:\n\n- A **totalAmount** that indicates the amount paid by a customer or refunded to them by a company. A payment to the customer is always negative. A refund is always positive.\n- A **links** array containing one element with the following properties:\n- A **type** that indicates the type of link. For a payment this is `PaymentOnAccount`. For a refund this is `Refund`.\n- The **id** containing the ID of the customer.\n- The **amount** for the link is `0` – the **totalAmount** _or_ the amount of the payment or refund.\n\nIt is possible to have a payment that is part _on account_ and part _allocated_ to an invoice. Each line should follow the examples above.\n\n## Using a credit note to pay an invoice\n\nThe payment of an invoice using a credit note has one entry in its **lines** array. This **line** has the following properties:\n\n- An **amount** that indicates the amount of money moved, which in this case is `0`, as the credit note and invoice allocation must balance each other.\n- A **links** array containing two elements:\n - The first **link** has:\n - A **type** that indicates the type of **link**, in this case an `Invoice`.\n - An **id** that contains the ID of the invoice that was paid.\n - The second **link** has:\n - A **type** that indicates the type of **link**, in this case a `CreditNote`.\n - An **id** that contains the ID of the credit note used by this payment.\n\nThe **amount** field on the **line** equals the **totalAmount** on the payment.\n\n## Refunding a credit note\n\nA payment refunding a credit note has one entry in its **lines** array. This **line** has the following properties:\n\n- An **amount** that indicates the amount of the credit note that was refunded. This is always negative for a refund.\n- A **links** array that contains one element with the following properties:\n - A **type** that indicates the type of **link**, in this case a `CreditNote`.\n - An **id** that contains the ID of the credit note that was refunded.\n\nThe **totalAmount** field on the payment equals the **amount** field of the **line**. These are both negative, as this is money leaving accounts receivable.\n\n## Refunding a payment\n\nIf a payment is refunded, for example, if a customer overpaid an invoice and the overpayment is returned to the customer, there are two payment records:\n\n- One for the incoming over payment.\n- Another for the outgoing refund.\n\nThe payment issuing the refund has a negative **totalAmount**. This payment also has one entry in its lines array with the following properties:\n\n- An **amount** that indicates the amount that was refunded. This is always negative.\n- A **links** array that contains one element with the following properties:\n - A **type** that indicates the type of **link**, in this case a `Payment`.\n - An **id** that contains the ID of the payment that was refunded.\n\nThe **amount** field on the **line** equals the **totalAmount** on the payment and is negative, as this is money leaving accounts receivable.\n\nThe payment that was refunded has a line where the **amount** is positive and the type of the link is `Refund`. This payment may have several entries in its **lines** array if it was used to partly pay an invoice.\n\nFor example: A £1,050 payment on a £1,000 invoice with a refund of £50 has two lines:\n\n- One for £1,000 linked to the invoice that was paid.\n- Another for £50 linked to the payment that refunded the overpayment with a** type** of `Refund` and an ID that corresponds to the payment.\n\nThe **line** linked to the payment has the following properties:\n\n- An **amount** that indicates the amount that was refunded. This is positive as its money that was added to accounts receivable. It's balanced out by the negative amount of the refund.\n- A **links** array containing one element with the following properties:\n - A **type** that indicates the type of **link**, in this case a `Refund`.\n - An **id** that contains the ID of the payment that refunded this line.\n\n> **Support for linked payments**\n>\n> Not all accounting software support linking payments in this way. In some platforms, you may see a payment on account and a refund on account.\n\n## Foreign currencies\n\nThere are two types of currency rate that are included in the payments data type:\n\nPayment currency rate:\n\n- Base currency of the accounts receivable account.\n- Foreign currency of the payment.\n\nPayment line link currency rate:\n\n- Base currency of the item the link represents.\n- Foreign currency of the payment.\n\nThese two rates allow the calculation of currency loss or gain for any of the transactions affected by the payment lines. The second rate is used when a payment is applied to an item in a currency that doesn't match either:\n\n- The base currency for the accounts receivable account.\n- The currency of the item.\n\n ```json title=\"Currency rate example\"\n {\n \"id\": \"123\",\n \"note\": \"\",\n \"totalAmount\": 99.99,\n \"currency\": \"GBP\",\n \"lines\": [\n {\n \"amount\": 99.99,\n \"links\": [\n {\n \"type\": \"Invoice\",\n \"id\": \"178\",\n \"amount\": -50,\n \"currencyRate\": 1.9998\n }\n ]\n }\n ]\n }\n ```\n\n\n\n## Example data\n\n> **Object properties**\n>\n> For the sake of brevity, the examples here may omit properties from objects. For the full object definition, see [Payments](https://api.codat.io/swagger/index.html#/Payments).\n\n## Simple examples\n\n ```json title=\"Payment for invoice\"\n {\n \"totalAmount\": 1000,\n \"lines\": [\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Allocation of credit note\"\n {\n \"totalAmount\": 0,\n \"lines\": [\n {\n \"amount\" : 0,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"y\",\n \"amount\" : 1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Payment of invoice and payment on account\"\n {\n \"totalAmount\": 2000,\n \"lines\": [\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n }\n ]\n },\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"PaymentOnAccount\",\n \"id\" : \"y\",\n \"amount\" : -1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Refund of credit note\"\n {\n \"totalAmount\": -1000,\n \"lines\": [\n {\n \"amount\" : -1000,\n \"links\" : [\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"y\",\n \"amount\" : 1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Refund on accounts receivable account\"\n {\n \"totalAmount\": -1000,\n \"lines\": [\n {\n \"amount\" : -1000,\n \"links\" : [\n {\n \"type\" : \"PaymentOnAccount\",\n \"id\" : \"y\",\n \"amount\" : 1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Linked refund on accounts receivable account\"\n {\n \"id\" : \"payment-001\",\n \"totalAmount\": 1000,\n \"lines\": [\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Refund\",\n \"id\" : \"refund-001\",\n \"amount\" : -1000\n }\n ]\n }\n ]\n }\n {\n \"id\" : \"refund-001\",\n \"totalAmount\": -1000,\n \"lines\": [\n {\n \"amount\" : -1000,\n \"links\" : [\n {\n \"type\" : \"Payment\",\n \"id\" : \"payment-001\",\n \"amount\" : 1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Using a credit note and cash to pay an invoice\"\n {\n \"totalAmount\": 250,\n \"lines\": [\n {\n \"amount\": 0,\n \"links\": [\n {\n \"type\": \"Invoice\",\n \"id\": \"x\",\n \"amount\": -750\n }, \n {\n \"type\": \"CreditNote\",\n \"id\": \"y\",\n \"amount\": 750\n }\n ]\n },\n {\n \"amount\": 250,\n \"links\": [\n {\n \"type\": \"Invoice\",\n \"id\": \"x\",\n \"amount\": -250\n }\n ]\n }\n ]\n }\n ```\n\n\n\n## Complex examples\n\n ```json title=\"Use two credit notes and 1000 in to \"bank\" (cash, cheque etc.) to pay invoice\"\n {\n \"totalAmount\": 1000,\n \"lines\": [\n {\n \"amount\" : 0,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"y\",\n \"amount\" : 1000\n }\n ]\n },\n {\n \"amount\" : 0,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"z\",\n \"amount\" : 1000\n }\n ]\n },\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Pay an invoice with two credit notes and cash, with 1000 left 'on account'\"\n {\n \"totalAmount\": 2000,\n \"lines\": [\n {\n \"amount\" : 0,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"y\",\n \"amount\" : 1000\n }\n ]\n },\n {\n \"amount\" : 0,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"z\",\n \"amount\" : 1000\n }\n ]\n },\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n }\n ]\n },\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"PaymentOnAccount\",\n \"id\" : \"customer-001\",\n \"amount\" : -1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Two credit notes pay two invoices with no allocation amount specified\"\n {\n \"totalAmount\": 0,\n \"lines\": [\n {\n \"amount\" : 0,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"w\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"y\",\n \"amount\" : 1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"z\",\n \"amount\" : 1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Two credit notes and cash pay three invoices with no allocation amount specified, and refund cash\"\n {\n \"totalAmount\": 2000,\n \"lines\": [\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"w\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"Invoice\",\n \"id\" : \"x\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"Invoice\",\n \"id\" : \"u\",\n \"amount\" : -1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"y\",\n \"amount\" : 1000\n },\n {\n \"type\" : \"CreditNote\",\n \"id\" : \"z\",\n \"amount\" : 1000\n }\n ]\n },\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Refund\",\n \"id\" : \"refund-001\",\n \"amount\" : -1000\n }\n ]\n }\n ]\n }\n {\n \"id\" : \"refund-001\",\n \"totalAmount\": -1000,\n \"lines\": [\n {\n \"amount\" : -1000,\n \"links\" : [\n {\n \"type\" : \"Payment\",\n \"id\" : \"payment-001\",\n \"amount\" : 1000\n }\n ]\n }\n ]\n }\n ```\n\n\n\nIn this example, a payment on account is used to pay the same invoice in January and again in February.\n\n ```json title=\"January\"\n {\n \"id\": \"001\",\n \"totalAmount\": 5000,\n \"date\" : \"1901-01-01\",\n \"lines\": [\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"Invoice-x\",\n \"amount\" : -1000\n }\n ]\n },\n {\n \"amount\" : 4000,\n \"links\" : [\n {\n \"type\" : \"PaymentOnAccount\",\n \"id\" : \"PaymentOnAccount-y\",\n \"amount\" : -4000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"February\"\n {\n \"id\": \"001\",\n \"totalAmount\": 5000,\n \"date\" : \"1901-02-01\",\n \"lines\": [\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"Invoice-x\",\n \"amount\" : -1000\n }\n ]\n },\n {\n \"amount\" : 1000,\n \"links\" : [\n {\n \"type\" : \"Invoice\",\n \"id\" : \"Invoice-y\",\n \"amount\" : -1000\n }\n ]\n },\n {\n \"amount\" : 3000,\n \"links\" : [\n {\n \"type\" : \"PaymentOnAccount\",\n \"id\" : \"PaymentOnAccount-y\",\n \"amount\" : -3000\n }\n ]\n }\n ]\n }\n ```\n\n\n\n ```json title=\"Two credit notes and some cash pay two invoices with no allocations specified\"\n {\n \"totalAmount\": 500,\n \"lines\": [\n {\n \"amount\": 500,\n \"links\": [{\n \"type\": \"Invoice\",\n \"id\": \"a\",\n \"amount\": -1000\n }, {\n \"type\": \"Invoice\",\n \"id\": \"b\",\n \"amount\": -1000\n }, {\n \"type\": \"CreditNote\",\n \"id\": \"y\",\n \"amount\": 750\n },{\n \"type\": \"CreditNote\",\n \"id\": \"z\",\n \"amount\": 750\n }\n ]\n }\n ]\n }\n ```" + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the payment, unique to the company in the accounting software.' + customerRef: + $ref: '#/components/schemas/AccountingCustomer/definitions/accountingCustomerRef' + description: Customer the payment is recorded against in the accounting software. + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Account the payment is recorded against in the accounting software. + paymentMethodRef: + $ref: '#/components/schemas/PaymentMethodRef' + description: The Payment Method to which the payment is linked in the accounting software. + totalAmount: + type: number + format: decimal + description: Amount of the payment in the payment currency. This value should never change and represents the amount of money paid into the customer's account. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: ISO currency code recorded for the payment in the accounting software. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + date: + $ref: '#/components/schemas/DateTime' + description: Date the payment was recorded in the accounting software. + note: + type: string + nullable: true + description: Any additional information associated with the payment. + lines: + type: array + nullable: true + description: An array of payment lines. + items: + $ref: '#/components/schemas/AccountingPayment/definitions/paymentLine' + reference: + type: string + nullable: true + description: Friendly reference for the payment. + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - date + definitions: + paymentLine: + title: Payment Line + type: object + properties: + amount: + type: number + format: decimal + description: Amount in the payment currency. + links: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingPayment/definitions/paymentLineLink' + allocatedOnDate: + $ref: '#/components/schemas/DateTime' + description: The date the payment was allocated. + required: + - amount + paymentLineLink: + title: Payment Line Link + type: object + additionalProperties: false + properties: + type: + $ref: '#/components/schemas/AccountingPayment/definitions/paymentLinkType' + id: + type: string + description: Unique identifier of the transaction represented by the link. + amount: + type: number + format: decimal + nullable: true + description: |- + Amount by which the balance of the linked entity is altered, in the currency of the linked entity. + A negative link amount _reduces_ the outstanding amount on the accounts receivable account. + A positive link amount _increases_ the outstanding amount on the accounts receivable account. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + required: + - type + paymentLinkType: + title: Payment Link Type + type: string + enum: + - Unknown + - Unlinked + - Invoice + - CreditNote + - Other + - Refund + - Payment + - PaymentOnAccount + - ManualJournal + - Discount + description: |- + Types of payment line links, either: + `Unknown` + `Unlinked` - Not used + `Invoice` - ID refers to the invoice + `CreditNote` - ID refers to the credit note + `Refund` - ID refers to the sibling payment + `Payment` - ID refers to the sibling payment + `PaymentOnAccount` - ID refers to the customer + `Other` - ID refers to the customer + `Manual Journal` + `Discount` - ID refers to the payment + AccountingPaymentAllocation: + title: 'Accounting: Payment allocation' + type: object + properties: + payment: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment' + allocation: + type: object + properties: + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency of the transaction. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + allocatedOnDate: + $ref: '#/components/schemas/DateTime' + description: The date the payment was allocated. + totalAmount: + type: number + format: decimal + description: The total amount that has been allocated. + required: + - payment + - allocation + definitions: + paymentAllocationPayment: + type: object + properties: + id: + type: string + description: Identifier of the allocated payment. + note: + type: string + nullable: true + description: Notes attached to the allocated payment. + reference: + type: string + nullable: true + description: Reference to the allocated payment. + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: The account that the allocated payment is made from or to. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency the payment has been made in. + currencyRate: + title: Currency rate + type: number + format: decimal + nullable: true + description: |- + Rate to convert the total amount of the payment into the base currency for the company at the time of the payment. + + Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. + + It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR. + + Where the currency rate is provided by the underlying accounting software, it will be available from Codat with the same precision (up to a maximum of 9 decimal places). + + For accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places. + + ## Examples with base currency of GBP + + | Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (GBP) | + | :--------------- | :------------- | :------------ | :------------------------- | + | **USD** | $20 | 0.781 | £15.62 | + | **EUR** | €20 | 0.885 | £17.70 | + | **RUB** | ₽20 | 0.011 | £0.22 | + + ## Examples with base currency of USD + + | Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (USD) | + | :--------------- | :------------- | :------------ | :------------------------- | + | **GBP** | £20 | 1.277 | $25.54 | + | **EUR** | €20 | 1.134 | $22.68 | + | **RUB** | ₽20 | 0.015 | $0.30 | + + + ### Integration-specific details + + | Integration | Scenario | System behavior | + |-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, specify a currencyRate in the request body. | + paidOnDate: + $ref: '#/components/schemas/DateTime' + description: The date the payment was paid. + totalAmount: + type: number + format: decimal + description: Total amount that was paid. + AccountingPaymentMethod: + title: 'Accounting: Payment method' + description: |- + ## Overview + + A Payment Method represents the payment method(s) used to pay a Bill. Payment Methods are referenced on [Bill Payments](https://docs.codat.io/lending-api#/schemas/BillPayment) and [Payments](https://docs.codat.io/lending-api#/schemas/Payment). + type: object + allOf: + - type: object + properties: + id: + type: string + description: Unique identifier for the payment method. + name: + type: string + nullable: true + description: Name of the payment method. + type: + $ref: '#/components/schemas/AccountingPaymentMethod/definitions/paymentMethodType' + status: + $ref: '#/components/schemas/CommercePaymentMethod/allOf/1/properties/status' + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + paymentMethodType: + description: Method of payment. + type: string + enum: + - Unknown + - Cash + - Check + - CreditCard + - DebitCard + - BankTransfer + - Other + AccountingPayments: + title: 'Accounting: Payments' x-internal: true - tags: - - Bank accounts - summary: Create bank account - parameters: - - $ref: '#/components/parameters/timeoutInMinutes' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BankAccounts/allOf/0/properties/results/items/definitions/bankAccountPrototype' - examples: {} - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/BankAccounts/allOf/0/properties/results/items/definitions/bankAccountCreateResponse' - examples: {} - '400': - $ref: '#/components/responses/BadRequest' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - description: "The *Create bank account* endpoint creates a new [bank account](https://docs.codat.io/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': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - post: - tags: - - Source accounts - summary: Create source accounts + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingPayment' + - $ref: '#/components/schemas/PagingInfo' + AccountingProfitAndLossReport: + title: 'Accounting: Profit and loss report' + description: |- + > **Language tip:** Profit and loss statement is also referred to as **income statement** under US GAAP (Generally Accepted Accounting Principles). + + ## Overview + + The purpose of a profit and loss report is to present the financial performance of a company over a specified time period. + + A profit and loss report shows a company's total income and expenses for a specified period of time and whether a profit or loss has been made. + + > **Profit and loss or balance sheet?** + > Profit and loss reports summarise the total revenue, expenses, and profit or loss over a specified time period. A balance sheet report presents all assets, liability, and equity for a given date. + + + **Structure of this report** + This report will reflect the structure and line descriptions that the business has set in their own accounting software. + + **History** + By default, Codat pulls (up to) 24 months of profit and loss history for a company. You can adjust this to fetch more history, where available, by updating the `monthsToSync` value for `profitAndLoss` on the [data type settings endpoint](https://docs.codat.io/lending-api#/operations/post-profile-syncSettings). + + **Want to pull this in a standardised structure?** + Our [Enhanced Financials](https://docs.codat.io/lending/features/financial-statements-overview) endpoints provide the same report under standardized headings, allowing you to pull it in the same format for all of your business customers. + type: object + properties: + reports: + type: array + description: An array of profit and loss reports. + items: + $ref: '#/components/schemas/AccountingProfitAndLossReport/definitions/profitAndLossReport' + reportBasis: + $ref: '#/components/schemas/AccountingProfitAndLossReport/definitions/reportBasis' + currency: + type: string + description: Base currency of the company in which the profit and loss report is presented. + mostRecentAvailableMonth: + $ref: '#/components/schemas/DateTime' + description: Most recent available monthly report data. + earliestAvailableMonth: + $ref: '#/components/schemas/DateTime' + description: Earliest available monthly report data. + required: + - reports + - reportBasis + definitions: + reportBasis: + enum: + - Unknown + - Accrual + - Cash + type: string + description: The basis of a report. + profitAndLossReport: + type: object + additionalProperties: false + properties: + fromDate: + $ref: '#/components/schemas/DateTime' + description: Date from which the report data begins. + toDate: + $ref: '#/components/schemas/DateTime' + description: Date on which the report data ends. + income: + $ref: '#/components/schemas/ReportLine' + description: ReportLine items for income in the given date range. + costOfSales: + $ref: '#/components/schemas/ReportLine' + description: ReportLine items for cost of sales in the given date range. + grossProfit: + type: number + format: decimal + description: Gross profit of the company in the given date range. + expenses: + $ref: '#/components/schemas/ReportLine' + description: ReportLine items for expenses in the given date range. + netOperatingProfit: + type: number + format: decimal + description: Net operating profit of the company in the given date range. + otherExpenses: + $ref: '#/components/schemas/ReportLine' + description: ReportLine items for other expenses in the given date range. + otherIncome: + $ref: '#/components/schemas/ReportLine' + description: ReportLine items for other income in the given date range. + netOtherIncome: + type: number + format: decimal + description: Net other income of the company in the given date range. + netProfit: + type: number + format: decimal + description: Net profit of the company in the given date range. + required: + - grossProfit + - netOperatingProfit + - netOtherIncome + - netProfit + AccountingRecordRef: + type: object + x-internal: true + title: Record reference + description: |- + Links the current record to the underlying record or data type that created it. + + For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. + properties: + id: + type: string + description: '''id'' of the underlying record or data type.' + dataType: + type: string + description: Allowed name of the 'dataType'. + examples: + - journalEntry + - invoice + - accountTransaction + - transfer + AccountingSupplier: + title: 'Accounting: Supplier' + description: |- + ## Overview + + From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/lending-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/lending-api#/schemas/Bill). + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the supplier, unique to the company in the accounting software.' + supplierName: + type: string + nullable: true + description: 'Name of the supplier as recorded in the accounting system, typically the company name.' + contactName: + type: string + nullable: true + description: Name of the main contact for the supplier. + emailAddress: + type: string + nullable: true + description: Email address that the supplier may be contacted on. + phone: + type: string + nullable: true + description: Phone number that the supplier may be contacted on. + examples: + - +44 25691 154789 + - (877) 492-8687 + - 01224 658 999 + addresses: + type: array + nullable: true + description: An array of Addresses. + items: + $ref: '#/components/schemas/AccountingAddress' + registrationNumber: + type: string + nullable: true + description: 'Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House.' + taxNumber: + type: string + nullable: true + description: Supplier's company tax number. + status: + $ref: '#/components/schemas/AccountingSupplier/definitions/supplierStatus' + defaultCurrency: + type: string + nullable: true + description: Default currency the supplier's transactional data is recorded in. + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - status + definitions: + supplierRef: + title: Supplier reference + description: Reference to the supplier the record relates to. + type: object + properties: + id: + minLength: 1 + type: string + description: The supplier's unique ID + supplierName: + type: string + nullable: true + description: The supplier's name + required: + - id + supplierStatus: + description: Status of the supplier. + type: string + enum: + - Unknown + - Active + - Archived + examples: + - id: C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F + supplierName: Kelly's Industrial Supplies + contactName: Kelly's Industrial Supplies + emailAddress: sales@kellysupplies.com + phone: 07999 999999 + addresses: + - type: Billing + line1: Unit 51 + line2: Bakersfield Industrial Estate + city: Bakersfield + region: California + country: USA + postalcode: '93308' + registrationNumber: string + taxNumber: string + status: Unknown + defaultCurrency: string + metadata: + isDeleted: true + supplementalData: + content: + property1: + property1: null + property2: null + property2: + property1: null + property2: null + modifiedDate: '2022-10-23T00:00:00Z' + sourceModifiedDate: '2022-10-23T00:00:00Z' + AccountingSuppliers: + title: Suppliers + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingSupplier' + - $ref: '#/components/schemas/PagingInfo' + AccountingTrackingCategory: + x-internal: true + title: 'Accounting: Tracking category' + description: |- + Details of a category used for tracking transactions. + + > Language tip + > + > Parameters used to track types of spend in various parts of an organization can be called **dimensions**, **projects**, **classes**, or **locations** in different accounting software. In Codat, we refer to these as tracking categories. + + ## Overview + + Tracking categories are used to monitor cost centres and control budgets that sit outside the standard chart of accounts. Customers may use tracking categories to group together and track the income and costs of specific departments, projects, locations or customers. + + From their accounting system, customers can: + + - Create and maintain tracking categories and tracking category types. + - View all tracking categories that are available for use. + - View the relationships between the categories. + - Assign invoices, bills, credit notes, or bill credit notes to one or more categories. + - View the categories that a transaction belongs to. + - View all transactions in a tracking category. + + ### Tracking categories per platform + + Review the platform-specific tracking categories that Codat supports, and the level they are assigned to in the source platform. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PlatformTracking categoryTracking level
Dynamics 365DimensionsLine item
FreshbooksExpense categoriesLine item
MYOBCategoriesTransaction
NetsuiteClassesLine item
LocationsLine item
DepartmentsLine item
Custom segmentsLine item
QuickBooks DesktopClassesLine item or transaction level
LocationsTransaction
QuickBooks OnlineClassesLine item or transaction level
LocationsTransaction
Sage 200Cost centersLine item
DepartmentsLine item
Analysis codesTransaction
Sage 50DepartmentsLine item
CostcodesLine item
ProjectsLine item
Sage IntacctDimensionsLine item
XeroTracking categoriesLine item
+ + > **Example use case** + > + > Monitor the budget for your annual conference using a tracking category called 'AnnualConference2020' with the **type** set to **Costing**. + + If a tracking category has a parent category, the ID of that parent category is displayed. There is also a `hasChildren` field that shows whether there are child subcategories nested beneath. + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'The identifier for the item, unique per tracking category.' + nullable: true + name: + type: string + description: The name of the tracking category. + nullable: true + status: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/status' + parentId: + type: string + description: The identifier for this item's immediate parent. + nullable: true + hasChildren: + type: boolean + description: Boolean value indicating whether this category has SubCategories. + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + trackingCategoryRef: + required: + - id + type: object + description: References a category against which the item is tracked. + deprecated: true + properties: + id: + minLength: 1 + type: string + description: Unique identifier to the tracking category. + name: + type: string + nullable: true + description: Name of tracking category. + status: + title: Tracking category status + type: string + description: Current state of the tracking category. + enum: + - Unknown + - Active + - Archived + examples: + - id: string + name: string + status: Unknown + parentId: string + hasChildren: true + modifiedDate: '2022-10-23T00:00:00Z' + sourceModifiedDate: '2022-10-23T00:00:00Z' + AccountingTransfer: + title: 'Accounting: Transfer' + description: 'A transfer records the movement of money between two bank accounts, or between a bank account and a nominal account. It is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).' + allOf: + - properties: + id: + type: string + description: Unique identifier for the transfer. + description: + type: string + nullable: true + description: Description of the transfer. + contactRef: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine/properties/contactRef' + description: 'The customer or supplier for the transfer, if available.' + date: + $ref: '#/components/schemas/DateTime' + description: The day on which the transfer was made. + from: + $ref: '#/components/schemas/AccountingTransfer/definitions/transferAccount' + description: The details of the accounts the transfer is moving from. + to: + $ref: '#/components/schemas/AccountingTransfer/definitions/transferAccount' + description: The details of the accounts the transfer is moving to. + status: + description: The status of the transfer in the account + type: string + enum: + - Unknown + - Unreconciled + - Reconciled + - Void + nullable: true + trackingCategoryRefs: + type: array + nullable: true + description: Reference to the tracking categories this transfer is being tracked against. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + depositedRecordRefs: + type: array + nullable: true + description: List of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the _undeposited funds_ (or other holding) account within the transfer. + items: + $ref: '#/components/schemas/AccountingRecordRef' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + transferAccount: + title: Transfer account + description: Account details of the account sending or receiving the transfer. + type: object + properties: + accountRef: + $ref: '#/components/schemas/AccountingRecordRef' + description: The account that the transfer is moving from or to. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + amount: + type: number + format: decimal + description: The amount transferred between accounts. + type: object + AccountingTransfers: + title: 'Accounting: Transfers' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingTransfer' + - $ref: '#/components/schemas/PagingInfo' + AccountsPayableTracking: + title: Tracking + x-internal: true + type: object + description: 'Categories, and a project and customer, against which the item is tracked.' + properties: + categoryRefs: + type: array + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + customerRef: + $ref: '#/components/schemas/AccountingCustomer/definitions/accountingCustomerRef' + projectRef: + $ref: '#/components/schemas/ProjectRef' + isBilledTo: + $ref: '#/components/schemas/AccountsPayableTracking/definitions/billedToType' + isRebilledTo: + $ref: '#/components/schemas/AccountsPayableTracking/definitions/billedToType' + required: + - categoryRefs + - isBilledTo + - isRebilledTo + definitions: + billedToType: + type: string + description: Defines if the invoice or credit note is billed/rebilled to a project or customer. + enum: + - Unknown + - NotApplicable + - Customer + - Project + AccountsReceivableTracking: + title: Tracking + x-internal: true + type: object + description: 'Categories, and a project and customer, against which the item is tracked.' + properties: + categoryRefs: + type: array + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + customerRef: + $ref: '#/components/schemas/AccountingCustomer/definitions/accountingCustomerRef' + projectRef: + $ref: '#/components/schemas/ProjectRef' + isBilledTo: + $ref: '#/components/schemas/AccountsReceivableTracking/definitions/billedToType' + isRebilledTo: + $ref: '#/components/schemas/AccountsReceivableTracking/definitions/billedToType' + recordRef: + $ref: '#/components/schemas/AccountingRecordRef' + required: + - categoryRefs + - isBilledTo + - isRebilledTo + definitions: + billedToType: + type: string + enum: + - Unknown + - NotApplicable + - Project + description: Defines if the bill or bill credit note is billed/rebilled to a project. + AgedCurrencyOutstanding: + type: object + title: 'Accounting: Aged currency outstanding' + properties: + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + agedOutstandingAmounts: + type: array + description: Array of outstanding amounts by period. + items: + $ref: '#/components/schemas/AgedCurrencyOutstanding/definitions/agedOutstandingAmount' + definitions: + agedOutstandingAmount: + type: object + title: Aged outstanding amount + properties: + fromDate: + $ref: '#/components/schemas/DateTime' + description: Start date of period. + toDate: + $ref: '#/components/schemas/DateTime' + description: End date of period. + amount: + type: number + format: decimal + description: The amount outstanding. + details: + type: array + description: Array of details. + items: + $ref: '#/components/schemas/AgedCurrencyOutstanding/definitions/agedOutstandingAmountDetail' + agedOutstandingAmountDetail: + type: object + title: Amounts outstanding by data type + properties: + name: + type: string + description: Name of data type with outstanding amount for given period. + amount: + type: number + format: decimal + description: The amount outstanding. + Attachments: + x-internal: true + type: object + properties: + attachments: + type: array + items: + $ref: '#/components/schemas/AccountingAttachment' + nullable: true + title: Attachments + BankFeedBankAccountMapping: + title: Bank feed account mapping + type: object + additionalProperties: false + properties: + sourceAccountId: + type: string + description: Unique ID for the source account + targetAccountId: + type: string + nullable: true + description: Unique ID for the target account + feedStartDate: + $ref: '#/components/schemas/DateTime' + nullable: true + description: The date from which bank transactions can be provided to the platform. + required: + - sourceAccountId + examples: + - sourceAccountId: acc-002 + targetAccountId: account-081 + BankFeedBankAccountMappingResponse: + title: Bank feed account mapping response + type: object + additionalProperties: false + properties: + sourceAccountId: + type: string + description: Unique ID for the source account. + targetAccountId: + type: string + nullable: true + description: Unique ID for the target account. + status: + type: string + nullable: true + description: Status of the POST request. + error: + 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 + 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: + type: string + description: Account number for the source account. + sourceBalance: + 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: + 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.' + definitions: + targetAccountOption: + title: Target Account Option + 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 + BankingAccount: + title: 'Banking: Bank account' + description: |- + This data type provides a list of all the SMB's bank accounts, with rich data like balances, account numbers, and institutions holding the accounts. + + Responses are paged, so you should provide `page` and `pageSize` query parameters in your request. + type: object + allOf: + - type: object + properties: + id: + minLength: 1 + type: string + description: The ID of the account from the provider. + name: + minLength: 1 + type: string + description: The name of the account according to the provider. + informalName: + type: string + nullable: true + description: 'The friendly name of the account, chosen by the holder. This may not have been set by the account holder and therefore is not always available.' + holder: + type: string + nullable: true + description: The name of the person or company who holds the account. + type: + $ref: '#/components/schemas/AccountingBankAccountType' + balance: + $ref: '#/components/schemas/BankingAccountBalance/definitions/accountBalanceAmounts' + description: An object containing bank balance data. + identifiers: + $ref: '#/components/schemas/BankingAccount/definitions/accountIdentifiers' + currency: + minLength: 1 + type: string + description: The currency code for the account. + institution: + $ref: '#/components/schemas/BankingAccount/definitions/accountInstitution' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - id + - name + - type + - balance + - identifiers + - currency + - institution + definitions: + accountIdentifiers: + title: Account Identifiers + description: An object containing bank account identification information. + type: object + x-internal: true + additionalProperties: false + properties: + type: + $ref: '#/components/schemas/BankingAccount/definitions/accountIdentifierType' + subtype: + type: string + nullable: true + description: Detailed account category + number: + type: string + nullable: true + description: 'The account number for the account. When combined with the`bankCode`, this is usually enough to uniquely identify an account within a jurisdiction.' + bankCode: + type: string + nullable: true + description: |- + The local (usually national) routing number for the account. + + This is known by different names in different countries: + * BSB code (Australia) + * routing number (Canada, USA) + * sort code (UK) + iban: + type: string + nullable: true + description: 'The international bank account number (IBAN) for the account, if known.' + bic: + type: string + nullable: true + description: 'The ISO 9362 code (commonly called SWIFT code, SWIFT-BIC or BIC) for the account.' + maskedAccountNumber: + type: string + nullable: true + description: A portion of the actual account `number` to help account identification where number is tokenised (Plaid only) + required: + - type + accountIdentifierType: + type: string + x-internal: true + description: Type of account + enum: + - Account + - Card + - Credit + - Depository + - Investment + - Loan + - Other + accountInstitution: + title: Account Institution + description: The bank or other financial institution providing the account. + x-internal: true + type: object + additionalProperties: false + properties: + id: + type: string + description: 'The institution''s ID, according to the provider.' + name: + type: string + description: 'The institution''s name, according to the underlying provider.' + examples: + - results: + - id: 1703194f-7805-4da8-bac0-2ba5da4a4216 + name: Business Current Account + informalName: Codat + holder: Codat Ltd + type: Debit + balance: + available: -459987.97 + current: -459964.9 + limit: 5000 + identifiers: + type: Depository + subtype: checking + number: '46762629' + bankCode: 009911 + iban: GB29 LOYD 4773 2346 7626 29 + bic: LOYDGB21006 + maskedAccountNumber: LOYDGB21006 + currency: GBP + institution: + id: lloyds-bank + name: Lloyds Bank + modifiedDate: '2022-05-23T16:32:50Z' + sourceModifiedDate: '2021-08-14T05:04:12' + BankingAccountBalance: + title: 'Banking: Account balance' + description: |- + The Banking Account Balances data type provides a list of balances for a bank account including end-of-day batch balance or running balances per transaction. + + Responses are paged, so you should provide `page` and `pageSize` query parameters in your request. + + > **How often should I pull Account Balances?** + > + > Because these balances are closing balances, we recommend you pull Account Balance no more frequently than daily. If you require a live intraday balance, this can be found for each account on the [Account](https://docs.codat.io/lending-api#/schemas/Account) data type. + > + > Whilst you can choose to sync hourly, this may incur usage charges from Plaid or TrueLayer. + type: object + allOf: + - type: object + properties: + accountId: + minLength: 1 + type: string + description: The unique identifier of the account. + balance: + $ref: '#/components/schemas/BankingAccountBalance/definitions/accountBalanceAmounts' + date: + $ref: '#/components/schemas/DateTime' + description: Date of the balance. + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - accountId + - balance + - date + definitions: + accountBalanceAmounts: + title: Account Balance Amounts + x-internal: true + type: object + properties: + available: + type: number + format: decimal + nullable: true + description: 'The balance available in the account, including any pending transactions. This doesn''t include additional funds available from any overdrafts.' + current: + type: number + format: decimal + description: The balance of the account only including cleared transactions. + limit: + type: number + format: decimal + nullable: true + description: 'The minimum allowed balance for the account. For example, a $100.00 overdraft would show as a limit of `-100.00`.' + additionalProperties: false + description: 'Depending on the data provided by the underlying bank, not all balances are always available.' + examples: + - accountBalances: + - accountId: cce404db-27f7-4286-95db-622b53596cf4 + balance: + available: 714374.48 + current: 714374.57 + limit: 5000 + date: '2021-03-18T00:00:00' + - accountId: cce404db-27f7-4286-95db-622b53596cf4 + balance: + available: 714374.48 + current: 714374.57 + limit: 5000 + date: '2021-03-19T00:00:00' + - accountId: cce404db-27f7-4286-95db-622b53596cf4 + balance: + available: 714195.66 + current: 714204.39 + limit: 5000 + date: '2021-03-22T00:00:00' + - accountId: 2f593774-1075-4805-a552-84eecc7eb264 + balance: + available: -644945.42 + current: -644925.84 + limit: 0 + date: '2022-03-09T00:00:00' + BankingAccountBalances: + title: 'Banking: Account balances' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/BankingAccountBalance' + - $ref: '#/components/schemas/PagingInfo' + BankingAccounts: + title: 'Banking: Bank accounts' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/BankingAccount' + - $ref: '#/components/schemas/PagingInfo' + BankingTransaction: + title: 'Banking: Transaction' 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 Banking Transactions data type provides an immutable source of up-to-date information on income and expenditure. - > ### 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' - responses: - '201': - 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' - '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' - '409': - description: Conflict - content: - application/json: - schema: - type: array - items: - oneOf: - - $ref: '#/components/schemas/SourceAccountV2BatchCreateResponse' - - $ref: '#/components/schemas/SourceAccountBatchCreateResponse' - - $ref: '#/components/schemas/SourceAccountBatchErrorResponse' - '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 + Responses are paged, so you should provide `page` and `pageSize` query parameters in your request. + type: object + allOf: + - type: object + properties: + id: + minLength: 1 + type: string + description: The unique identifier of the bank transaction. + accountId: + minLength: 1 + type: string + description: The unique identifier of the bank account. + description: + type: string + nullable: true + description: The description of the bank transaction. + amount: + type: number + format: decimal + description: The amount of the bank transaction. + currency: + minLength: 1 + type: string + description: The currency of the bank transaction. + postedDate: + $ref: '#/components/schemas/DateTime' + description: The date the bank transaction was cleared. + authorizedDate: + $ref: '#/components/schemas/DateTime' + description: The date the bank transaction was authorized. + code: + $ref: '#/components/schemas/BankingTransaction/definitions/transactionCode' + merchantName: + type: string + nullable: true + description: The name of the merchant. + transactionCategoryRef: + $ref: '#/components/schemas/BankingTransactionCategory/definitions/transactionCategoryRef' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - id + - accountId + - currency + definitions: + transactionCode: + type: string + x-internal: true + description: Code to identify the underlying transaction. + enum: + - Unknown + - Fee + - Payment + - Cash + - Transfer + - Interest + - Cashback + - Cheque + - DirectDebit + - Purchase + - StandingOrder + - Adjustment + - Credit + - Other + - NotSupported + examples: + - id: 0130b5bb-1419-40f6-8a27-7362d0381229 + accountId: 1703194f-7805-4da8-bac0-2ba5da4a4216 + description: Payments for direct income ce149943-c157-43fc-aac7-42a716b655b6 + amount: 5062.39 + currency: GBP + postedDate: '2021-07-06T00:00:00' + authorizedDate: '2021-07-06T00:00:00' + merchantName: New Look + transactionCategoryRef: + id: health-and-fitness-sports + modifiedDate: '2022-05-23T16:32:50Z' + sourceModifiedDate: '2021-06-28T10:48:12' + BankingTransactionCategories: + title: 'Banking: Transaction categories' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/BankingTransactionCategory' + - $ref: '#/components/schemas/PagingInfo' + BankingTransactionCategory: + title: 'Banking: Transaction category' 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 Banking Transaction Categories data type provides a list of hierarchical categories associated with a transaction for greater contextual meaning to transaction activity. - > ### 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 - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/SourceAccountV2/definitions/sourceAccountV2Prototype' - - $ref: '#/components/schemas/SourceAccount/definitions/sourceAccountPrototype' - 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: - value: - id: acc-002 - accountName: account-081 - sortCode: '123456' - accountType: Credit - accountNumber: '12345670' - currency: GBP - balance: 99.99 - modifiedDate: '2023-01-09T14:14:14.1057478Z' - responses: - '200': - description: Success - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/SourceAccountV2' - - $ref: '#/components/schemas/SourceAccount' - 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' - get: - 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 - responses: - '200': - description: Success - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/SourceAccountV2/definitions/sourceAccounts' - - $ref: '#/components/schemas/SourceAccount/definitions/sourceAccounts' - examples: {} - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts/{accountId}': - patch: - 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' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SourceAccount' - examples: {} - responses: - '200': - description: Success - content: - application/json: - x-speakeasy-usage-example: true - schema: - $ref: '#/components/schemas/SourceAccount' - 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' - delete: - tags: - - Source accounts - summary: Delete source account - description: | - The _Delete source account_ endpoint enables you to remove a source account. + Responses are paged, so you should provide `page` and `pageSize` query parameters in your request. + type: object + allOf: + - type: object + description: Status of the bank transaction category. + properties: + id: + minLength: 1 + type: string + description: The unique identifier of the bank transaction category. + name: + minLength: 1 + type: string + description: The name of the bank transaction category. + parentId: + type: string + nullable: true + description: The unique identifier of the parent bank transaction category. + hasChildren: + type: boolean + description: A Boolean indicating whether there are other bank transaction categories beneath this one in the hierarchy. + status: + $ref: '#/components/schemas/BankingTransactionCategory/definitions/transactionCategoryStatus' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - id + - name + definitions: + transactionCategoryRef: + type: object + x-internal: true + description: An object of bank transaction category reference data. + properties: + id: + minLength: 1 + type: string + description: The unique category reference id for the bank transaction. + name: + type: string + nullable: true + description: The category name reference for the bank transaction. + required: + - id + transactionCategoryStatus: + type: string + description: The status of the transaction category. + x-internal: true + enum: + - Unknown + - Active + - Archived + examples: + - id: auto-and-transport + name: Auto & Transport + hasChildren: true + status: Active + modifiedDate: '2022-05-23T16:32:50' + sourceModifiedDate: '2021-04-24T07:59:10' + BankingTransactions: + title: 'Banking: Transactions' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/BankingTransaction' + - $ref: '#/components/schemas/PagingInfo' + BankStatementUploadConfiguration: + title: Banking data upload settings + description: Configuration settings for uploading banking data to Codat + additionalProperties: false + type: object + properties: + source: + type: string + enum: + - codat + description: The source of the banking data that determines its format + accountId: + type: string + description: The ID of the account in the third-party platform + providerId: + type: string + description: TrueLayer provider ID (only required if source is TrueLayer) + CategorizedBankStatementAccounts: + title: Categorized bank statement accounts + description: |- + > **Categorization engine** + > + > The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source. - 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' - 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' - '/companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts/credentials': - post: - 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: {} - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/BankAccountCredentials' - '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: - tags: - - Source accounts - summary: Delete all source account credentials - x-speakeasy-name-override: delete-credentials + The Enhanced Cash Flow accounts endpoint provides a list of accounts that categorized transactions have been taken from. + allOf: + - type: object + properties: + results: + type: array + items: + title: Account + type: object + properties: + id: + description: The ID of the account from the provider. + type: string + sourceRef: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/accounts/properties/sourceRef' + platformName: + description: 'Name of the banking data source, e.g. "Plaid".' + type: string + accountProvider: + description: The bank or other financial institution providing the account. + type: string + accountName: + description: The name of the account according to the provider. + type: string + accountType: + description: 'The type of banking account, e.g. credit or debit.' + type: string + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency code for the bank account. + currentBalance: + description: The balance of the bank account. + type: number + format: decimal + identifiers: + $ref: '#/components/schemas/BankingAccount/definitions/accountIdentifiers' + - $ref: '#/components/schemas/PagingInfo' + example: + results: + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Savings Account + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Banking - Business Credit Card + accountType: Credit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Undeposited Funds + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Current Account + accountType: Debit + currency: GBP + currentBalance: 0 + pageNumber: 1 + pageSize: 10 + totalResults: 15 + _links: + self: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/accounts + current: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/accounts?page=1&pageSize=10 + next: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/accounts?page=2&pageSize=10 + CategorizedBankStatementTransactions: + title: Categorized bank statement transactions 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. + > **Categorization engine** + > + > The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source. - 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' - 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' - '/companies/{companyId}/connections/{connectionId}/bankFeedAccounts/mapping': - 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 - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/BankFeedMapping/definitions/bankFeedMappings' + The Enhanced Cash Flow Transactions endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources. + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowItem/properties/transactions/items' + - $ref: '#/components/schemas/PagingInfo' + example: + results: + - sourceRef: + sourceType: Banking + - accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + date: '2023-01-25' + description: Payment to supplier + amount: 100 + currency: USD + transactionCategory: + confidence: 92.7 + levels: + - Asset + - Current + - Bank + confidences: + - 92.7 + - 95 + - 96 + platformName: Plaid + counterpartyNames: + - Counterparty + modifiedDate: '2023-01-25T22:36:05.125Z' + isRecurring: true + - sourceRef: + sourceType: Banking + - accountRef: + id: 12345678-1234-1234-1234-123456789012 + name: Business Saving Account + id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + date: '2023-01-25' + description: Payment to supplier + amount: 100 + currency: USD + transactionCategory: + confidence: 92.7 + levels: + - Expense + - Operating + confidences: + - 92.7 + - 95 + platformName: Plaid + counterpartyNames: [] + modifiedDate: '2023-01-25T22:36:05.125Z' + isRecurring: false + pageNumber: 1 + pageSize: 100 + totalResults: 2401 + _links: + self: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions + current: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=1&pageSize=100 + next: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=2&pageSize=100 + ClientRateLimitWebhook: + title: Client rate limit webhook + type: object + properties: + id: + type: string + format: uuid + example: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b + description: Unique identifier of the event. + eventType: + type: string + description: The type of event. + examples: + - client.rateLimit.reset + - client.rateLimit.reached + generatedDate: + $ref: '#/components/schemas/DateTime' + description: The date time in UTC the event was generated in Codat. + payload: + $ref: '#/components/schemas/ClientRateLimitWebhook/definitions/clientRateLimitWebhookPayload' + definitions: + clientRateLimitWebhookPayload: + title: Client rate limit webhook payload + type: object + properties: + dailyQuota: + type: integer + description: The number of available requests per day. + quotaRemaining: + type: integer + description: Total number of requests remaining for your client. + expiryDate: + $ref: '#/components/schemas/DateTime' + description: The date time in UTC when your daily quota is reset. + CommerceAddress: + title: 'Commerce: Address' + x-internal: true + type: object + properties: + type: + $ref: '#/components/schemas/CommerceAddress/definitions/commerceAddressType' + line1: + description: The first line of the address + type: string + line2: + description: The second line of the address + type: string + city: + description: 'The third line of the address, or city' + type: string + region: + description: 'The fourth line of the address, or region' + type: string + country: + description: The country for the address + type: string + postalCode: + description: The postal (or zip) code for the address + type: string + definitions: + commerceAddressType: + description: The type of the address + type: string + enum: + - Billing + - Delivery + - Order + - Inventory + - Unknown + CommerceCompanyInfo: + title: 'Commerce: Company profile' + description: | + In the Codat system, company profile includes standard commercial details about + a linked company, such as their address, phone number, and company registration. + type: object + allOf: + - type: object + properties: + companyName: + type: string + description: The name of the company + example: Codat + commercePlatformRef: + type: string + description: Identifier or reference for the company in the commerce software + companyLegalName: + type: string + description: The full legal name of the company + example: Codat Limited + addresses: + type: array + description: Addresses associated with the company + items: + $ref: '#/components/schemas/CommerceAddress' + phoneNumbers: + type: array + description: Phone numbers associated with the company + items: + $ref: '#/components/schemas/PhoneNumber' + webLinks: + description: Weblinks associated with the company + type: array + items: + $ref: '#/components/schemas/WebLink' + registrationNumber: + description: The registration number of the company + type: string + examples: + - 10480375 + baseCurrency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + accountBalances: + description: The available and current cash balances for the company's accounts + type: array + items: + $ref: '#/components/schemas/CommerceCompanyInfo/definitions/accountBalance' + sourceUrls: + description: 'URL addresses for the originating system. For example, potential use cases include ''deeplinking'' to the originating system' + type: object + additionalProperties: + type: string + example: + url1: 'https://connect.sandbox.com/v2/customers' + url2: 'https://connect.sandbox.com/v2/disputes' + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + accountBalance: + title: Account Balance + type: object + x-internal: true + properties: + available: + description: The account's current balance + type: number + format: decimal + pending: + description: Funds that are not yet available in the balance + type: number + format: decimal + reserved: + description: Funds reserved as holdings + format: decimal + currency: + description: The currency of the account + allOf: + - $ref: '#/components/schemas/SourceAccount/properties/currency' + CommerceCustomer: + title: 'Commerce: Customer' + description: 'When a customer places an order with the connected commerce store their details are added to the Customers dataset. You can use the data from the Customers endpoints to calculate key metrics, such as customer churn.' + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + customerName: + type: string + description: Name of the customer + example: Fred Smith + emailAddress: + type: string + description: Email address of the customer + example: fred.smith@myCompany.com + phone: + $ref: '#/components/schemas/PhoneNumber/properties/number' + defaultCurrency: + allOf: + - description: | + Default currency of any transactional data for the customer, + for example, orders or payments + - $ref: '#/components/schemas/SourceAccount/properties/currency' + addresses: + type: array + description: Addresses of the customer + items: + $ref: '#/components/schemas/CommerceAddress' + note: + type: string + description: Any additional information about the customer + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + commerceCustomerRef: + type: object + description: Reference to the customer that placed the order. + properties: + id: + description: The unique identitifer of the customer being referenced + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + name: + description: Name of the customer being referenced. + type: string + required: + - id + examples: + - customers: + - id: '15' + customerName: Daffy Duck + emailAddress: d.duck@warnerbros.com + defaultCurrency: GBP + phone: (877) 492-8687 + addresses: + - type: billing + line1: 301 Duck Pond + line2: 28 Green Street + city: London + region: England + country: United Kingdom + postalCode: WX1X 0BE + - type: delivery + line1: Bread Street + line2: Bird Avenue + city: Paris + region: France + country: France + postalCode: WDF 123 + note: Regular customer + createdDate: '0001-01-01T00:00:00' + modifiedDate: null + sourceModifiedDate: '2020-09-15T23:52:28' + - id: '18' + customerName: Tasmanian Devil + emailAddress: t.devil@warnerbros.com + defaultCurrency: GBP + phone: +1-202-555-0181 + addresses: + - type: billing + line1: 101 Fire Rooms + line2: Engine Street + city: London + region: England + country: United Kingdom + postalCode: WC1X 0BE + note: Handle with care + createdDate: '0001-01-01T00:00:00' + modifiedDate: null + sourceModifiedDate: '2020-04-16T02:41:52' + - id: a99f5e0c-a4db-452f-8d2c-8fd15482b384 + customerName: Bugs Bunny + emailAddress: b.bunny@warnerbros.com + defaultCurrency: GBP + phone: '' + addresses: + - type: billing + line1: 301 Carrot Street + line2: Orange Town + city: Yorkshire + region: England + country: United Kingdom + postalCode: WF1X 0BE + - type: delivery + line1: 424 Field Street + line2: The Meadow + city: Paris + region: France + country: France + postalCode: WDF 123 + note: Regular customer + createdDate: '0001-01-01T00:00:00' + modifiedDate: null + sourceModifiedDate: '2020-08-12T14:37:37' + CommerceCustomers: + title: 'Commerce: Customers' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceCustomer' + - $ref: '#/components/schemas/PagingInfo' + CommerceDispute: + title: 'Commerce: Dispute' + description: |- + A customer may file a payment dispute with their bank or other card issuer when they're unsatisfied with their purchase or believe they have been charged incorrectly. For example: + - They didn't receive an order. + - The product they received was different to the commerce store's description. + - They've been the victim of online fraud. + + You can use data from the Disputes endpoints to calculate key metrics, such as the number of chargebacks. + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + required: + - currency + properties: + disputedTransactions: + description: Link to the source event(s) which triggered this transaction. + type: array + items: + $ref: '#/components/schemas/CommerceTransaction/definitions/transactionSourceRef' + totalAmount: + description: Total transaction amount that is under dispute. + format: decimal examples: - Example: - 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 - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - post: - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BankFeedAccountMapping' - examples: - Example: - value: - sourceAccountId: acc-002 - targetAccountId: account-081 - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/BankFeedAccountMappingResponse' - 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}/bankFeeds/info': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - get: - summary: Get company information + - 194.12 + - -283.56 + - 0 + currency: + description: Currency of the disputed transaction. + $ref: '#/components/schemas/SourceAccount/properties/currency' + status: + $ref: '#/components/schemas/CommerceDispute/definitions/disputeStatus' + reason: + description: Reason for the dispute + type: string + examples: + - Unhappy with product + dueDate: + description: Date when the next action in the dispute resolution is due + $ref: '#/components/schemas/DateTime' + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + disputeStatus: + description: Current status of the dispute + x-internal: true + type: string + enum: + - Won + - Lost + - Accepted + - Processing + - ChargeRefunded + - EvidenceRequired + - InquiryEvidenceRequired + - InquiryProcessing + - InquiryClosed + - WaitingThirdParty + - Unknown + example: EvidenceRequired + examples: + - id: 03e608e3-bd1c-454f-8c2b-fb0133e43b95 + disputedTransactions: + - id: e63ad857-7e12-4e64-9185-cdfd7c45d09d + type: Order + totalAmount: -47.66 + currency: GBP + status: InquiryEvidenceRequired + reason: Unhappy with product + dueDate: '2021-03-29T14:39:55' + createdDate: '2021-03-22T14:39:55' + modifiedDate: '2022-02-02T11:02:45Z' + sourceModifiedDate: '2021-03-22T14:39:55' + CommerceDisputes: + title: 'Commerce: Disputes' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceDispute' + - $ref: '#/components/schemas/PagingInfo' + CommerceLocation: + title: 'Commerce: Location' + type: object description: |- - Use the *Get company information* endpoint to return information about the company available from the underlying accounting software. + The Location datatype holds information on the geographic location at which stocks of products may be held, as referenced in the Products data type. - ### 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 - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/CompanyInformation' - 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}/bankFeeds/otp': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - post: - tags: - - Source accounts - summary: Generate one-time password + A Location also holds information on geographic locations where orders were placed, as referenced in the Orders data type. + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + name: + description: Name of this location + type: string + address: + description: Address associated with the location + $ref: '#/components/schemas/CommerceAddress' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + locationRef: + type: object + description: Reference to the geographic location where the order was placed. + properties: + id: + description: The unique identitifer of the location being referenced. + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + name: + description: Name of the location being referenced. + type: string + required: + - id + examples: + - id: '15' + name: London Warehouse + address: + type: Inventory + line1: Warner House + line2: 98 Theobald's Road + city: London + region: '' + country: United Kingdom + postalCode: WC1X 8WB + modifiedDate: '2020-08-12T14:37:37' + sourceModifiedDate: '2020-08-12T14:37:37' + CommerceLocations: + title: 'Commerce: Locations' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceLocation' + - $ref: '#/components/schemas/PagingInfo' + CommerceOrder: + title: 'Commerce: Order' 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. + Orders contain the transaction details for all products sold by the company, and include details of any payments, service charges, or refunds related to each order. You can use data from the Orders endpoints to calculate key metrics, such as gross sales values and monthly recurring revenue (MRR). + allOf: + - type: object + x-stoplight: + id: 516bf0ecc4907 + required: + - id + properties: + id: + type: string + description: 'A unique, persistent identifier for this record' + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + x-codat-validation: + - validator: UniqueWithinConnection + - properties: + orderNumber: + type: string + description: Friendly reference for the order in the commerce or point of sale platform. + country: + description: |- + The Codat country property is returned as it was provided in the underlying platform by the company without any formatting on our part. - > **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. + Depending on the platform the value of this property will either be an ISO 3166 code (2-alpha or 3-alpha) or free-form text returned as a string name in our model. + + For POST operations against platforms that demand a specific format for the country code, we have documented accepted values in the [options](https://docs.codat.io/lending-api#/operations/get-companies-companyId-connections-connectionId-push) endpoint. + type: string + format: ISO3166 Alpha-3 + examples: + - GBR + - USA + - ABW + currency: + allOf: + - $ref: '#/components/schemas/SourceAccount/properties/currency' + - description: Currency in which the order was placed. + closedDate: + $ref: '#/components/schemas/DateTime' + description: 'Date on which order was closed after the product was shipped, paid for, and any refund period had elapsed.' + totalAmount: + description: 'Total amount of the order, including discounts, refunds, and tax, but excluding gratuities.' + type: number + format: decimal + totalRefund: + description: 'Total amount of any refunds issued on the order, including discounts and tax, but excluding gratuities. This is always negative.' + type: number + format: decimal + totalTaxAmount: + description: Total amount of tax applied to the order. + type: number + format: decimal + totalDiscount: + description: 'Total amount of any discounts applied to the order, excluding tax. This is typically positive (for discounts which decrease the amount of the order), but can also be negative (for discounts which increase the amount of the order).' + type: number + format: decimal + totalGratuity: + description: Extra amount added to the order. + type: number + format: decimal + orderLineItems: + type: array + items: + $ref: '#/components/schemas/CommerceOrder/definitions/orderLineItem' + payments: + type: array + items: + $ref: '#/components/schemas/CommercePayment/definitions/paymentRef' + serviceCharges: + type: array + items: + $ref: '#/components/schemas/CommerceOrder/definitions/serviceCharge' + locationRef: + $ref: '#/components/schemas/CommerceLocation/definitions/locationRef' + customerRef: + $ref: '#/components/schemas/CommerceCustomer/definitions/commerceCustomerRef' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - title: Created date + type: object + x-internal: true + properties: + createdDate: + $ref: '#/components/schemas/DateTime' + description: The date the entity was created. + - 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. - [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. + 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. - **Integration-specific behavior** + 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)). - 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: + 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. + + 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: + orderLineItem: + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + quantity: + type: number + format: decimal + description: | + Number of units of the product sold. + For refunds, quantity is negative. + taxPercentage: + type: number + format: decimal + description: Percentage rate (from 0 to 100) of any sales tax applied to the unit price. + examples: + - 0 + - 12.5 + - '45.00' + totalAmount: + type: number + format: decimal + description: 'Total amount of the line item, including discounts and tax.' + totalTaxAmount: + type: number + format: decimal + description: 'Total amount of tax applied to the line item, factoring in any discounts.' + unitPrice: + type: number + format: decimal + description: 'Price per unit of goods or services, excluding discounts and tax.' + taxes: + type: array + items: + $ref: '#/components/schemas/CommerceTaxComponent/definitions/taxComponentAllocation' + description: Taxes breakdown as applied to order lines. + productRef: + $ref: '#/components/schemas/CommerceProduct/definitions/productRef' + productVariantRef: + $ref: '#/components/schemas/CommerceProduct/definitions/productVariantRef' + discountAllocations: + type: array + items: + $ref: '#/components/schemas/CommerceOrder/definitions/orderDiscountAllocation' + serviceCharge: + type: object + properties: + description: + description: Service charges for this order. + type: string + example: A service charge + totalAmount: + description: 'Total amount of the service charge, including tax.' + type: number + format: decimal + examples: + - 0 + - 12.5 + - 45 + taxPercentage: + description: Percentage rate (from 0 to 100) of any tax applied to the service charge. + type: number + format: decimal + examples: + - 0 + - 12.5 + - 45 + taxAmount: + description: Amount of the service charge that is tax. + type: number + format: decimal + examples: + - 0 + - 12.5 + - 45 + taxes: + description: Taxes breakdown as applied to service charges. + type: array + items: + $ref: '#/components/schemas/CommerceTaxComponent/definitions/taxComponentAllocation' + quantity: + description: The number of times the charge is charged. + type: integer + examples: + - 1 + - 12 + - 45 + type: + $ref: '#/components/schemas/CommerceOrder/definitions/serviceChargeType' + serviceChargeType: + description: The type of the service charge. 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 + enum: + - Generic + - Shipping + - Overpayment + - Unknown + example: Overpayment + orderDiscountAllocation: + type: object + properties: + name: + type: string + description: Name of the discount in the commerce or point of sale platform. + example: Promotional Discount + totalAmount: + type: number + format: decimal + description: 'Total amount of discount applied, excluding tax. This is typically positive (for discounts which decrease the amount of the order line), but can also be negative (for discounts which increase the amount of the order line).' + example: 15.25 + examples: + - id: 01e63721-1205-478e-8503-9d8bf8a93f44 + orderNumber: '99123956' + country: CAN + currency: CAD + createdDate: '2021-03-28T03:00:14' + totalAmount: 12 + totalRefund: 0 + totalTaxAmount: 2 + totalDiscount: 0 + totalGratuity: 1 + orderLineItems: + - id: 116113a6-54d3-4624-ba73-26a77a5ffd51 + quantity: 1 + taxPercentage: 20 + totalAmount: 12 + totalTaxAmount: 2 + unitPrice: 10 + taxes: + - taxComponentRef: + id: '72' + name: Sales Tax + taxAmount: '' + - taxComponentRef: + id: '72' + name: City Tax + taxAmount: '' + productRef: + id: ac186646-41f2-4280-afea-1012c59459ab + name: Intelligent Concrete Salad + productVariantRef: + id: f9ca9de5-9e31-460d-ac81-368f4e7c8fc0 + name: Small Incredible Wooden Soap + discountAllocations: [] + payments: + - id: defdceb6-83a3-4b7d-a74e-e9ef947d5f48 + amount: 12 + currency: CAD + type: Paypal + status: Unknown + dueDate: '2021-04-04T03:00:14' + createdDate: '2021-03-28T03:00:14' + modifiedDate: '2022-02-02T11:02:45' + serviceCharges: + - description: Service Charge + totalAmount: 1.2 + taxPercentage: 20 + taxAmount: 0.2 + taxes: + - taxComponentRef: + id: '72' + name: Service Tax + taxAmount: '' + quantity: 1 + type: Generic + locationRef: + id: 47bbffc7-c045-4b0f-a3bb-ecf1f669edfa + customerRef: + id: 2634d180-7205-43f0-a73d-84af6443a005 + name: Emmy Roberts + modifiedDate: '2022-02-02T11:02:45Z' + sourceModifiedDate: '2021-03-28T03:00:14' + type: object + CommerceOrders: + title: 'Commerce: Orders' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceOrder' + - $ref: '#/components/schemas/PagingInfo' + CommercePayment: + title: 'Commerce: Payment' + description: |- + Payments contain details of all payments made by customers to a company, including: amounts, currency used, payment method, payment provider, and payment status. + + Refunds are recorded as separate, negative payments. Note that a refund can only occur in relation to a payment that has been completed (i.e. has a status of `Paid`). When a customer cancels an order _before_ a payment has been completed, the payment shows as `Cancelled`. + + You can use data from the Payments endpoints to calculate key metrics, such as gross sales and monthly recurring revenue (MRR). + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + amount: + type: number + format: decimal + description: Payment Amount (including gratuity) + examples: + - 194.12 + - -283.56 + - 0 + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency in which the payment was made + paymentMethodRef: + $ref: '#/components/schemas/PaymentMethodRef' + status: + $ref: '#/components/schemas/CommercePayment/definitions/paymentStatus' + paymentProvider: + type: string + description: 'Service provider of the payment, if applicable.' + examples: + - Amazon Pay + - Checkout.com + - SagePay + dueDate: + description: Date by which payment must be made + $ref: '#/components/schemas/DateTime' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + paymentStatus: + type: string + x-internal: true + description: Status of the payment. + enum: + - Pending + - Authorized + - Paid + - Failed + - Cancelled + - Unknown + paymentType: + type: string + x-internal: true + nullable: true + description: Type of payment. + enum: + - Cash + - Card + - Invoice + - OnlineCard + - Swish + - Vipps + - Mobile + - StoreCredit + - Paypal + - Custom + - Prepaid + - Unknown + example: Cash + paymentRef: + x-internal: true + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + amount: + type: number + format: decimal + nullable: true + description: Payment Amount (including gratuity). + examples: + - 194.12 + - -283.56 + - 0 + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency in which the payment was made. + type: + $ref: '#/components/schemas/CommercePayment/definitions/paymentType' + status: + $ref: '#/components/schemas/CommercePayment/definitions/paymentStatus' + paymentProvider: + type: string + description: 'Service provider of the payment, if applicable.' + examples: + - Amazon Pay + - Checkout.com + - SagePay + dueDate: + description: Date by which payment must be made + $ref: '#/components/schemas/DateTime' + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + CommercePaymentMethod: + title: 'Commerce: Payment method' + description: A Payment Method represents the payment method(s) used to make payments. + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + name: + type: string + description: The name of the PaymentMethod + example: Alipay + status: + description: Status of the Payment Method. + x-internal: true + type: string + enum: + - Unknown + - Active + - Archived + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + CommercePaymentMethods: + title: 'Commerce: Payment methods' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommercePaymentMethod' + - $ref: '#/components/schemas/PagingInfo' + CommercePayments: + title: 'Commerce: Payments' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommercePayment' + - $ref: '#/components/schemas/PagingInfo' + CommerceProduct: + title: 'Commerce: Product' + description: | + A Product is an item in the company's inventory, and includes information about the price and quantity of all products, and variants thereof, available for sale. + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + name: + type: string + description: Name of the product in the commerce or POS system + examples: + - Hard Drive + - Windows Installation + - Software Support (Hourly) + description: + type: string + description: Description of the product recorded in the commerce or point of sale platform. + examples: + - 1tb Western Digital Hard Drive + - Install of Windows 11 (Professional Edition) + - 1 hour of support from an agent (phone or remote) + categorization: + type: string + description: Retail category that the product is assigned to e.g. `Hardware`. + examples: + - Hardware + - Software + - Support Services + isGiftCard: + type: boolean + description: | + Whether the product represents a gift card or voucher that + can be redeemed in the commerce or POS platform. + variants: + type: array + items: + $ref: '#/components/schemas/CommerceProduct/definitions/productVariant' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + definitions: + productRef: + type: object + description: Reference that links the line item to the correct product details. + properties: + id: + description: The unique identifier of the product being referenced. + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + name: + description: Name of the product being referenced. + type: string + required: + - id + productVariant: + title: Product Variant + description: | + Represents a variation of a product available for sale, for example an item of clothing that may be available for sale in multiple sizes and colors. + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + description: 'Identifier of the product variant, unique to the company.' + - properties: + name: + type: string + examples: + - Red Coat + - Black Coat + - Large Brown Hat + description: Name of the product recorded in the commerce or point of sale platform. + isTaxEnabled: + type: boolean + description: Whether sales taxes are enabled for this product variant. + sku: + type: string + examples: + - Coat-Red-Lrg + - Coat-Black-Md + - LargeBrownHat + - A725BA2 + description: 'SKU (stock keeping unit) of the variant, as defined by the merchant.' + barcode: + type: string + examples: + - '564158468416486458646886484' + - CSE370 + description: 'Unique product number of the variant. This might be a barcode, UPC, ISBN, etc.' + unitOfMeasure: + type: string + examples: + - kg + - m + - meters + description: 'Unit of measure for the variant, such as `kg` or `meters`.' + vatPercentage: + type: number + format: decimal + examples: + - 12.5 + - 0 + - 20 + description: VAT rate for the product variant if sales taxes are enabled. + prices: + type: array + description: Prices for the product variants in different currencies. + items: + $ref: '#/components/schemas/CommerceProduct/definitions/productPrice' + inventory: + $ref: '#/components/schemas/CommerceProduct/definitions/productInventory' + shippingRequired: + type: boolean + description: Indicates whether or not the product requires physical delivery. + status: + $ref: '#/components/schemas/CommerceProduct/definitions/productVariantStatus' + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + productVariantRef: + title: Product variant reference + type: object + description: Reference that links the line item to the specific version of product that has been ordered. + properties: + id: + description: The unique identifier of the product variant being referenced. + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + name: + description: Name of the product variant being referenced. + type: string + required: + - id + productPrice: + title: Product Price Variant + x-internal: true + type: object + properties: + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + nullable: true + unitPrice: + type: number + format: decimal + description: The product variant's unit price. + productInventory: + title: Product Inventory + description: Information about the total inventory as well as the locations inventory is in. + x-internal: true + type: object + properties: + totalQuantity: + type: number + format: decimal + nullable: true + description: The total quantity of stock remaining across locations. + locations: + type: array + items: + $ref: '#/components/schemas/CommerceProduct/definitions/productInventoryLocation' + productInventoryLocation: + title: Product Inventory Location + x-internal: true + type: object + properties: + quantity: + type: number + format: decimal + description: The quantity of stock remaining at location. + locationRef: + $ref: '#/components/schemas/CommerceLocation/definitions/locationRef' + productVariantStatus: + x-internal: true + type: string + description: The status of the product variant. + enum: + - Unknown + - Published + - Unpublished + CommerceProductCategories: + title: 'Commerce: Product categories' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceProductCategory' + - $ref: '#/components/schemas/PagingInfo' + CommerceProductCategory: + title: 'Commerce: Product category' + description: 'Product categories are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile.' + type: object + allOf: + - type: object + properties: + id: + type: string + example: '"102"' + description: The unique identifier of the product category + name: + type: string + example: Entertainment + description: The name of the product category + ancestorRefs: + type: array + description: A collection of parent product categories implicitly ordered with the immediate parent last in the list. + items: + $ref: '#/components/schemas/CommerceRecordRef' + hasChildren: + type: boolean + description: A boolean indicating whether there are other product categories beneath this one in the hierarchy. + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + examples: + - productCategories: + - id: '100' + name: Entertainment + ancestorRefs: [] + hasChildren: true + modifiedDate: '2022-01-01T12:00:00Z' + sourceModifiedDate: '2021-10-01T12:53:21Z' + - id: '101' + name: Cinema + ancestorRefs: + - id: '100' + name: Entertainment + hasChildren: true + modifiedDate: '2022-01-01T12:00:00Z' + sourceModifiedDate: '2021-10-01T12:55:02Z' + - id: '102' + name: Movie + ancestorRefs: + - id: '100' + name: Entertainment + - id: '101' + name: Cinema + hasChildren: false + modifiedDate: '2022-01-01T12:00:00Z' + sourceModifiedDate: '2021-12-25T12:00:00Z' + CommerceProducts: + title: 'Commerce: Products' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceProduct' + - $ref: '#/components/schemas/PagingInfo' + CommerceRecordRef: + title: Record Ref + x-internal: true + type: object + properties: + id: + description: The unique identitifer of the record being referenced + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + type: + description: The type of record being referenced. + type: string + required: + - id + - type + description: '' + CommerceReport: + title: Commerce report 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. + ## Structure - Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software. + Assess reports follow a consistent structure. Reports contain four sections of information: - 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. + ### 1. Report definition - Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software. + Information such as: - 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'. + 1. The report info (e.g. enhanced_profit_and_loss). + 2. The display name of the report (e.g. Enhanced Profit and Loss). + + ### 2. Dimension info - 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). + Information about the dimension contained in the reports such as: - 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. + 1. The type of dimension (e.g. datetime, recordRef). + 2. The display name of the dimension (e.g. Period, Category type, Category sub type). + 3. The details about each item within the dimension (e.g. displayName:"Jan 2022", start:"...", end:"...", id:"...", name:"..."). - A sync is a single execution that fetches bank transactions from a connected bank account and records them in the company's accounting software. + ### 3. Measure info - 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' - '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' - '409': - $ref: '#/components/responses/Conflict' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' -webhooks: - client.rateLimit.reached: - post: - description: Called when your client’s request count to Codat's API surpasses the allocated quota. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ClientRateLimitWebhook' - examples: - Reached: - value: - id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b - eventType: client.rateLimit.reached - generatedDate: '2024-09-01T00:00:00Z' - payload: - dailyQuota: 12000 - quotaRemaining: 0 - expiryDate: '2024-09-01T12:14:14Z' - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - client.rateLimit.reset: - post: - description: 'Called when your client''s rate limit quota is reset, allowing additional requests to Codat''s API.' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ClientRateLimitWebhook' - examples: - Reset: - value: - id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b - eventType: client.rateLimit.reset - generatedDate: '2024-09-01T00:00:00Z' - payload: - dailyQuota: 12000 - quotaRemaining: 11993 - expiryDate: '2024-09-01T23:59:99Z' - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - 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 + Information about the measures contained in the report such as: + + 1. The display name of the measure (e.g. value of account, percentage change). + 2. The type of the measure (e.g. currency, percentage). + 3. The unit of the measure (e.g. %, GBP). + + ### 4. The data for the report + + When the *includeDisplayName* parameter is set to *true*, it shows the *dimensionDisplayName* and *itemDisplayName* to make the data human-readable. The default setting for *includeDisplayName* is *false*. + + + ## Displaying the report + + Reports can be rendered as follows (ordering is implicit rather than explicit): + + ![A table showing an example of how a report can be rendered](https://files.readme.io/1fa20ca-Report1.png) + + # Data model + + ## Dimensions type: object properties: - username: + reportInfo: + type: object + additionalProperties: + type: string + dimensions: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/commerceReportDimension' + measures: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/commerceReportMeasure' + reportData: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/commerceReportComponent' + errors: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/commerceReportError' + definitions: + commerceReportMeasure: + title: Measure + type: object + properties: + displayName: + description: The measure's display name. + type: string + units: + type: string + description: The measure's units e.g. percentage (%). + index: + type: integer + description: The measure's index. + type: + type: string + description: The measure's type. + commerceReportError: + title: Error + type: object + properties: + message: + type: string + description: Message returned by error. + type: + type: string + description: The type of error. + details: + description: Additional details on the error. + type: object + additionalProperties: + type: array + items: + type: string + commerceReportDimension: + title: Dimension + type: object + properties: + index: + type: integer + description: The dimension's index. + displayName: + type: string + description: The dimension's display name. + type: + type: string + description: The dimension's type. + items: + type: array + items: + type: object + properties: + index: + type: integer + description: The dimension's items index. + commerceReportComponent: + title: Report component + type: object + properties: + dimension: + type: integer + description: The component's dimension. + dimensionDisplayName: + type: string + description: The component's display name. + item: + type: integer + description: The component's item number. + itemDisplayName: + type: string + description: The component's item display name. + measures: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/reportComponentMeasure' + components: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/commerceReportComponent' + reportComponentMeasure: + type: object + title: Report component measure + properties: + index: + type: integer + description: The measure's index. + measureDisplayName: + type: string + description: The measure's display name. + value: + type: number + format: decimal + description: The measure's value. + x-examples: + Example 1: + reportInfo: + additionalProp1: string + additionalProp2: string + additionalProp3: string + dimensions: + - index: 0 + displayName: string + type: string + items: + - index: 0 + measures: + - displayName: string + units: string + index: 0 + type: string + reportData: + - dimension: 0 + dimensionDisplayName: string + item: 0 + itemDisplayName: string + measures: + - index: 0 + measureDisplayName: string + components: + - string + errors: + - message: string + type: DatesOutOfRange + details: + additionalProp1: + - string + additionalProp2: + - string + additionalProp3: + - string + CommerceTaxComponent: + title: 'Commerce: Tax component' + description: 'The Tax Components endpoints return tax rates data from the commerce software, including tax rate names and values. This is to support the mapping of tax rates from the commerce software to those in the accounting software.' + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + name: + type: string + description: Name of the Tax Rate Component in the source commerce software. + example: Sales Tax + rate: + description: Rate of taxation represented as a fraction of the net price (typically in the range 0.00 - 1.00). + type: number + format: decimal + examples: + - 0.15 + - 0.2 + isCompound: + description: The Boolean flag to indicate when a Tax Rate Component compounds on a sale. + type: boolean + examples: + - true + - false + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - name + definitions: + taxComponentAllocation: + title: Tax Component Allocation + type: object + properties: + taxComponentRef: + $ref: '#/components/schemas/CommerceTaxComponent/definitions/taxComponentRef' + rate: + description: Tax amount on order line sale as available from source commerce software. + type: number + format: decimal + nullable: true + taxComponentRef: + type: object + description: Taxes rates reference object depending on the rates being available on source commerce software. + properties: + id: + description: The unique identitifer of the tax component being referenced. + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + name: + description: Name of the tax component being referenced. + type: string + required: + - id + - name + examples: + - id: 13d946f0-c5d5-42bc-b092-97ece17923ab + name: Sales Tax (15%) + rate: 0.15 + isCompound: true + modifiedDate: '2022-10-23T00:00:00Z' + sourceModifiedDate: '2022-10-23T00:00:00Z' + CommerceTransaction: + title: 'Commerce: Transaction' + description: |- + Details of all financial transactions recorded in the commerce or point of sale system are added to the Transactions data type. For example, payments, service charges, and fees. + + You can use data from the Transactions endpoints to calculate key metrics, such as: + - Transaction volumes + - Average transaction volume + - Average transaction value + - Returns + - Payouts + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + totalAmount: + description: The total transaction amount + type: number + format: decimal + examples: + - 194.12 + - -283.56 + - 0 + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + type: + $ref: '#/components/schemas/CommerceTransaction/definitions/transactionType' + subType: + description: Non-standardised transaction type data from the commerce software + type: string + examples: + - CardPayment + - Invoice payment + transactionSourceRef: + description: Link to the source event which triggered this transaction + allOf: + - $ref: '#/components/schemas/CommerceTransaction/definitions/transactionSourceRef' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - allOf: + - type: object + x-stoplight: + id: c590b4405180f + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - type: object + x-stoplight: + id: gdyjg7bg783br + properties: + sourceCreatedDate: + $ref: '#/components/schemas/DateTime' + description: The date on which this record was created in the originating system + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + x-stoplight: + id: 9e815c1766554 + definitions: + transactionSourceRef: + title: Transaction Source Reference + x-internal: true + allOf: + - $ref: '#/components/schemas/CommerceRecordRef' + - type: object + properties: + type: + $ref: '#/components/schemas/CommerceTransaction/definitions/transactionSourceType' + transactionSourceType: + x-internal: true type: string - example: S0MW-TR0P-7DS0 - description: Username used by the bank feeds platform to retrieve transactions - password: + description: The type of source the transaction arose. + enum: + - Fee + - Order + - Payment + - ServiceCharge + - Unknown + transactionType: + x-internal: true + description: |- + The type of the platform transaction: + - `Unknown` + - `FailedPayout` — Failed transfer of funds from the seller's merchant account to their bank account. + - `Payment` — Credit and debit card payments. + - `PaymentFee` — Payment provider's fee on each card payment. + - `PaymentFeeRefund` — Payment provider's fee that has been refunded to the seller. + - `Payout` — Transfer of funds from the seller's merchant account to their bank account. + - `Refund` — Refunds to a customer's credit or debit card. + - `Transfer` — Secure transfer of funds to the seller's bank account. 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: + enum: + - Payment + - Refund + - Payout + - FailedPayout + - Transfer + - PaymentFee + - PaymentFeeRefund + - Unknown + examples: [] + CommerceTransactions: + title: 'Commerce: Transactions' 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. - - ## Overview - - A list of bank accounts associated with a company and a specific data connection. - - Bank accounts data includes: - * The name and ID of the account in the accounting software. - * The currency and balance of the account. - * The sort code and account number. - type: object - allOf: - - properties: - id: - type: string - description: 'Identifier for the account, unique for the company in the accounting software.' - - $ref: '#/components/schemas/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. - - 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. - - 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. - - 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: - bankAccountPrototype: - title: Bank account prototype - type: object - properties: - accountName: - type: string - nullable: true - description: Name of the bank account in the accounting software. - accountType: - title: Bank Account Type - x-internal: true - enum: - - Unknown - - Credit - - Debit - type: string - description: |- - The type of transactions and balances on the account. - For Credit accounts, positive balances are liabilities, and positive transactions **reduce** liabilities. - For Debit accounts, positive balances are assets, and positive transactions **increase** assets. - nominalCode: - type: string - nullable: true - description: Code used to identify each nominal account for a business. - sortCode: - type: string - nullable: true - description: |- - Sort code for the bank account. - - Xero integrations - The sort code is only displayed when the currency = GBP and the sort code and account number sum to 14 digits. For non-GBP accounts, this field is not populated. - accountNumber: - type: string - nullable: true - description: |- - Account number for the bank account. - - Xero integrations - Only a UK account number shows for bank accounts with GBP currency and a combined total of sort code and account number that equals 14 digits, For non-GBP accounts, the full bank account number is populated. - - FreeAgent integrations - For Credit accounts, only the last four digits are required. For other types, the field is optional. - iBan: - type: string - nullable: true - description: International bank account number of the account. Often used when making or receiving international payments. - currency: - $ref: '#/components/schemas/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 + $ref: '#/components/schemas/CommerceTransaction' + - $ref: '#/components/schemas/PagingInfo' + Companies: + title: Companies + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/Company' + - $ref: '#/components/schemas/PagingInfo' + Company: + title: Company + description: "\uFEFFIn Codat, a company represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/lending-api#/schemas/Connection) to different data sources such as one connection to [Xero](https://docs.codat.io/integrations/accounting/xero/accounting-xero) for accounting data, two connections to [Plaid](https://docs.codat.io/integrations/banking/plaid/banking-plaid) for two bank accounts and a connection to [Zettle](https://docs.codat.io/integrations/commerce/zettle/commerce-zettle) for POS data.\n\nTypically each company is one of your customers.\n\nWhen you create a company, you can specify a `name` and we will automatically generate a unique `id` for the company. You can also add a `description` to store any additional information about the company." + type: object + allOf: + - $ref: '#/components/schemas/Company/definitions/companyDetails' + - type: object + properties: + dataConnections: + type: array + items: + $ref: '#/components/schemas/Connection' + definitions: + companyDetails: + title: Company details + type: object + properties: + id: + $ref: '#/components/parameters/companyId/schema' + name: + type: string + description: The name of the company + example: Codat Ltd. + description: + $ref: '#/components/schemas/CompanyRequestBody/properties/description' + nullable: true + redirect: + type: string + format: uri + description: 'The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company.' + example: 'https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739' + lastSync: + $ref: '#/components/schemas/DateTime' + nullable: true + created: + $ref: '#/components/schemas/DateTime' + createdByUserName: + type: string + description: Name of user that created the company in Codat. + nullable: true + products: + type: array + items: + type: string + description: An array of products that are currently enabled for the company. + tags: + title: Tags + type: object + maxProperties: 10 + propertyNames: + pattern: '^.{1,27}$' + additionalProperties: + type: string + maxLength: 100 + description: A collection of user-defined key-value pairs that store custom metadata against the company. + referenceParentCompany: + $ref: '#/components/schemas/Company/definitions/companyReference' + nullable: true + description: The parent entity or controlling organization of this company. Null if the company has no parent. + referenceSubsidiaryCompanies: + type: array + nullable: false + description: A list of subsidiary companies owned or controlled by this entity. Empty if the company has no children. + minItems: 0 + items: + $ref: '#/components/schemas/Company/definitions/companyReference' + required: + - id + - name + - redirect + companyReference: + title: Company reference + type: object + properties: + id: + $ref: '#/components/parameters/companyId/schema' + name: + $ref: '#/components/schemas/Company/definitions/companyDetails/properties/name' + description: + $ref: '#/components/schemas/Company/definitions/companyDetails/properties/description' + links: + type: object + description: A collection of links for the company. + properties: + portal: + type: string + format: uri + description: Link to the company page in the portal. + tags: + $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' + examples: + - id: 0498e921-9b53-4396-a412-4f2f5983b0a2 + name: string + redirect: 'https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739' + lastSync: '2022-01-01T12:00:00.000Z' + created: '2022-01-01T12:00:00.000Z' + createdByUserName: string + tags: + region: us + uid: f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c + dataConnections: + - id: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd + integrationId: bf083d72-62c7-493e-aec9-81b4dbba7e2c + integrationKey: dfxm + sourceId: bdd831ce-eebd-4896-89a7-20e5ee8989ee + platformName: Basiq + linkUrl: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' + status: Linked + lastSync: '2022-10-27T10:22:43.6464237Z' + created: '2022-10-27T09:53:29Z' + sourceType: Banking + products: + - spend-insights + - lending + CompanyRequestBody: + title: Create company request + x-internal: true type: object - additionalProperties: false properties: - sourceAccountId: + name: type: string - description: Unique ID for the source account - targetAccountId: + description: Name of company being connected. + pattern: '^[A-Za-z0-9\s\-'',&@.,?!\s]+$' + minLength: 1 + example: Bank of Dave + description: type: string - nullable: true - description: Unique ID for the target account - feedStartDate: - $ref: '#/components/schemas/DateTime' - nullable: true - description: The date from which bank transactions can be provided to the platform. + example: Requested early access to the new financing scheme. + description: 'Additional information about the company. This can be used to store foreign IDs, references, etc.' + tags: + $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' required: - - sourceAccountId - examples: - - sourceAccountId: acc-002 - targetAccountId: account-081 - BankFeedAccountMappingResponse: - title: Bank feed account mapping response + - name + CompanyUpdateRequest: + title: Update company request + x-internal: true type: object - additionalProperties: false properties: - sourceAccountId: + name: type: string - description: Unique ID for the source account. - targetAccountId: + description: Name of company being connected. + pattern: '^[A-Za-z0-9\s\-'',&@.,?!\s]+$' + minLength: 1 + example: Bank of Dave + description: + $ref: '#/components/schemas/CompanyRequestBody/properties/description' + tags: + $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' + Connection: + title: Connection + description: "\uFEFFA connection represents a [company's](https://docs.codat.io/lending-api#/schemas/Company) connection to a data source and allows you to synchronize data (pull and/or push) with that source.\n\nA company can have multiple data connections depending on the type of data source it is connecting to. For example, a single company can link to:\n\n- [Accounting data](https://docs.codat.io/accounting-api/overview) - 1 active connection.\n- [Banking data](https://docs.codat.io/banking-api/overview) - Multiple active connections.\n- [Commerce data](https://docs.codat.io/commerce-api/overview) - Multiple active connections.\nAny combination of accounting, banking, and commerce data connections is allowed.\n\nBefore you can use a data connection to pull or push data, the company must grant you access to their business data by [linking the connection](https://docs.codat.io/auth-flow/overview)." + type: object + properties: + id: + $ref: '#/components/parameters/connectionId/schema' + integrationId: type: string - nullable: true - description: Unique ID for the target account. - status: + format: uuid + example: fd321cb6-7963-4506-b873-e99593a45e30 + description: A Codat ID representing the integration. + integrationKey: type: string - nullable: true - description: Status of the POST request. - error: + description: A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future. + sourceId: + type: string + format: uuid + example: 35b92968-9851-4095-ad60-395c95cbcba4 + description: 'A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`.' + sourceType: + title: Source Type + description: The type of platform of the connection. + type: string + enum: + - Accounting + - Banking + - BankFeed + - Commerce + - Expense + - Other + - Unknown + example: Accounting + platformName: + type: string + description: Name of integration connected to company. + linkUrl: type: string + format: uri + description: The link URL your customers can use to authorize access to their business application. + example: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/2e2eb431-c1fa-4dc9-93fa-d29781c12bcd/start' + status: + $ref: '#/components/schemas/Connection/definitions/dataConnectionStatus' + lastSync: + $ref: '#/components/schemas/DateTime' 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 - type: object + created: + $ref: '#/components/schemas/DateTime' + dataConnectionErrors: + type: array + nullable: true + items: + $ref: '#/components/schemas/Connection/definitions/dataConnectionError' + connectionInfo: + type: object + nullable: true + additionalProperties: true additionalProperties: false - properties: - sourceAccountId: + required: + - id + - integrationId + - sourceId + - platformName + - linkUrl + - status + - created + - sourceType + definitions: + dataConnectionStatus: + title: Data connection status + description: The current authorization status of the data connection. type: string - description: Unique ID for the source account. - sourceAccountName: + enum: + - PendingAuth + - Linked + - Unlinked + - Deauthorized + dataConnectionError: + title: Data connection error + type: object + properties: + statusCode: + type: string + description: The HTTP status code returned by the source platform when the error occurred. + statusText: + type: string + description: A non-numeric status code/text returned by the source platform when the error occurred. + errorMessage: + type: string + description: A message about a error returned by Codat. + erroredOnUtc: + $ref: '#/components/schemas/DateTime' + status: + title: Error status + description: The current status of a transient error. Null statuses indicate that the error is not transient. + type: string + nullable: true + enum: + - Active + - Resolved + resolvedOnUtc: + description: The datetime in Utc that the error was resolved. + nullable: true + $ref: '#/components/schemas/DateTime' + dataConnectionSourceType: + title: Source Type + description: The type of platform of the connection. type: string - description: Name for the source account. - sourceAccountNumber: + enum: + - Accounting + - Banking + - BankFeed + - Commerce + - Expense + - Other + - Unknown + example: Accounting + example: + id: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd + integrationId: bf083d72-62c7-493e-aec9-81b4dbba7e2c + integrationKey: dfxm + sourceId: bdd831ce-eebd-4896-89a7-20e5ee8989ee + platformName: Basiq + linkUrl: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' + status: Linked + lastSync: '2022-10-27T10:22:43.6464237Z' + created: '2022-10-27T09:53:29Z' + sourceType: Banking + Connections: + title: Connections + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/Connection' + - $ref: '#/components/schemas/PagingInfo' + DataIntegrityDetail: + title: Data integrity detail + type: object + properties: + id: type: string - description: Account number for the source account. - sourceBalance: - type: number - format: decimal - description: Balance for the source account. - sourceCurrency: - $ref: '#/components/schemas/SourceAccount/properties/currency' - targetAccountId: + description: ID GUID of the transaction. + type: type: string - nullable: true - description: Unique ID for the target account in the accounting software. - targetAccountName: + description: The data type of the record. + connectionId: type: string - description: Name for the target account in the accounting software. - status: + format: uuid + description: ID GUID representing the connection of the accounting or banking platform. + readOnly: true + date: + $ref: '#/components/schemas/DateTime' + description: The date of the transaction. + description: type: string - description: The status. - targetAccountOptions: + description: The transaction description. + amount: + type: number + format: decimal + description: The transaction value. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency of the transaction. + matches: 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.' + $ref: '#/components/schemas/DataIntegrityDetail/definitions/dataIntegrityMatch' definitions: - targetAccountOption: - title: Target Account Option + dataIntegrityMatch: type: object properties: id: type: string - description: Id of the target account. - name: + description: ID GUID of the transaction. + type: type: string - nullable: true - description: Name of the target account. - balance: - type: number - format: decimal - nullable: true - description: The balance of the account. - sortCode: + description: 'The data type which the data type in the URL has been matched against. For example, if you''ve matched accountTransactions and banking-transactions, and you call this endpoint with accountTransactions in the URL, this property would be banking-transactions.' + connectionId: type: string - nullable: true - description: The sort code of the account. - accountNumber: + description: ID GUID representing the connection of the accounting or banking platform. + format: uuid + date: type: string - nullable: true - description: The account number of the account. - bankFeedMappings: - title: Bank feed mappings + description: The date of the transaction. + description: + type: string + description: The transaction description. + amount: + type: string + description: The transaction value. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency of the transaction. + DataIntegrityDetails: + title: Data integrity details + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/DataIntegrityDetail' + - $ref: '#/components/schemas/PagingInfo' + DataIntegrityStatus: + title: Data integrity status + type: object + allOf: + - $ref: '#/components/schemas/DataIntegritySummary/definitions/dataIntegrityType' + - type: object + properties: + statusInfo: + $ref: '#/components/schemas/DataIntegrityStatus/definitions/dataIntegrityStatusInfo' + connectionIds: + $ref: '#/components/schemas/DataIntegrityStatus/definitions/dataIntegrityConnectionId' + amounts: + $ref: '#/components/schemas/DataIntegrityStatus/definitions/dataIntegrityAmounts' + dates: + $ref: '#/components/schemas/DataIntegrityStatus/definitions/dataIntegrityDates' + definitions: + dataIntegrityStatusInfo: + type: object + properties: + lastMatched: + type: string + $ref: '#/components/schemas/DateTime' + description: The date the matching algorithm last ran against the company’s data type specified. + readOnly: true + currentStatus: + $ref: '#/components/schemas/DataIntegrityStatus/definitions/integrityStatus' + statusMessage: + type: string + description: Detailed explanation supporting the status value. + dataIntegrityConnectionId: + type: object + properties: + source: + type: array + description: An array of strings. The connection IDs for the type specified in the url. + items: + type: string + target: + type: array + description: An array of strings. The connection IDs for the type being matched to. + items: + type: string + dataIntegrityAmounts: + type: object + description: 'Only returned for transactions. For accounts, there is nothing returned.' + properties: + min: + type: number + format: decimal + description: Lowest value of transaction set. + max: + type: number + format: decimal + description: Highest value of transaction set. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + dataIntegrityDates: + type: object + description: 'Only returned for transactions. For accounts, there is nothing returned.' + properties: + minDate: + $ref: '#/components/schemas/DateTime' + description: Earliest date of transaction set. + readOnly: true + maxDate: + $ref: '#/components/schemas/DateTime' + description: Latest date of transaction set. + readOnly: true + minOverlappingDate: + $ref: '#/components/schemas/DateTime' + description: Earliest date where transactions exist in both accounting and banking platforms. + readOnly: true + maxOverlappingDate: + $ref: '#/components/schemas/DateTime' + description: Latest date where transactions exist in both account and banking platforms. + readOnly: true + integrityStatus: + type: string + enum: + - Unknown + - DoesNotExist + - Error + - Complete + description: The current status of the most recently run matching algorithm. + examples: + - type: string + statusInfo: + lastMatched: '2021-10-24T14:15:22Z' + currentStatus: Unknown + statusMessage: string + connectionIds: + source: + - d5a8d1b2-b38a-4e44-8641-548ad43be6bb + - da8c9f39-8af9-4a98-964b-f1e207942837 + target: + - 3d7ce25a-c107-44bc-8e0c-36c10bdd14e0 + - a5300eac-01fa-4a77-b5b0-ea0b86a3be69 + amounts: + min: 130 + max: 2450 + currency: GBP + dates: + minDate: '2021-09-17T12:09:33.441Z' + maxDate: '2021-12-16T12:12:53.441Z' + minOverlappingDate: '2021-09-30T12:09:13.441Z' + maxOverlappingDate: '2021-11-27T12:19:33.441Z' + DataIntegrityStatuses: + title: Data integrity statuses + x-internal: true + type: object + properties: + metadata: 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 - ClientRateLimitWebhook: - title: Client rate limit webhook + $ref: '#/components/schemas/DataIntegrityStatus' + DataIntegritySummaries: + title: Data integrity summaries + x-internal: true type: object properties: - id: + summaries: + type: array + items: + $ref: '#/components/schemas/DataIntegritySummary' + DataIntegritySummary: + title: Data integrity summary + type: object + allOf: + - $ref: '#/components/schemas/DataIntegritySummary/definitions/dataIntegrityType' + - type: object + properties: + byAmount: + $ref: '#/components/schemas/DataIntegritySummary/definitions/dataIntegrityByAmount' + byCount: + $ref: '#/components/schemas/DataIntegritySummary/definitions/dataIntegrityByCount' + definitions: + dataIntegrityType: + type: object + properties: + type: + type: string + description: 'The data type which the data type in the URL has been matched against. For example, if you''ve matched accountTransactions and banking-transactions, and you call this endpoint with accountTransactions in the URL, this property would be banking-transactions.' + dataIntegrityByAmount: + title: Data integrity by amount + type: object + properties: + matchPercentage: + type: number + format: decimal + description: The percentage of the absolute value of transactions of the type specified in the route which have a match. + unmatched: + type: number + format: decimal + description: The sum of the absolute value of transactions of the type specified in the route which don't have a match. + matched: + type: number + format: decimal + description: The sum of the absolute value of transactions of the type specified in the route which have a match. + total: + type: number + format: decimal + description: The total of unmatched and matched. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + dataIntegrityByCount: + title: Data integrity by count + type: object + properties: + matchPercentage: + type: number + format: decimal + description: The percentage of records of the type specified in the route which have a match. + unmatched: + type: number + format: decimal + description: The number of records of the type specified in the route which don't have a match. + matched: + type: number + format: decimal + description: The number of records of the type specified in the route which do have a match. + total: + type: number + format: decimal + description: The total of unmatched and matched. + 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: + dataType: + title: Data types + x-internal: true + type: string + description: Available data types + enum: + - accountTransactions + - balanceSheet + - bankAccounts + - bankTransactions + - billCreditNotes + - billPayments + - bills + - cashFlowStatement + - chartOfAccounts + - company + - creditNotes + - customers + - directCosts + - directIncomes + - invoices + - itemReceipts + - items + - journalEntries + - journals + - paymentMethods + - payments + - profitAndLoss + - purchaseOrders + - salesOrders + - suppliers + - taxRates + - trackingCategories + - transfers + - banking-accountBalances + - banking-accounts + - banking-transactionCategories + - banking-transactions + - commerce-companyInfo + - commerce-customers + - commerce-disputes + - commerce-locations + - commerce-orders + - commerce-paymentMethods + - commerce-payments + - commerce-productCategories + - commerce-products + - commerce-taxComponents + - commerce-transactions + example: invoices + lastSuccessfulSync: + $ref: '#/components/schemas/DateTime' + currentStatus: + $ref: '#/components/schemas/PullOperation/properties/status' + latestSyncId: type: string + description: Unique identifier for most recent sync of data type. format: uuid - example: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b - description: Unique identifier of the event. - eventType: + example: ad474a37-2003-478e-baee-9af9f1ec2fe3 + latestSuccessfulSyncId: type: string - description: The type of event. - examples: - - client.rateLimit.reset - - client.rateLimit.reached - generatedDate: - $ref: '#/components/schemas/DateTime' - description: The date time in UTC the event was generated in Codat. - payload: - $ref: '#/components/schemas/ClientRateLimitWebhook/definitions/clientRateLimitWebhookPayload' + description: Unique identifier for the most recent successful sync of data type. + format: uuid + example: 8220fc90-55b6-47bc-9417-48ac6ea93101 + examples: + - dataType: string + lastSuccessfulSync: '2022-01-01T13:00:00.000Z' + currentStatus: string + latestSyncId: ad474a37-2003-478e-baee-9af9f1ec2fe3 + latestSuccessfulSyncId: 8220fc90-55b6-47bc-9417-48ac6ea93101 + DataStatusResponse: + x-internal: true + title: Data status response + type: object + additionalProperties: + $ref: '#/components/schemas/DataStatus' + DataType: + x-internal: true + $ref: '#/components/schemas/DataStatus/properties/dataType' + 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. + EndUploadSessionRequest: + title: End upload session request + type: object + properties: + status: + type: string + enum: + - Cancel + - Process + description: An indicator to cancel the dataset processing or trigger ingestion and enrichment of data. + EnhancedCashFlowTransactions: + title: Enhanced cash flow transactions + description: |- + > **Categorization engine** + > + > The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source. + + The Enhanced Cash Flow Transactions endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources. + type: object + properties: + reportInfo: + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/reportInfo' + dataSources: + type: array + items: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/dataSource' + reportItems: + type: array + items: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowItem' definitions: - clientRateLimitWebhookPayload: - title: Client rate limit webhook payload + dataSource: type: object properties: - dailyQuota: - type: integer - description: The number of available requests per day. - quotaRemaining: - type: integer - description: Total number of requests remaining for your client. - expiryDate: - $ref: '#/components/schemas/DateTime' - description: The date time in UTC when your daily quota is reset. - Companies: - title: Companies - x-internal: true - allOf: - - type: object - properties: - results: + accounts: + description: 'An array containing bank account data for each connected banking data source that have the following data types enabled: `banking-accounts`, `banking-transactions`.' type: array items: - $ref: '#/components/schemas/Company' - - type: object - title: Pagination information - x-internal: true + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/accounts' + accounts: + title: Accounts + type: object 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 + sourceRef: + title: Report source reference + description: A source reference containing the `sourceType` object "Banking". type: object properties: - href: + sourceType: + description: The data source type. 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' - 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." + examples: + - Example: + value: + sourceRef: + sourceType: Banking + platformName: + description: 'Name of the banking data source, e.g. "Plaid".' + type: string + accountProvider: + description: The bank or other financial institution providing the account. + type: string + accountName: + description: The name of the account according to the provider. + type: string + accountType: + description: 'The type of banking account, e.g. credit or debit.' + type: string + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency code for the bank account. + currentBalance: + description: The balance of the bank account. + type: number + format: decimal + enhancedCashFlowItem: + type: object + properties: + transactions: + description: An array of transaction data. + type: array + items: + title: Cash flow transaction + type: object + properties: + id: + description: The unique identifier of the bank transaction. + type: string + date: + description: The date the bank transaction was posted. + $ref: '#/components/schemas/DateTime' + description: + description: The description of the bank transaction. + type: string + amount: + description: The bank transaction amount. + type: number + format: decimal + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency code for bank transaction. + transactionCategory: + description: Contains an array of category levels. + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowItem/properties/transactions/items/definitions/transactionCategory' + platformName: + description: Returns the payment processor responsible for the transaction. + type: string + counterpartyNames: + description: An array of counterparty names involved in the transaction. + type: array + items: + type: string + sourceRef: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/accounts/properties/sourceRef' + accountRef: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowItem/properties/transactions/items/definitions/accountRef' + modifiedDate: + description: The date the bank transaction was last modified. + $ref: '#/components/schemas/DateTime' + isRecurring: + description: Indicates if the transaction is classified as recurring by Codat's categorization engine. + type: boolean + nullable: true + definitions: + accountRef: + title: Account reference + description: An account reference containing the account id and name. + type: object + properties: + id: + description: The id of the account. + type: string + name: + description: The name of the account. + type: string + examples: + - Example: + value: + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + transactionCategory: + title: Transaction category + type: object + properties: + confidence: + description: Returns the aggregate confidence of the suggested category for the transaction. The value is between 0 and 100. + type: number + format: decimal + confidences: + description: An ordered array of category level confidences where each element is the confidence of the corresponding item in the `levels` array. + type: array + items: + type: number + format: decimal + levels: + description: The suggested category is an ordered array of category levels where each element (or level) is a subcategory of the previous element (or level). + type: array + items: + type: string + examples: + - Example: + value: + transactionCategory: + confidence: 92.7 + levels: + - Asset + - Current + - Bank + - BankTransfers + - ShareholderTransfers + confidences: + - 92.7 + - 95 + - 96 + - 97.5 + - 100 + examples: + - reportInfo: + pageNumber: 1 + pageSize: 100 + totalResults: 2401 + reportName: Cash Flow transactions report + companyName: Example Company + generatedDate: '2023-01-25T22:36:05.125Z' + dataSources: + - accounts: + - sourceRef: + sourceType: Banking + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + platformName: Plaid + accountProvider: Bank of Sandbox + accountName: Business Current Account + accountType: Debit + currency: USD + currentBalance: 1000 + identifiers: + - type: Debit + subType: Current + number: 12345678 + bankCode: 123456 + iban: US123456789 + bic: US123456789 + maskedAccountNumber: 1234 + - sourceRef: + sourceType: Banking + id: 12345678-1234-1234-1234-123456789012 + platformName: Plaid + accountProvider: Bank of Sandbox + accountName: Business Saving Account + accountType: Debit + currency: USD + currentBalance: 5321 + identifiers: + - type: Debit + subType: Saving + number: 87654321 + bankCode: 654321 + iban: US987654321 + bic: US987654321 + maskedAccountNumber: 4321 + reportItems: + - transactions: + - sourceRef: + sourceType: Banking + - accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + date: '2023-01-25' + description: Payment to supplier + amount: 100 + currency: USD + transactionCategory: + confidence: 92.7 + levels: + - Asset + - Current + - Bank + confidences: + - 92.7 + - 95 + - 96 + platformName: Plaid + counterpartyNames: + - Counterparty + modifiedDate: '2023-01-25T22:36:05.125Z' + - sourceRef: + sourceType: Banking + - accountRef: + id: 12345678-1234-1234-1234-123456789012 + name: Business Saving Account + id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + date: '2023-01-25' + description: Payment to supplier + amount: 100 + currency: USD + transactionCategory: null + confidence: 92.7 + levels: + - Expense + - Operating + confidences: + - 92.7 + - 95 + platformName: Plaid + counterpartyNames: [] + modifiedDate: '2023-01-25T22:36:05.125Z' + EnhancedFinancialReport: + title: Enhanced report type: object - allOf: - - $ref: '#/components/schemas/Company/definitions/companyDetails' - - type: object + properties: + reportInfo: + $ref: '#/components/schemas/EnhancedFinancialReport/definitions/enhancedReportInfo' + reportItems: + type: array + description: An array of report items. + items: + title: Report item + type: object + properties: + date: + $ref: '#/components/schemas/DateTime' + description: Last date of the period. + balance: + type: number + format: decimal + description: Balance of the account as reported on the profit and loss or Balance sheet. + accountName: + type: string + description: Name of the account. + accountId: + type: string + description: The unique account ID. + accountCategory: + $ref: '#/components/schemas/EnhancedFinancialReport/definitions/enhancedReportAccountCategory' + definitions: + enhancedReportAccountCategory: + title: Account category + descrciption: 'An object containing the suggested or confirmed account categories, up to five levels.' + type: object properties: - dataConnections: + status: + type: string + description: 'Returns a status of "Suggested" or "Confirmed". If an account has a confirmed category, it will replace any suggested category returned.' + levels: type: array items: - $ref: '#/components/schemas/Connection' + $ref: '#/components/schemas/EnhancedFinancialReport/definitions/accountCategoryLevel' + accountCategoryLevel: + title: Account category level + description: An object containing an ordered list of account category levels. + type: object + properties: + levelName: + type: string + description: Account category name. + confidence: + type: number + format: decimal + description: Confidence level of the category. This will only be populated where `status` is `Suggested`. + enhancedReportInfo: + type: object + properties: + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the P&L/Balance sheet. + reportName: + type: string + description: The name of the report. + companyName: + type: string + description: Name of the company queried. + generatedDate: + $ref: '#/components/schemas/DateTime' + description: Returns the YYYY-MM-DD datetime of report generation. + examples: + - reportInfo: + reportName: EnhancedProfitAndLossAccounts + companyName: ABC LTD + generatedDate: '2022-01-01' + reportItems: + - date: '2022-01-01' + balance: 70 + accountName: Sales UK + accountId: 13931cbf-ea06-4d6e-9538-a8457fa66011 + accountCategory: + status: Suggested + levels: + - levelName: Income + confidence: 0.95 + - levelName: Revenue + confidence: 0.9 + - date: '2022-01-01' + balance: 30 + accountName: Sales US + accountId: 13931cbf-ea06-4d6e-9538-a8457fa66011 + accountCategory: + lastUpdated: '2022-01-02' + status: Suggested + levels: + - levelName: Income + confidence: 0.95 + - levelName: Revenue + confidence: 0.9 + - date: '2022-01-01' + balance: 70 + accountName: Amazon + accountId: 13931cbf-ea06-4d6e-9538-a8457fa66011 + accountCategory: + lastUpdated: '2022-01-02' + status: Suggested + levels: + - levelName: Income + confidence: 0.95 + - levelName: Revenue + confidence: 0.95 + - levelName: Online + confidence: 0.8 + EnhancedInvoicesReport: + title: Enhanced invoices report + description: The enhanced invoices report takes the key elements of the Invoices report verifying those marked as paid in the accounting software have actually been paid by matching with the bank statement. + type: object + properties: + reportInfo: + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/reportInfo' + reportItems: + type: array + items: + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/enhancedInvoiceReportItem' definitions: - companyDetails: - title: Company details + lendingCustomerRef: type: object properties: id: - $ref: '#/components/parameters/companyId/schema' - name: + minLength: 1 type: string - description: The name of the company - example: Codat Ltd. - description: - $ref: '#/components/schemas/CompanyRequestBody/properties/description' - nullable: true - redirect: + description: '`id` from the Customers data type.' + customerName: type: string - format: uri - description: 'The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company.' - example: 'https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739' - lastSync: - $ref: '#/components/schemas/DateTime' nullable: true - created: + description: '`customerName` from the Customer data type.' + payment: + title: Enhanced invoice payment item + type: object + properties: + id: + type: string + description: 'ID of the invoice, which may be a GUID but it may be something else depending on the accounting software.' + date: $ref: '#/components/schemas/DateTime' - createdByUserName: + paymentType: type: string - description: Name of user that created the company in Codat. - nullable: true - products: - type: array - items: - type: string - description: An array of products that are currently enabled for the company. - tags: - title: Tags - type: object - maxProperties: 10 - propertyNames: - pattern: '^.{1,27}$' - additionalProperties: - type: string - maxLength: 100 - description: A collection of user-defined key-value pairs that store custom metadata against the company. - referenceParentCompany: - $ref: '#/components/schemas/Company/definitions/companyReference' - nullable: true - description: The parent entity or controlling organization of this company. Null if the company has no parent. - referenceSubsidiaryCompanies: + description: The type of payment. + amount: + type: number + format: decimal + description: Payment amount. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + bankingTransactionRefs: type: array - nullable: false - description: A list of subsidiary companies owned or controlled by this entity. Empty if the company has no children. - minItems: 0 items: - $ref: '#/components/schemas/Company/definitions/companyReference' - required: - - id - - name - - redirect - companyReference: - title: Company reference + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/bankingTransactionRef' + bankingTransactionRef: + title: Banking transaction reference type: object properties: id: - $ref: '#/components/parameters/companyId/schema' - name: - $ref: '#/components/schemas/Company/definitions/companyDetails/properties/name' + type: string + description: Unique identifier for the bank transaction. + dataConnectionId: + type: string + description: Unique identifier of the bank transaction's connection. + accountId: + type: string + description: Unique identifier of the bank transaction's account. + accountName: + type: string + description: Name given to account. + date: + $ref: '#/components/schemas/DateTime' description: - $ref: '#/components/schemas/Company/definitions/companyDetails/properties/description' - links: - type: object - description: A collection of links for the company. + type: string + description: Description given to bank transaction. + amount: + type: number + description: Bank transaction amount. + format: decimal + invoiceStatus: + $ref: '#/components/schemas/AccountingInvoice/definitions/invoiceStatus' + enhancedInvoiceReportItem: + title: Enhanced invoice report item + type: object + allOf: + - type: object properties: - portal: + id: type: string - format: uri - description: Link to the company page in the portal. - tags: - $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' - examples: - - id: 0498e921-9b53-4396-a412-4f2f5983b0a2 - name: string - redirect: 'https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739' - lastSync: '2022-01-01T12:00:00.000Z' - created: '2022-01-01T12:00:00.000Z' - createdByUserName: string - tags: - region: us - uid: f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c - dataConnections: - - id: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd - integrationId: bf083d72-62c7-493e-aec9-81b4dbba7e2c - integrationKey: dfxm - sourceId: bdd831ce-eebd-4896-89a7-20e5ee8989ee - platformName: Basiq - linkUrl: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' - status: Linked - lastSync: '2022-10-27T10:22:43.6464237Z' - created: '2022-10-27T09:53:29Z' - sourceType: Banking - products: - - spend-insights - - lending - CompanyAccessToken: - title: Company access token - description: Details of the access token provisioned for a company. + description: 'ID of the invoice, which may be a GUID but it may be something else depending on the accounting software.' + invoiceNumber: + type: string + description: Invoice number. + customerRef: + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/lendingCustomerRef' + issueDate: + $ref: '#/components/schemas/DateTime' + dueDate: + $ref: '#/components/schemas/DateTime' + status: + $ref: '#/components/schemas/AccountingInvoice/definitions/invoiceStatus' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + totalAmount: + type: number + format: decimal + description: Invoice's total amount. + amountDue: + type: number + format: decimal + description: Invoice's total amount due. + payments: + type: array + items: + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/payment' + paidOnDate: + $ref: '#/components/schemas/DateTime' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + reportInfo: + title: Report information + type: object + description: 'Report additional information, which is specific to Lending reports.' + properties: + pageNumber: + type: integer + description: The number of the page queried. + pageSize: + type: integer + description: The number of transactions returned per page. + totalResults: + type: integer + description: The total number of transactions available for a company for the period specified in the query string. + reportName: + type: string + description: Name of the report. + companyName: + type: string + description: The name of the company being queried. + generatedDate: + type: string + description: Date the report was generated. + examples: + - Example 1: + value: + pageNumber: 0 + pageSize: 0 + totalResults: 0 + reportName: string + companyName: string + generatedDate: '2023-01-26T07:36:40.487Z' + ErrorMessage: + title: Error message type: object - allOf: - - $ref: '#/components/schemas/CompanyAccessToken/definitions/accessToken' + x-internal: true + properties: + statusCode: + type: integer + description: The HTTP status code returned by the error. + service: + type: string + description: Codat's service the returned the error. + error: + type: string + description: A brief description of the error. + correlationId: + type: string + description: Unique identifier used to propagate to all downstream services and determine the source of the error. + validation: + $ref: '#/components/schemas/ErrorMessage/definitions/errorValidation' + canBeRetried: + type: string + description: '`True` if the error occurred transiently and can be retried.' + detailedErrorCode: + type: integer + description: Machine readable error code used to automate processes based on the code returned. definitions: - accessToken: - title: Access token + errorValidation: + title: Validation error type: object + nullable: true + description: 'A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here.' properties: - expiresIn: - type: integer - description: The number of seconds until the access token expires. - example: 86400 - accessToken: + errors: + type: array + nullable: true + items: + $ref: '#/components/schemas/ErrorMessage/definitions/errorValidationItem' + warnings: + type: array + nullable: true + items: + $ref: '#/components/schemas/ErrorMessage/definitions/errorValidationItem' + errorValidationItem: + title: Validation error item + type: object + properties: + itemId: + type: string + nullable: true + description: Unique identifier for a validation item. + message: type: string - description: The access token for the company. - tokenType: + nullable: true + description: A message outlining validation item's issue. + validatorName: 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. + nullable: true + description: Name of validator. + ExcelStatus: type: object + title: Excel status properties: - companyName: - type: string - nullable: false - description: Name of the linked company. - baseCurrency: - type: string - nullable: false - description: Currency set in the accounting software of the linked company. - planType: + lastGenerated: + $ref: '#/components/schemas/DateTime' + description: The date and time of when the generation of the most recent report was initiated. + inProgress: + type: boolean + description: 'When true, the request was successful and the report is being generated. If false, the request was unsuccessful and the report is not being generated.' + queued: type: string - nullable: true - description: 'Accounting software subscription type such as Trial, Demo, Standard.' - multicurrencyEnabled: + description: The date and time of when a successful request was queued for the most recent report. + success: 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 - CompanyRequestBody: - title: Create company request - x-internal: true - type: object - properties: - name: + description: True if the requested report was successfully queued and false if the requested report was not able to be queued. + errorMessage: type: string - description: Name of company being connected. - pattern: '^[A-Za-z0-9\s\-'',&@.,?!\s]+$' - minLength: 1 - example: Bank of Dave - description: + description: Error details in case the report generation request was unsuccessful. + lastInvocationId: type: string - example: Requested early access to the new financing scheme. - description: 'Additional information about the company. This can be used to store foreign IDs, references, etc.' - tags: - $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' - required: - - name - CompanyUpdateRequest: - title: Update company request - x-internal: true - type: object - properties: - name: + description: A unique ID generated for this request. + reportType: + $ref: '#/components/schemas/ExcelStatus/definitions/excelReportTypes' + fileSize: + type: integer + nullable: true + description: The file size in Bytes is populated upon successful generation of the report. + definitions: + excelReportTypes: type: string - description: Name of company being connected. - pattern: '^[A-Za-z0-9\s\-'',&@.,?!\s]+$' - minLength: 1 - example: Bank of Dave - description: - $ref: '#/components/schemas/CompanyRequestBody/properties/description' - tags: - $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' - Connection: - title: Connection - description: "\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)." + enum: + - audit + - enhancedFinancials + - enhancedInvoices + - enhancedCashFlow + description: The type of the report requested in the query string. + examples: + - lastGenerated: '2023-01-25T22:36:05.125Z' + inProgress: true + queued: '2023-01-25T22:36:05.125Z' + success: true + errorMessage: string + lastInvocationId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + reportType: string + fileSize: 0 + File: + title: File type: object properties: - id: - $ref: '#/components/parameters/connectionId/schema' - integrationId: - type: string - format: uuid - example: fd321cb6-7963-4506-b873-e99593a45e30 - description: A Codat ID representing the integration. - integrationKey: + fileName: type: string - description: A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future. - sourceId: + nullable: true + description: The file's name. + displayName: type: string - format: uuid - example: 35b92968-9851-4095-ad60-395c95cbcba4 - description: 'A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`.' + nullable: true + description: An optional display name for the file. sourceType: - title: Source Type - description: The type of platform of the connection. - type: string - enum: - - Accounting - - Banking - - BankFeed - - Commerce - - Expense - - Other - - Unknown - example: Accounting - platformName: type: string - description: Name of integration connected to company. - linkUrl: - type: string - format: uri - description: The link URL your customers can use to authorize access to their business application. - example: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/2e2eb431-c1fa-4dc9-93fa-d29781c12bcd/start' - status: - $ref: '#/components/schemas/Connection/definitions/dataConnectionStatus' - lastSync: - $ref: '#/components/schemas/DateTime' nullable: true - created: + description: The source of the file uploaded. + uploaded: $ref: '#/components/schemas/DateTime' - dataConnectionErrors: - type: array - nullable: true - items: - $ref: '#/components/schemas/Connection/definitions/dataConnectionError' - connectionInfo: - type: object - nullable: true - additionalProperties: true additionalProperties: false + Files: + title: Files + type: array + items: + $ref: '#/components/schemas/File' + FileUpload: + title: Attachment upload + type: object + x-internal: true required: - - id - - integrationId - - integrationKey - - sourceId - - platformName - - linkUrl - - status - - created - - sourceType + - file + properties: + file: + $ref: '#/components/schemas/FileUpload/definitions/codatFile' definitions: - dataConnectionStatus: - title: Data connection status - description: The current authorization status of the data connection. + codatFile: type: string - enum: - - PendingAuth - - Linked - - Unlinked - - Deauthorized - dataConnectionError: - title: Data connection error + description: The file to be uploaded as an attachment. + format: binary + FinancialSummary: + title: Closed Books Indicator + type: object + properties: + booksClosedDate: type: object + description: The date time in UTC the books closed. properties: - statusCode: + date: type: string - description: The HTTP status code returned by the source platform when the error occurred. - statusText: + format: date-time + description: The date time in UTC the books closed. + example: '2025-05-31T00:00:00Z' + reason: + type: array + description: List of reasons explaining the books closed date. + items: + type: string + example: + - One or more accounts show a deviation from expected movements for March 2025 + - One of the marketing accounts haven't been booked for February 2025 + - One of the inventory accounts haven't been booked for March 2025 + accountingScore: + type: object + description: 'A score based on data completeness, accuracy, consistency, and presentation of data and the reasons for the score.' + properties: + score: + type: number + format: decimal + description: The accounting score value. + example: 90 + reason: + type: array + description: List of reasons explaining the accounting score. + items: + type: string + example: + - Balance sheet is unbalanced. + - Negative Tangible Assets on Balance Sheet + - Negative Accounts Receivable on Balance Sheet + LoanSummary: + title: Loan summary + type: object + properties: + reportInfo: + $ref: '#/components/schemas/LoanSummary/definitions/loanSummaryReportInfo' + reportItems: + type: array + description: Returns a summary of all loan activity for that integration type + items: + $ref: '#/components/schemas/LoanSummary/definitions/loanSummaryReportItem' + definitions: + loanSummaryReportInfo: + title: Loan Summary Report Info + type: object + properties: + reportName: type: string - description: A non-numeric status code/text returned by the source platform when the error occurred. - errorMessage: + description: The name of the report. + companyName: type: string - description: A message about a error returned by Codat. - erroredOnUtc: + description: Name of the company queried. + generatedDate: $ref: '#/components/schemas/DateTime' - status: - title: Error status - description: The current status of a transient error. Null statuses indicate that the error is not transient. + description: Returns the YYYY-MM-DD datetime of report generation. urns the YYYY-MM-DD datetime of report generation. + loanRef: + title: Loan Reference + type: object + properties: + id: type: string - nullable: true - enum: - - Active - - Resolved - resolvedOnUtc: - description: The datetime in Utc that the error was resolved. - nullable: true + description: The id of the object being referred to. + dataConnectionId: + type: string + description: The dataConnectionId the object being referred to is associated with. + x-stoplight: + id: vrnhmgrfndjhh + type: + type: string + description: 'The object type data is referring to, e.g. Account.' + loanSummaryRecordRef: + title: Item reference + type: object + properties: + id: + type: string + description: The id of the object being referred to. + dataConnectionId: + type: string + description: The dataConnectionId the object being referred to is associated with. + integrationType: + $ref: '#/components/schemas/LoanSummary/definitions/loanSummaryIntegrationType' + recordRefType: + $ref: '#/components/schemas/LoanSummary/definitions/loanSummaryRecordRefType' + loanSummaryReportItem: + type: object + properties: + recordRef: + $ref: '#/components/schemas/LoanSummary/definitions/loanSummaryRecordRef' + description: Contains object that contains a summary of all loan transactions for that integration type. + description: + type: string + description: The description of the object being referred to. E.g. the account. + startDate: $ref: '#/components/schemas/DateTime' - dataConnectionSourceType: - title: Source Type - description: The type of platform of the connection. + description: The date of the earliest loan transaction. + totalDrawdowns: + type: number + format: decimal + description: The total loan drawdowns. + totalRepayments: + type: number + format: decimal + description: The total loan repayments which includes capital plus any interest. + balance: + type: number + format: decimal + description: The loan outstanding balance. This may not equal totalDrawdowns - totalRepayments due to interest which has been accrued. + lender: + type: string + description: The name of lender providing the loan. + loanSummaryIntegrationType: + title: Integration type type: string enum: - Accounting - Banking - - BankFeed - Commerce - - Expense - - Other - - Unknown - example: Accounting - example: - id: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd - integrationId: bf083d72-62c7-493e-aec9-81b4dbba7e2c - integrationKey: dfxm - sourceId: bdd831ce-eebd-4896-89a7-20e5ee8989ee - platformName: Basiq - linkUrl: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' - status: Linked - lastSync: '2022-10-27T10:22:43.6464237Z' - created: '2022-10-27T09:53:29Z' - sourceType: Banking - Connections: - title: Connections - x-internal: true - allOf: - - type: object - properties: - results: - type: array - items: - $ref: '#/components/schemas/Connection' - - $ref: '#/components/schemas/Companies/allOf/1' - CreateBankTransactions: - title: Create bank transactions + description: The integration type begin referred to. + loanSummaryRecordRefType: + title: Record reference type + type: string + enum: + - accounts + - banking-accounts + - commerce-transactions + description: The datatype being referred to. + examples: + - reportInfo: + reportName: LoanSummaryReport + companyName: The Coffee shop + generatedDate: '2022-10-23T00:00:00Z' + reportItems: + - recordRef: + id: string + dataConnectionId: DE34E8E3-089F-4DF4-89E9-F7C43618FCAAA + integrationType: Accounting + recordRefType: accounts + description: string + startDate: '2021-01-01' + totalInvestments: 100000 + totalRepayments: 83481.72 + balance: 42513.18 + lender: Barclays Bank + LoanTransactions: + title: Loan transactions type: object properties: - accountId: - 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 + reportInfo: + $ref: '#/components/schemas/LoanTransactions/definitions/loanTransactionsReportInfo' + reportItems: + type: array + description: Contains object of reporting properties. The loan ref will reference a different object depending on the integration type. + items: + $ref: '#/components/schemas/LoanTransactions/definitions/reportItems' + definitions: + loanTransactionsReportInfo: + title: Loan Transactions Report Info + type: object + properties: + pageNumber: + type: integer + description: The page number. + pageSize: + type: integer + description: Queried page size. + totalResults: + type: integer + description: The total number of transactions returned. + reportName: + type: string + description: The name of the report. + companyName: + type: string + description: Name of the company queried. + generatedDate: + $ref: '#/components/schemas/DateTime' + description: Returns the YYYY-MM-DD datetime of report generation. + loanRef: + title: Loan Reference + type: object + properties: + id: + type: string + description: The id of the object being referred to. + dataConnectionId: + type: string + description: The dataConnectionId the object being referred to is associated with. + type: + type: string + description: 'The object type data is referring to, e.g. Account.' + itemRef: + title: Item reference + type: object properties: - data: - $ref: '#/components/schemas/CreateBankTransactions' - - $ref: '#/components/schemas/PushOperation' - 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 + id: + type: string + description: 'The id of the object, e.g. the Journal entry.' + dataConnectionId: + type: string + description: The data connection id being referenced. + type: + type: string + description: The data type the loan transaction entry was extracted from. + reportItems: + type: object + properties: + loanRef: + $ref: '#/components/schemas/LoanTransactions/definitions/loanRef' + description: Contains object that contains all the Loan transactions for that integration type. + itemRef: + $ref: '#/components/schemas/LoanTransactions/definitions/itemRef' + description: Contains object of reporting properties. The loan ref will reference a different object depending on the integration type. + date: + $ref: '#/components/schemas/DateTime' + description: The date of that entry type occurred. + amount: + type: number + format: decimal + description: The loan transaction amount. + loanTransactionType: + description: The type of loan transaction. + type: string + enum: + - Investment + - Repayment + - Interest + - AccuredInterest + lender: + type: string + description: The name of lender providing the loan. 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. - ErrorMessage: - title: Error message + - reportInfo: + pageNumber: 1 + pageSize: 1000 + totalResults: 1 + reportName: AccountingLoanTransactions + companyName: Supermarket store + generatedDate: '2022-10-23T00:00:00Z' + reportItems: + - loanRef: + id: '332' + dataConnectionId: ecd2d6be-5194-40a1-838f-5577a4881aaa + type: chartOfAccount + itemRef: + id: '755488' + dataConnectionId: ecd2d6be-5194-40a1-838f-5577a4881aaa + type: journalEntry + date: '2020-08-02' + amount: -455 + transactionType: Repayment + lender: Barclays Bank + Metadata: + title: Metadata type: object x-internal: true properties: - statusCode: + isDeleted: + type: boolean + description: Indicates whether the record has been deleted in the third-party system this record originated from. + nullable: true + PagingInfo: + type: object + title: Pagination information + x-internal: true + properties: + pageNumber: type: integer - description: The HTTP status code returned by the error. - service: - type: string - description: Codat's service the returned the error. - error: - type: string - description: A brief description of the error. - correlationId: - type: string - description: Unique identifier used to propagate to all downstream services and determine the source of the error. - validation: - $ref: '#/components/schemas/ErrorMessage/definitions/errorValidation' - canBeRetried: - type: string - description: '`True` if the error occurred transiently and can be retried.' - detailedErrorCode: + description: Current page number. + pageSize: type: integer - description: Machine readable error code used to automate processes based on the code returned. + 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: - errorValidation: - title: Validation error + links: + title: Hal Links type: object - nullable: true - description: 'A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here.' + required: + - self + - current properties: - errors: - type: array - nullable: true - items: - $ref: '#/components/schemas/ErrorMessage/definitions/errorValidationItem' - warnings: - type: array - nullable: true - items: - $ref: '#/components/schemas/ErrorMessage/definitions/errorValidationItem' - errorValidationItem: - title: Validation error item + 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: - 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: + href: type: string - nullable: true - description: Name of validator. - GenerateOtpResponse: - title: OTP response + 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' + PaymentMethodRef: type: object - description: Response containing a one-time password and its expiry time. - additionalProperties: false + title: Payment method reference + description: The payment method the record is linked to in the accounting or commerce software. properties: - otp: + id: + description: The unique identifier of the location being referenced. + type: string + name: + description: Name of the location being referenced. type: string - description: The one-time password. - expiry: - $ref: '#/components/schemas/DateTime' - description: The expiry date and time of the OTP in UTC. required: - - otp - - expiry - examples: - - otp: GT40U4 - expiry: '2026-04-08T10:30:00Z' + - id + example: + id: EILBDVJVNUAGVKRQ + name: AliPay + PhoneNumber: + title: Phone + type: object + x-internal: true + properties: + number: + type: string + nullable: true + examples: + - +44 25691 154789 + - (877) 492-8687 + - 01224 658 999 + description: A phone number. + type: + description: The type of phone number + type: string + enum: + - Primary + - Landline + - Mobile + - Fax + - Unknown + required: + - type + ProjectRef: + title: 'Accounting: Project reference' + x-internal: true + required: + - id + type: object + properties: + id: + minLength: 1 + type: string + description: Unique identifier to the project reference. + name: + type: string + nullable: true + description: The project's name. PullOperation: title: Pull operation description: |- @@ -4417,7 +84518,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 @@ -4430,7 +84531,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' @@ -4527,7 +84628,7 @@ components: type: string description: Unique identifier for a push operation. dataType: - $ref: '#/components/schemas/DataType' + $ref: '#/components/schemas/DataStatus/properties/dataType' nullable: true additionalProperties: false pushOperationStatus: @@ -4560,7 +84661,7 @@ components: type: array items: $ref: '#/components/schemas/PushOperation' - - $ref: '#/components/schemas/Companies/allOf/1' + - $ref: '#/components/schemas/PagingInfo' PushOption: title: Push option x-internal: true @@ -4688,6 +84789,78 @@ components: $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/description' required: $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/required' + ReportLine: + x-internal: true + type: object + title: 'Accounting: Report line' + properties: + accountId: + type: string + nullable: true + description: 'Identifier for the account, unique for the company in the accounting software.' + name: + type: string + nullable: true + description: Name of the report line item. + value: + type: number + format: decimal + description: Numerical value of the line item. + items: + type: array + nullable: true + description: An array of ReportLine items. + items: + $ref: '#/components/schemas/ReportLine' + required: + - value + ReportOperation: + title: Report + type: object + properties: + id: + type: string + format: uuid + description: Unique identifier of the report + example: 52c0f26b-051a-43ff-b02a-258eec67f5ef + status: + type: string + enum: + - InProgress + - Complete + - Error + description: The status of the report generation. + type: + type: string + enum: + - categorizedBankStatement + - creditModel + - spendAnalysis + description: The name of the generated report. + requestedDate: + description: The date and time on which the report was requested. + $ref: '#/components/schemas/DateTime' + updatedDate: + description: The date and time on which the report was last updated. + $ref: '#/components/schemas/DateTime' + errorMessage: + type: string + nullable: true + description: A short message describing any errors that occurred while generating the report. + description: Information about report generation. + definitions: + reports: + title: Reports + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/ReportOperation' + minLength: 0 + maxLength: 2000 + - $ref: '#/components/schemas/PagingInfo' SourceAccount: title: Source account (v1) type: object @@ -4801,56 +84974,6 @@ components: 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 - 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: - type: string - description: Unique ID for the source account. - examples: - - '12345' - result: - 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: string - examples: - - A bank account already exists with the same Id SourceAccountV2: title: Source account (v2) type: object @@ -5042,187 +85165,56 @@ components: 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: - 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: - 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 - 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 + StartUploadSessionRequest: + title: Upload session start request type: object - description: Represents the result of an ad-hoc sync request. properties: - syncId: + dataType: type: string - format: uuid - description: The unique identifier for the created sync. - required: - - syncId - SyncStatusResult: - title: Sync status + enum: + - banking-accounts + - banking-transactions + description: A key for a Codat data type. + SupplementalData: + title: Supplemental data 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 + x-internal: true + description: |- + Supplemental data is additional data you can include in our standard data types. + + It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. + properties: + content: + type: object + additionalProperties: + type: object + additionalProperties: true nullable: true - description: 'The UTC timestamp when the sync execution ended, if completed (i.e. `status` is any value other than `Started`).' - errorMessage: + ThirdPartySchema: + title: Third-party schema + description: The format should be identical to the file format receieved from the third-party banking source (e.g. Plaid or TrueLayer). + type: object + x-speakeasy-type-override: any + WebLink: + title: Weblink + description: Weblink associated with the company. + type: object + properties: + type: + description: The type of the weblink. type: string - nullable: true - description: Error message if the sync failed. - errorCode: + enum: + - Website + - Social + - Unknown + url: + description: The full URL for the weblink. 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 + format: url + example: + type: Website + url: 'https://codat.io' parameters: - companyId: - name: companyId - in: path - required: true - schema: - type: string - format: uuid - example: 8a210b68-6988-11ed-a1eb-0242ac120002 - description: Unique identifier for your SMB in Codat. - description: Unique identifier for a company. - connectionId: - name: connectionId - in: path - required: true - schema: - type: string - format: uuid - example: 2e9d2c44-f675-40ba-8049-353bfcb5e171 - description: Unique identifier for a company's data connection. - description: Unique identifier for a connection. - 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. page: name: page in: query @@ -5260,9 +85252,29 @@ components: type: string example: '-modifiedDate' description: 'Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).' + companyId: + name: companyId + in: path + required: true + schema: + type: string + format: uuid + example: 8a210b68-6988-11ed-a1eb-0242ac120002 + description: Unique identifier for your SMB in Codat. + description: Unique identifier for a company. + connectionId: + name: connectionId + in: path + required: true + schema: + type: string + format: uuid + example: 2e9d2c44-f675-40ba-8049-353bfcb5e171 + description: Unique identifier for a company's data connection. + description: Unique identifier for a connection. dataType: name: dataType - description: The key of a Codat data type + description: A key for a Codat data type. in: path required: true schema: @@ -5276,6 +85288,233 @@ components: format: uuid description: Unique identifier for the dataset that completed its sync. description: Unique identifier for the dataset that completed its sync. + dataIntegrityDataType: + name: dataType + in: path + required: true + schema: + type: string + enum: + - banking-accounts + - banking-transactions + - bankAccounts + - accountTransactions + example: banking-accounts + description: A key for a Codat data type. + reportDate: + name: reportDate + in: query + schema: + type: string + example: 29-09-2020 + description: 'The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.' + reportDateRequired: + name: reportDate + in: query + required: true + schema: + type: string + example: 29-09-2020 + description: 'The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.' + periodLength: + name: periodLength + in: query + required: true + schema: + type: integer + description: The number of months per period. E.g. 2 = 2 months per period. + numberOfPeriods: + name: numberOfPeriods + in: query + required: false + schema: + type: integer + description: 'The number of periods to return. If not provided, 12 periods will be used as the default value.' + numberOfPeriodsRequired: + name: numberOfPeriods + in: query + required: true + schema: + type: integer + description: The number of periods to return. There will be no pagination as a query parameter. + periodUnit: + name: periodUnit + in: query + required: true + schema: + type: string + enum: + - Day + - Week + - Month + - Year + description: The period unit of time returned. + includeDisplayNames: + name: includeDisplayNames + in: query + schema: + type: boolean + description: Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable. + excelReportType: + name: reportType + in: query + schema: + $ref: '#/components/schemas/ExcelStatus/definitions/excelReportTypes' + description: The type of report you want to generate and download. + required: true + accountingAccountId: + name: accountId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for an account. + accountingBillPaymentId: + name: billPaymentId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a bill payment. + accountingBillId: + name: billId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a bill. + attachmentId: + name: attachmentId + in: path + required: true + schema: + type: string + format: uuid + example: 8a210b68-6988-11ed-a1eb-0242ac120002 + description: Unique identifier for an attachment. + accountingDirectCostId: + name: directCostId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a direct cost. + accountingDirectIncomeId: + name: directIncomeId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a direct income. + accountingInvoiceId: + name: invoiceId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for an invoice. + accountingSupplierId: + name: supplierId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a supplier. + accountingReportDate: + name: reportDate + in: query + schema: + type: string + format: date + example: '2022-12-31' + description: Date the report is generated up to. + accountingNumberOfPeriods: + name: numberOfPeriods + in: query + schema: + type: integer + format: int32 + example: 12 + description: Number of periods to include in the report. + accountingPeriodLengthDays: + name: periodLengthDays + in: query + schema: + type: integer + format: int32 + example: 30 + description: The length of period in days. + accountingPeriodLength: + name: periodLength + description: Number of months defining the period of interest. + in: query + required: true + schema: + type: integer + format: int32 + example: 4 + accountingPeriodsToCompare: + name: periodsToCompare + description: Number of periods with `periodLength` to compare. + in: query + required: true + schema: + type: integer + format: int32 + example: 20 + accountingStartMonth: + name: startMonth + in: query + schema: + $ref: '#/components/schemas/DateTime' + description: The month the report starts from. + customerId: + name: customerId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a customer. timeoutInMinutes: name: timeoutInMinutes in: query @@ -5283,6 +85522,93 @@ components: type: integer format: int32 description: Time limit for the push operation to complete before it is timed out. + allowSyncOnPushComplete: + name: allowSyncOnPushComplete + in: query + schema: + type: boolean + default: true + description: Allow a sync upon push completion. + forceUpdate: + name: forceUpdate + in: query + schema: + type: boolean + default: false + description: 'When updating data in the destination platform Codat checks the `sourceModifiedDate` against the `lastupdated` date from the accounting software, if they''re different Codat will return an error suggesting you should initiate another pull of the data. If this is set to `true` then the update will override this check.' + pushOperationKey: + name: pushOperationKey + schema: + type: string + format: uuid + in: path + required: true + description: Unique identifier for the push operation. + paymentId: + name: paymentId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a payment. + productId: + name: productId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a product. + path: + name: path + description: The endpoint path of the third-party banking service that the request body originates from. Only required if the source is not `codat`. + in: query + required: false + schema: + type: string + enum: + - auth/get + reportType: + name: reportType + description: The type of the report + in: path + required: true + schema: + type: string + enum: + - categorizedBankStatement + - creditModel + reportId: + name: reportId + description: 'Unique identifier for a report, use either the Id of the report or `latest` for the most recently generate report.' + in: path + required: true + schema: + oneOf: + - type: string + title: ID + format: uuid + example: 8a210b68-6988-11ed-a1eb-0242ac120002 + - type: string + title: Latest + enum: + - latest + maxAge: + description: The maximum age of report to fetch. + name: maxAge + in: query + required: false + schema: + $ref: '#/components/schemas/DateTime' responses: BadRequest: description: The request made is not valid. @@ -5472,3 +85798,270 @@ components: type: apiKey in: header x-speakeasy-example: Basic BASE_64_ENCODED(API_KEY) + examples: + CodatBankStatementUploadConfiguration: + value: + source: codat + accountId: abc123-ABC + summary: Settings for uploading codat data + EnhancedCashflowExample: + value: + reportInfo: + pageNumber: 1 + pageSize: 10 + totalResults: 2194 + reportName: Cash flow transactions report + companyName: test + generatedDate: '2023-03-24T16:44:17.5302732Z' + dataSources: + - accounts: + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Savings Account + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Banking - Business Credit Card + accountType: Credit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Undeposited Funds + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Current Account + accountType: Debit + currency: GBP + currentBalance: 0 + reportItems: + - transactions: + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: ab5e07a0-5578-4d91-8421-2dc72713b74f + date: '2022-11-08T00:00:00' + description: Payment m86SDGpQr3 + amount: -6905.44 + currency: GBP + transactionCategory: + confidence: 52.53 + levels: + - Expense + - Operating + confidences: + - 56 + - 52.53 + platformName: Shopify + counterpartyNames: + - Shopify + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: 9846bbed-46d3-472c-a848-1ce8ebea7213 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 4332.84 + currency: GBP + transactionCategory: + confidence: 88 + levels: + - Expense + confidences: + - 88 + platformName: Amazon + counterpartyNames: + - Amazon + - Amazon Marketplace + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 94b213fb-d742-435e-90f1-bfe723a076d5 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 4034.3 + currency: GBP + transactionCategory: + confidence: 61.08 + levels: + - Income + - Revenue + confidences: + - 65 + - 61.08 + platformName: Shopify + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: cfceb7ff-eaa2-45b6-aca7-fa0e0b439161 + date: '2022-11-08T00:00:00' + description: Payment to supplier 78792d13-90a0-4ea2-8e07-81c3c893997e + amount: -313.76 + currency: GBP + transactionCategory: + confidence: 40.98 + levels: + - Expense + - CostOfSales + confidences: + - 40.98 + - 99.9 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: ba814f14-0fe3-41d0-9308-57f40642ac75 + date: '2022-11-08T00:00:00' + description: Payment to supplier 46d2e1fb-b4e9-469c-814a-21ff8105a26e + amount: -614.4 + currency: GBP + transactionCategory: + confidence: 55.84 + levels: + - Income + - Revenue + confidences: + - 55.84 + - 75.5 + platformName: Zettle + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: e67cc30e-fd5c-4eea-8365-ec40dfdd3ef6 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 5199.62 + currency: GBP + transactionCategory: + confidence: 57.85 + levels: + - Expense + confidences: + - 57.85 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: e0f08a0b-3575-4dde-98c4-3c854028d2d2 + date: '2022-11-08T00:00:00' + description: Payment to supplier 18ac18dc-945b-4083-9013-e8a100b999fa + amount: -21420.94 + currency: GBP + transactionCategory: + confidence: 70.58 + levels: + - Expense + - Operating + confidences: + - 70.58 + - 100 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 4b70d379-8284-4f44-bb37-c7935df950cc + date: '2022-11-08T00:00:00' + description: Payment to supplier 630a3f16-5f01-4986-ae6b-82333ec49449 + amount: -30924.22 + currency: GBP + transactionCategory: + confidence: 48.26 + levels: + - Income + confidences: + - 48.26 + platformName: DoorDash + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 76b73373-9345-472e-8edf-5be849d797fe + date: '2022-11-08T00:00:00' + description: Payment to supplier bQATU4eSb9 + amount: -568.78 + currency: GBP + transactionCategory: + confidence: 65.21 + levels: + - Income + - Revenue + confidences: + - 65.21 + - 100 + platformName: Uber + counterpartyNames: + - Uber + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: ee92fd6f-e0f7-4391-85fd-4b50921b973f + date: '2022-11-08T00:00:00' + description: Payment to supplier 9c37eb21-579a-4886-8296-3a853076b7bd + amount: -13050.79 + currency: GBP + transactionCategory: + confidence: 92.33 + levels: + - Income + - Revenue + confidences: + - 92.33 + - 92.33 + platformName: DoorDash + counterpartyNames: + - DoorDash + modifiedDate: '2022-11-08T12:00:00' + SingleReportExample: + value: + id: 6e9bae88-72c9-45ae-abe8-41fbf2871458 + status: InProgress + type: categorizedBankStatement + requestedDate: '2024-09-27T04:43:41Z' + updatedDate: '2024-10-01T14:41:46Z' diff --git a/.speakeasy/logs/changes/old.openapi.yaml b/.speakeasy/logs/changes/old.openapi.yaml index 0b8397da..e2df8327 100644 --- a/.speakeasy/logs/changes/old.openapi.yaml +++ b/.speakeasy/logs/changes/old.openapi.yaml @@ -3,19 +3,14 @@ servers: - description: Production url: 'https://api.codat.io' info: - title: Bank Feeds - version: 3.0.0 - contact: - email: support@codat.io - name: Codat + title: Lending description: |- - Bank Feeds solution enables your SMB users to set up bank feeds from accounts in your application to supported accounting software. + Our Lending solution helps you make smarter credit decisions on small businesses by enabling you to pull your customers' latest data from accounting, banking, and commerce software they are already using. It also includes features to help providers verify the accuracy of data and process it more efficiently. - 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 Lending solution is built on top of the latest accounting, commerce, and banking data, providing you with the most important data points you need to get a full picture of SMB creditworthiness and make a comprehensive assessment of your customers. - [Explore solution](https://docs.codat.io/bank-feeds-api/overview) | [See OpenAPI spec](https://github.com/codatio/oas) + [Explore solution](https://docs.codat.io/lending/overview) | [See OpenAPI spec](https://github.com/codatio/oas) - --- ## Endpoints @@ -23,11 +18,24 @@ 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. | + | Bank statements | Retrieve banking data from linked bank accounts. | + | Sales | Retrieve standardized sales data from a linked commerce software. | + | Financial statements | Financial data and reports from a linked accounting software. | + | Liabilities | Debt and other liabilities. | + | Accounts payable | Data from a linked accounting software representing money the business owes money to its suppliers. | + | Accounts receivable | Data from a linked accounting software representing money owed to the business for sold goods or services. | + | Transactions | Data from a linked accounting software representing transactions. | + | Company info | View company information fetched from the source platform. | + | Data integrity | Match mutable accounting data with immutable banking data to increase confidence in financial data. | + | Excel reports | Download reports in Excel format. | + | Manage data | Control how data is retrieved from an integration. | + | File upload | Endpoints to manage uploaded files. | + | Loan writeback | Implement the [loan writeback](https://docs.codat.io/lending/guides/loan-writeback/introduction) procedure in your lending process to maintain an accurate position of a loan during the entire lending cycle. | + version: 3.0.0 + contact: + name: Codat + email: support@codat.io termsOfService: 'https://www.codat.io/legals/' security: - auth_header: [] @@ -68,7 +76,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: lending-api x-codat-keep-docs-paths-local: true x-codat-speakeasy-pagination: type: offsetLimit @@ -83,103 +91,40 @@ 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: Bank statements + description: Retrieve banking data from linked bank accounts. + - name: Sales + description: Retrieve standardized sales data from a linked commerce software. + - name: Financial statements + description: Financial data and reports from a linked accounting software. + - name: Liabilities + description: Debt and other liabilities. + - name: Accounts payable + description: Data from a linked accounting software representing money the business owes money to its suppliers. + - name: Accounts receivable + description: Data from a linked accounting software representing money owed to the business for sold goods or services. + - name: Accounting bank data + description: Access bank transactions from an accounting software. - 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: Data from a linked accounting software representing transactions. + - name: Company info + description: View company information fetched from the source platform. + - name: Data integrity + description: Match mutable accounting data with immutable banking data to increase confidence in financial data. + - name: Excel reports + description: Download reports in Excel format. + - name: Manage data + description: Control how data is retrieved from an integration. + - name: File upload + description: Endpoints to manage uploaded files. + - name: Loan writeback + description: 'Implement the [loan writeback](https://docs.codat.io/lending/guides/loan-writeback/introduction) procedure in your lending process to maintain an accurate position of a loan during the entire lending cycle.' + - name: Manage reports + description: Generate and review generated reports for a company. + - name: Financial summary + description: 'View financial summary information for a company, including credit model reports and accounting score.' 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 +292,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\x6C\x65\x6E\x64\x69\x6E\x67\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\x6C\x65\x6E\x64\x69\x6E\x67\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\x6C\x65\x6E\x64\x69\x6E\x67\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 +304,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\x6C\x65\x6E\x64\x69\x6E\x67\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\x6C\x65\x6E\x64\x69\x6E\x67\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\x6C\x65\x6E\x64\x69\x6E\x67\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\x6C\x65\x6E\x64\x69\x6E\x67\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\x6C\x65\x6E\x64\x69\x6E\x67\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 +433,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\x6C\x65\x6E\x64\x69\x6E\x67\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 +473,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\x6C\x65\x6E\x64\x69\x6E\x67\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\x6C\x65\x6E\x64\x69\x6E\x67\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\x6C\x65\x6E\x64\x69\x6E\x67\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\x6C\x65\x6E\x64\x69\x6E\x67\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 +498,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\x6C\x65\x6E\x64\x69\x6E\x67\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\x6C\x65\x6E\x64\x69\x6E\x67\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 +835,71259 @@ paths: value: status: Unlinked description: '' - '/companies/{companyId}/connections/{connectionId}/data/bankAccounts': + '/companies/{companyId}/data/all': + parameters: + - $ref: '#/components/parameters/companyId' + post: + summary: Refresh all data + operationId: refresh-all-data-types + x-speakeasy-group: manage-data.refresh + x-speakeasy-name-override: all-data-types + responses: + '204': + description: No Content + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + Refreshes all data types with `fetch on first link` set to `true` for a given company. + + This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. + + [Read more](https://docs.codat.io/core-concepts/data-type-settings) about data type settings and `fetch on first link`. + tags: + - Manage data + '/companies/{companyId}/dataStatus': parameters: - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' get: - x-internal: true + summary: Get data status + operationId: get-data-status + x-speakeasy-group: manage-data + x-speakeasy-name-override: get-status + description: Get the state of each data type for a company tags: - - Bank accounts - summary: List bank accounts - operationId: list-bank-accounts + - Manage data + responses: + '200': + description: OK + content: + application/json: + schema: + title: Data statuses + x-internal: true + type: object + properties: + accountTransactions: + $ref: '#/components/schemas/DataStatus' + nullable: true + balanceSheet: + $ref: '#/components/schemas/DataStatus' + nullable: true + bankAccounts: + $ref: '#/components/schemas/DataStatus' + nullable: true + bankTransactions: + $ref: '#/components/schemas/DataStatus' + nullable: true + billCreditNotes: + $ref: '#/components/schemas/DataStatus' + nullable: true + billPayments: + $ref: '#/components/schemas/DataStatus' + nullable: true + bills: + $ref: '#/components/schemas/DataStatus' + nullable: true + cashFlowStatement: + $ref: '#/components/schemas/DataStatus' + nullable: true + chartOfAccounts: + $ref: '#/components/schemas/DataStatus' + nullable: true + company: + $ref: '#/components/schemas/DataStatus' + nullable: true + creditNotes: + $ref: '#/components/schemas/DataStatus' + nullable: true + customers: + $ref: '#/components/schemas/DataStatus' + nullable: true + directCosts: + $ref: '#/components/schemas/DataStatus' + nullable: true + directIncomes: + $ref: '#/components/schemas/DataStatus' + nullable: true + invoices: + $ref: '#/components/schemas/DataStatus' + nullable: true + itemReceipts: + $ref: '#/components/schemas/DataStatus' + nullable: true + items: + $ref: '#/components/schemas/DataStatus' + nullable: true + journalEntries: + $ref: '#/components/schemas/DataStatus' + nullable: true + journals: + $ref: '#/components/schemas/DataStatus' + nullable: true + paymentMethods: + $ref: '#/components/schemas/DataStatus' + nullable: true + payments: + $ref: '#/components/schemas/DataStatus' + nullable: true + profitAndLoss: + $ref: '#/components/schemas/DataStatus' + nullable: true + purchaseOrders: + $ref: '#/components/schemas/DataStatus' + nullable: true + salesOrders: + $ref: '#/components/schemas/DataStatus' + nullable: true + suppliers: + $ref: '#/components/schemas/DataStatus' + nullable: true + taxRates: + $ref: '#/components/schemas/DataStatus' + nullable: true + trackingCategories: + $ref: '#/components/schemas/DataStatus' + nullable: true + transfers: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-accountBalances: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-accounts: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-transactionCategories: + $ref: '#/components/schemas/DataStatus' + nullable: true + banking-transactions: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-companyInfo: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-customers: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-disputes: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-locations: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-orders: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-paymentMethods: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-payments: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-productCategories: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-products: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-taxComponents: + $ref: '#/components/schemas/DataStatus' + nullable: true + commerce-transactions: + $ref: '#/components/schemas/DataStatus' + nullable: true + examples: + Example: + value: + accountTransactions: + dataType: accountTransactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + balanceSheet: + dataType: balanceSheet + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + bankAccounts: + dataType: bankAccounts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + bankTransactions: + dataType: bankTransactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + billCreditNotes: + dataType: billCreditNotes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + billPayments: + dataType: billPayments + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + bills: + dataType: bills + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + cashFlowStatement: + dataType: cashFlowStatement + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + chartOfAccounts: + dataType: chartOfAccounts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + company: + dataType: company + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + creditNotes: + dataType: creditNotes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + customers: + dataType: customers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + directCosts: + dataType: directCosts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + directIncomes: + dataType: directIncomes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + invoices: + dataType: invoices + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + itemReceipts: + dataType: itemReceipts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + items: + dataType: items + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + journalEntries: + dataType: journalEntries + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + journals: + dataType: journals + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + paymentMethods: + dataType: paymentMethods + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + payments: + dataType: payments + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + profitAndLoss: + dataType: profitAndLoss + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + purchaseOrders: + dataType: purchaseOrders + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + salesOrders: + dataType: salesOrders + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + suppliers: + dataType: suppliers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + taxRates: + dataType: taxRates + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + trackingCategories: + dataType: trackingCategories + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + transfers: + dataType: transfers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-accountBalances: + dataType: banking-accountBalances + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-accounts: + dataType: banking-accounts + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-transactionCategories: + dataType: banking-transactionCategories + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + banking-transactions: + dataType: banking-transactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-companyInfo: + dataType: commerce-companyInfo + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-customers: + dataType: commerce-customers + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-disputes: + dataType: commerce-disputes + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-locations: + dataType: commerce-locations + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-orders: + dataType: commerce-orders + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-paymentMethods: + dataType: commerce-paymentMethods + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-payments: + dataType: commerce-payments + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-productCategories: + dataType: commerce-productCategories + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-products: + dataType: commerce-products + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-taxComponents: + dataType: commerce-taxComponents + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + commerce-transactions: + dataType: commerce-transactions + lastSuccessfulSync: '2022-01-01T00:00:00.000Z' + currentStatus: Complete + latestSyncId: d03b6979-eb3b-447a-a27a-13cf457a9f48 + latestSuccessfulSyncId: 6883bba8-514d-423f-ba7f-c38285a80b7f + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/queue/{dataType}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/dataType' + post: + summary: Refresh data type + operationId: refresh-data-type + x-speakeasy-group: manage-data.refresh + x-speakeasy-name-override: data-type + description: |- + Refreshes a given data type for a given company. + + This is an asynchronous operation, and will bring updated data into Codat from the linked integration for you to view. + tags: + - Manage data parameters: - - $ref: '#/components/parameters/page' - - $ref: '#/components/parameters/pageSize' - - $ref: '#/components/parameters/query' - - $ref: '#/components/parameters/orderBy' + - schema: + type: string + format: uuid + in: query + name: connectionId + description: 'Optionally, provide a data connection id to only queue pull operations on that connection.' responses: '200': - description: Success + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PullOperation' + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/history': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: List pull operations + tags: + - Manage data + operationId: list-pull-operations + x-speakeasy-group: manage-data.pull-operations + responses: + '200': + description: OK content: application/json: schema: - $ref: '#/components/schemas/BankAccounts' + $ref: '#/components/schemas/PullOperations' examples: - Dynamics 365 Business Central: + Example: 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 + - id: 97d60846-f07a-4d42-b5a0-0bdcc6ebf56b + companyId: 4645bd78-8988-45bc-ac9e-67ba5df6e4e5 + connectionId: 51baa045-4836-4317-a42e-3542e991e581 + dataType: invoices + status: Initial + requested: '2022-11-14T11:18:37.2798351Z' + progress: 10 + isCompleted: false + isErrored: false _links: current: - href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts?page=1&pageSize=2 + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=1&pageSize=2 self: - href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history next: - href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts?page=2&pageSize=2 + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/data/history?page=2&pageSize=2 + pageNumber: 0 + pageSize: 0 + totalResults: 0 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: Gets the pull operation history (datasets) for a given company. + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + '/companies/{companyId}/data/history/{datasetId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/datasetId' + get: + summary: Get pull operation + operationId: get-pull-operation + x-speakeasy-group: manage-data.pull-operations + tags: + - Manage data + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PullOperation' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: Retrieve information about a single dataset or pull operation. + '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/status': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/dataIntegrityDataType' + get: + summary: Get data integrity status + tags: + - Data integrity + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/DataIntegrityStatuses' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-data-integrity-status + x-speakeasy-name-override: status + description: |- + The *Get data integrity status* endpoint returns the [status](https://docs.codat.io/lending-api#/schemas/DataIntegrityStatus) for the company’s match results between the data type provided in the URL and other data types that Data Integrity uses to support matching. + This endpoint helps you understand whether match data is available and, if so, how to usefully query it. + + The response tells you: + + - Whether match results are available. + - When the results were generated, and their status. + - The connection IDs, amounts, and dates involved to support useful querying. + '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/summaries': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/dataIntegrityDataType' + get: + summary: Get data integrity summaries + tags: + - Data integrity + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/DataIntegritySummaries' + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-data-integrity-summaries + x-speakeasy-name-override: summaries + description: "The *Get data integrity summary* endpoint returns a [summary](https://docs.codat.io/lending-api#/schemas/DataIntegritySummary) of match results for a given data type filtered by a query string in the [Codat query language](https://docs.codat.io/using-the-api/querying). \n\nFor example, if you wanted to see summary match results only for transactions after 1 December 2020, you could include a query parameter of `query=date>2020-12-01`.\n\nThe endpoint response includes only the summary results, not transactions. To view match data for transactions, use the [List data integrity details](https://docs.codat.io/lending-api#/operations/get-data-integrity-summaries) endpoint." + parameters: + - $ref: '#/components/parameters/query' + '/data/companies/{companyId}/assess/dataTypes/{dataType}/dataIntegrity/details': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/dataIntegrityDataType' + get: + summary: List data integrity details + tags: + - Data integrity + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/DataIntegrityDetails' + 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' + operationId: list-data-integrity-details + x-speakeasy-name-override: details + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + description: |- + The *List data integrity details* endpoint returns the match result record by record for a given data type, filtered based on a query string in the same way as summary results. + + The [details](https://docs.codat.io/lending-api#/schemas/DataIntegrityDetail) are paginated and support ordering, following the same conventions as our other data endpoints. + '/companies/{companyId}/reports/enhancedProfitAndLoss/accounts': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: Get categorized profit and loss statement + description: |- + The *Get categorized profit and loss statement* endpoint returns a list of categorized accounts that appear on a company’s Profit and Loss statement. It also includes a balance as of the financial statement date. + + Codat suggests a category for each account automatically, but you can [change it](https://docs.codat.io/lending/features/financial-statements-overview#recategorizing-accounts) to a more suitable one. + tags: + - Financial statements + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/EnhancedFinancialReport' + example: + reportInfo: + currency: GBP + reportName: EnhancedProfitAndLossAccounts + companyName: Biscuits + generatedDate: '2023-03-24T16:40:59.0847354Z' + reportItems: + - date: '2022-08-31T00:00:00' + balance: 830.93 + accountId: 04f7111b-55d4-4efc-b329-1bd5c791933a + accountName: Repairs & Maintenance + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 12000 + accountId: 7f6a0e92-65be-4333-9a0a-d981b03bedd1 + accountName: Wages + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: CostOfSales + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 28937.71 + accountId: 7403e960-5b72-42ff-abf4-c870ad8910bd + accountName: Purchases + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: CostOfSales + confidence: 99.99 + - levelName: Inventory + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 582.4 + accountId: e8a0a24e-2dab-46b1-bfe1-6e92551c04e8 + accountName: Purchase Discounts + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: CostOfSales + confidence: 99.99 + - levelName: Inventory + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 350.44 + accountId: cbf82e0d-87a7-464d-b567-9274ea94a1c0 + accountName: Charitable and Political Donations + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: NonOperating + confidence: 99.99 + - levelName: Donations + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 535.81 + accountId: 78785fd7-f197-4c34-aa17-6e76b9255d34 + accountName: Interest Paid (operating) + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: NonOperating + confidence: 99.99 + - levelName: Interest + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 633.05 + accountId: fb3210ef-edeb-48af-bb49-b85d40c1e6bb + accountName: Corporation Tax + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: NonOperating + confidence: 99.99 + - levelName: Taxes + confidence: 99.99 + - levelName: CorporationTaxes + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 782.61 + accountId: f3aa84fe-5c31-4107-b207-7e0419f636d7 + accountName: Bank Fees + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: BankCharges + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 8000 + accountId: 9cbe5fe4-ca60-4792-8bf1-de01fb7010aa + accountName: Rent + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Leases + confidence: 99.99 + - levelName: BuildingRentLease + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1090.68 + accountId: 138a8eb3-5c08-4e59-a3bc-892119694447 + accountName: Motor Vehicle Expenses + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Leases + confidence: 99.99 + - levelName: EquipmentRentLease + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 26307.02 + accountId: 868591ad-f9c2-4956-a5ec-c32c1d48c6f3 + accountName: Advertising & Marketing + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Marketing + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1128.85 + accountId: 1734ff00-2a17-45b4-8db6-2dc2e832c460 + accountName: 'Postage, Freight & Courier' + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Marketing + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 40 + accountId: 7d8d0322-f452-47de-a8e8-54b0130e6f38 + accountName: Subscriptions + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Marketing + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 5.72 + accountId: 4378ddba-36b4-4b35-9970-bd972b20d137 + accountName: Amortization + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: NonCash + confidence: 99.99 + - levelName: Amortization + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1539.18 + accountId: 940c8a59-3348-4a0b-a1b1-781d9f29cc8b + accountName: Depreciation Expense + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: NonCash + confidence: 99.99 + - levelName: Depreciation + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1416.05 + accountId: e7ac3baa-cfbe-40c1-a172-83d22e84435b + accountName: Entertainment-100% business + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Personnel + confidence: 99.99 + - levelName: EmployeeBenefits + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1465.61 + accountId: b5e801e8-8dbc-4390-ac99-3b0fff54a89f + accountName: General Expenses + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 7347.35 + accountId: 5360066d-1474-49f6-a7a5-c66d5f6032ba + accountName: 'Light, Power, Heating' + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1027.25 + accountId: 7aa7988a-ff61-4cb8-bef3-15395355d108 + accountName: Printing & Stationery + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 45 + accountId: 043b6bcb-dfe6-4c97-9b4c-f9b300fe3f03 + accountName: Telephone & Internet + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 0 + accountId: eef78ed1-dfed-447c-bdba-3a49fb2c044b + accountName: Audit & Accountancy fees + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 130 + accountId: c16f5c35-8283-47da-9d09-5fecb183b0cb + accountName: Cleaning + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: SalesGeneralAdministrative + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 860.02 + accountId: df62060b-41cc-4bf2-9de7-c7e537b5663a + accountName: Travel - National + accountCategory: + status: Suggested + levels: + - levelName: Expense + confidence: 99.99 + - levelName: Operating + confidence: 99.99 + - levelName: Travel + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 850.22 + accountId: 68794a8f-b22d-4520-b97b-025b7cb10f94 + accountName: Other Revenue + accountCategory: + status: Suggested + levels: + - levelName: Income + confidence: 99.99 + - levelName: Revenue + confidence: 99.99 + - levelName: Online + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 138457.98 + accountId: 72df89d2-512b-4455-af51-a6b563733842 + accountName: Sales + accountCategory: + status: Suggested + levels: + - levelName: Income + confidence: 99.99 + - levelName: Revenue + confidence: 99.99 + - levelName: Wholesale + confidence: 99.99 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-categorized-profit-and-loss-statement + x-speakeasy-name-override: get-categorized-accounts + x-speakeasy-group: financial-statements.profit-and-loss + parameters: + - $ref: '#/components/parameters/reportDate' + - $ref: '#/components/parameters/numberOfPeriods' + '/companies/{companyId}/reports/enhancedBalanceSheet/accounts': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: Get categorized balance sheet statement + operationId: get-categorized-balance-sheet-statement + x-speakeasy-name-override: get-categorized-accounts + x-speakeasy-group: financial-statements.balance-sheet + description: |- + The *Get categorized balance sheet statement* endpoint returns a list of categorized accounts that appear on a company’s Balance Sheet along with a balance per financial statement date. + + Codat suggests a category for each account automatically, but you can [change it](https://docs.codat.io/lending/features/financial-statements-overview#recategorizing-accounts) to a more suitable one. + tags: + - Financial statements + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/EnhancedFinancialReport' + example: + reportInfo: + currency: GBP + reportName: EnhancedBalanceSheetAccounts + companyName: Biscuits + generatedDate: '2023-03-24T16:42:09.2973105Z' + reportItems: + - date: '2022-08-31T00:00:00' + balance: 12973.03 + accountId: 22de1660-d745-4809-a363-16b134607e66 + accountName: Prepayments + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: AccruedDeferredAssets + confidence: 99.99 + - levelName: PrepaidExpenses + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 316065.92 + accountId: dbcaf288-2b39-4b95-8ab3-42202ab15918 + accountName: Business Current Account + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Bank + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 65945.07 + accountId: e5d7612c-1671-47b4-b733-5db48363fcd0 + accountName: Inventory + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Inventory + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 71937.95 + accountId: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + accountName: Accounts Receivable + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Receivables + confidence: 99.99 + - levelName: AccountsReceivables + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 2180148.56 + accountId: 724ca578-8b5d-4bdb-ad45-e3820eee9de9 + accountName: Office Equipment + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: NonCurrent + confidence: 99.99 + - levelName: AccumulatedDepreciationDepletionAmortization + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1804674.9 + accountId: be3eb911-034b-42de-95db-0d58ac978b7f + accountName: Computer Equipment + accountCategory: + status: Suggested + levels: + - levelName: Asset + confidence: 99.99 + - levelName: NonCurrent + confidence: 99.99 + - levelName: AccumulatedDepreciationDepletionAmortization + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 3417424.16 + accountId: 39225d6f-3722-4508-ac3f-a2f6ec96ad31 + accountName: Retained Earnings + accountCategory: + status: Suggested + levels: + - levelName: Equity + confidence: 99.99 + - levelName: RetainedEarnings + confidence: 99.99 + - levelName: CapitalIncomeReserve + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 44252.52 + accountId: 78828dd9-6008-4662-b43c-e9d87907fd2b + accountName: Current Year Earnings + accountCategory: + status: Suggested + levels: + - levelName: Equity + confidence: 99.99 + - levelName: ShareCapital + confidence: 99.99 + - levelName: CommonStock + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 75835.64 + accountId: 53bf27a7-7497-4c61-9887-dfaad5c6d80a + accountName: Accounts Payable + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: AccountsPayable + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 208264.65 + accountId: e2530acd-91c8-48f8-a35f-935dbd7432e2 + accountName: Accruals + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: AccruedLiabilities + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 0 + accountId: d19852a2-e292-4eb9-a909-9dadb95c0e76 + accountName: Rounding + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Bank + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 25184.57 + accountId: 62060aae-e5a6-4db5-a3bb-6abec6d47959 + accountName: Credit Card Control Account + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Debt + confidence: 99.99 + - levelName: CreditCards + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 9650.58 + accountId: 9be6382f-6b33-402d-b448-0db1dbf67a98 + accountName: Historical Adjustment + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Debt + confidence: 99.99 + - levelName: LoansPayable + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 2022.41 + accountId: 8636effc-50fb-45ba-8b2b-18336fa29b6b + accountName: John Smith + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Debt + confidence: 99.99 + - levelName: LoansPayable + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 29034.75 + accountId: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + accountName: VAT + accountCategory: + status: Confirmed + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Personnel + confidence: 99.99 + - levelName: PensionPayable + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 1076.55 + accountId: 3b58f7ff-fa16-453a-9931-f020816d76e7 + accountName: Interest Payables + accountCategory: + status: Confirmed + levels: + - levelName: Liability + confidence: 99.99 + - levelName: Current + confidence: 99.99 + - levelName: Personnel + confidence: 99.99 + - levelName: PensionPayable + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 0 + accountId: 8852a857-aa9d-4706-839f-638e9d6b5a66 + accountName: Unpaid Expense Claims + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: NonCurrent + confidence: 99.99 + - date: '2022-08-31T00:00:00' + balance: 638999.6 + accountId: 55008233-40e7-41ac-84af-2255fa028c2e + accountName: Loan + accountCategory: + status: Suggested + levels: + - levelName: Liability + confidence: 99.99 + - levelName: NonCurrent + confidence: 99.99 + '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' + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/numberOfPeriods' + '/companies/{companyId}/reports/enhancedCashFlow/transactions': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: Get categorized bank statement + operationId: get-categorized-bank-statement + x-speakeasy-group: banking.categorized-statement + description: "\uFEFF\x3E\x20\x2A\x2A\x43\x61\x74\x65\x67\x6F\x72\x69\x7A\x61\x74\x69\x6F\x6E\x20\x65\x6E\x67\x69\x6E\x65\x2A\x2A\n\x3E\n\x3E\x20\x54\x68\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x7A\x61\x74\x69\x6F\x6E\x20\x65\x6E\x67\x69\x6E\x65\x20\x75\x73\x65\x73\x20\x6D\x61\x63\x68\x69\x6E\x65\x20\x6C\x65\x61\x72\x6E\x69\x6E\x67\x20\x61\x6E\x64\x20\x68\x61\x73\x20\x62\x65\x65\x6E\x20\x66\x75\x6C\x6C\x79\x20\x74\x72\x61\x69\x6E\x65\x64\x20\x61\x67\x61\x69\x6E\x73\x74\x20\x50\x6C\x61\x69\x64\x20\x61\x6E\x64\x20\x54\x72\x75\x65\x4C\x61\x79\x65\x72\x20\x62\x61\x6E\x6B\x69\x6E\x67\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2E\x20\x49\x74\x20\x69\x73\x20\x6E\x6F\x74\x20\x66\x75\x6C\x6C\x79\x20\x74\x72\x61\x69\x6E\x65\x64\x20\x61\x67\x61\x69\x6E\x73\x74\x20\x74\x68\x65\x20\x42\x61\x73\x69\x71\x20\x62\x61\x6E\x6B\x69\x6E\x67\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x2E\n\n\x54\x68\x65\x20\x5F\x47\x65\x74\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x7A\x65\x64\x20\x62\x61\x6E\x6B\x20\x73\x74\x61\x74\x65\x6D\x65\x6E\x74\x5F\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x70\x72\x6F\x76\x69\x64\x65\x73\x20\x61\x20\x66\x75\x6C\x6C\x79\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x7A\x65\x64\x20\x6C\x69\x73\x74\x20\x6F\x66\x20\x62\x61\x6E\x6B\x69\x6E\x67\x20\x74\x72\x61\x6E\x73\x61\x63\x74\x69\x6F\x6E\x73\x20\x66\x6F\x72\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\x20\x41\x63\x63\x6F\x75\x6E\x74\x73\x20\x61\x6E\x64\x20\x74\x72\x61\x6E\x73\x61\x63\x74\x69\x6F\x6E\x20\x64\x61\x74\x61\x20\x61\x72\x65\x20\x6F\x62\x74\x61\x69\x6E\x65\x64\x20\x66\x72\x6F\x6D\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x27\x73\x20\x62\x61\x6E\x6B\x69\x6E\x67\x20\x64\x61\x74\x61\x20\x73\x6F\x75\x72\x63\x65\x73\x2E" + tags: + - Bank statements + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/EnhancedCashFlowTransactions' + examples: + Categorized bank statement: + $ref: '#/components/examples/EnhancedCashflowExample' + '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' + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + '/companies/{companyId}/reports/enhancedInvoices': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: List reconciled invoices + tags: + - Accounts receivable + operationId: list-reconciled-invoices + x-speakeasy-name-override: list-reconciled + x-speakeasy-group: accounts-receivable.invoices + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + responses: + '200': + description: OK + content: + application/json: + x-speakeasy-usage-example: true + schema: + $ref: '#/components/schemas/EnhancedInvoicesReport' + example: + reportInfo: + pageNumber: 1 + pageSize: 10 + totalResults: 101 + reportName: Invoices report + companyName: Small Sandbox + generatedDate: '2023-05-10T10:50:23.9437977Z' + reportItems: + - id: 15221fa4-e91a-4f64-a2bb-caeab4db85a4 + invoiceNumber: UDs5KlfE + customerRef: + id: ee4d0eee-063d-4c9f-8226-2c9a6a816249 + customerName: Serena Keeling + issueDate: '2021-04-06T09:44:00' + dueDate: '2021-04-06T09:44:00' + status: Paid + currency: GBP + totalAmount: 7044.83 + amountDue: 0 + paidOnDate: '2021-04-06T09:44:00' + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2022-02-27T18:28:00' + payments: [] + - id: 58aea1cb-5b31-4eed-ba16-489dfa67a831 + invoiceNumber: 1IU1PMoT + customerRef: + id: 81e9c0df-3e5e-4180-b20c-c8e58100cdf3 + customerName: Quinton Kovacek + issueDate: '2021-04-06T09:44:00' + dueDate: '2021-04-06T09:44:00' + status: Paid + currency: GBP + totalAmount: 3567.59 + amountDue: 0 + paidOnDate: '2021-04-06T09:44:00' + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2021-06-23T22:47:00' + payments: [] + - id: 9ecd07bc-9cab-4516-bad0-a0cd565cdbaf + invoiceNumber: eEIWyPN4 + customerRef: + id: c7326084-cd56-48e6-bcfa-be8919e024e1 + customerName: Antwon Dach + issueDate: '2021-04-08T01:27:00' + dueDate: '2021-04-18T01:27:00' + status: Paid + currency: GBP + totalAmount: 153233.36 + amountDue: 0 + paidOnDate: '2021-04-10T12:31:00' + modifiedDate: '2022-08-01T09:44:59Z' + sourceModifiedDate: '2021-11-11T12:10:00' + payments: + - id: 0878e8be-6746-4347-80ba-5491328c8411 + date: '2021-04-10T12:31:00' + paymentType: payments + amount: 153233.36 + currency: GBP + currencyRate: 1 + - id: 7cea078a-5c9a-4788-ae72-9bb60c5cc184 + invoiceNumber: BXb8mYQW + customerRef: + id: 44e8516d-bcb0-459f-9e5d-7beaa56d57d0 + customerName: Dolores Rath + issueDate: '2021-04-16T17:30:00' + dueDate: '2021-04-23T17:30:00' + status: Paid + currency: GBP + totalAmount: 12657.69 + amountDue: 0 + paidOnDate: '2021-04-23T17:30:00' + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2021-12-08T11:32:00' + payments: + - id: 17b42934-13f6-4738-a506-2e253b1a606f + date: '2021-04-23T17:30:00' + paymentType: payments + amount: 12657.69 + currency: GBP + currencyRate: 1 + - id: aa4503d7-fe01-49fe-ba42-259b421ac640 + invoiceNumber: wdjwiL5B + customerRef: + id: 5cbaf1af-4f02-4206-85ab-c525bd9b4f99 + customerName: Bryana Douglas + issueDate: '2021-04-20T06:46:00' + dueDate: '2021-04-27T06:46:00' + status: PartiallyPaid + currency: GBP + totalAmount: 12935.39 + amountDue: 381.09 + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2022-03-11T20:03:00' + payments: + - id: 1c03986b-9b6c-4220-bde6-4e3eba6cef9f + date: '2021-04-23T14:59:00' + paymentType: payments + amount: 12554.3 + currency: GBP + currencyRate: 1 + - id: d8a0e26e-4ec8-4fb5-887d-8b7531e3bedf + invoiceNumber: cTjJcu8x + customerRef: + id: 6f5290e5-70aa-4d0c-816e-9d2312cf217f + customerName: Brady Wilderman + issueDate: '2021-04-23T09:32:00' + dueDate: '2021-05-03T09:32:00' + status: Paid + currency: GBP + totalAmount: 21526.72 + amountDue: 0 + paidOnDate: '2021-05-03T09:32:00' + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2021-03-12T22:37:00' + payments: + - id: 93c9c11b-3ec0-4314-85f6-0751763e752a + date: '2021-05-03T09:32:00' + paymentType: payments + amount: 21506.72 + currency: GBP + currencyRate: 1 + - id: 06890e67-35fb-4276-9857-95db40cfd15d + invoiceNumber: htXJuUDb + customerRef: + id: 44e8516d-bcb0-459f-9e5d-7beaa56d57d0 + customerName: Dolores Rath + issueDate: '2021-05-01T23:23:00' + dueDate: '2021-05-11T23:23:00' + status: PartiallyPaid + currency: GBP + totalAmount: 7151.41 + amountDue: 1225.06 + modifiedDate: '2022-08-01T09:44:59Z' + sourceModifiedDate: '2022-02-24T23:02:00' + payments: + - id: 82865077-0857-46db-b9a1-6d21da43b6aa + date: '2021-05-04T17:57:00' + paymentType: payments + amount: 5926.35 + currency: GBP + currencyRate: 1 + - id: 160e8b51-1fa0-46b9-98fe-1ff5399ce99b + invoiceNumber: 9wegEXpG + customerRef: + id: 44e8516d-bcb0-459f-9e5d-7beaa56d57d0 + customerName: Dolores Rath + issueDate: '2021-05-18T08:53:00' + dueDate: '2021-05-25T08:53:00' + status: PartiallyPaid + currency: GBP + totalAmount: 22522.34 + amountDue: 14408.54 + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2022-01-13T07:52:00' + payments: + - id: 75bd7205-bc12-4517-9964-aae159fdfaee + date: '2021-05-23T04:04:00' + paymentType: payments + amount: 8113.8 + currency: GBP + currencyRate: 1 + - id: 5a934955-561d-436a-a564-fd624a79f54c + invoiceNumber: l7YwGxG7 + customerRef: + id: cc96af36-e2f5-49f7-bf40-271503f45071 + customerName: Ignacio Moore + issueDate: '2021-05-25T19:51:00' + dueDate: '2021-06-04T19:51:00' + status: Paid + currency: GBP + totalAmount: 11047.08 + amountDue: 0 + paidOnDate: '2021-05-28T07:31:00' + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2021-08-06T05:50:00' + payments: + - id: 608fd022-f7d0-44a9-90c4-bebe0573f206 + date: '2021-05-28T07:31:00' + paymentType: payments + amount: 11047.08 + currency: GBP + currencyRate: 1 + - id: 17690788-2936-46b5-ba46-ba6a36a87483 + invoiceNumber: ntH1cRYz + customerRef: + id: e1ecc8f2-8a63-4fe9-97c9-c87fd90ca0a6 + customerName: Freida Ebert + issueDate: '2021-05-27T19:07:00' + dueDate: '2021-06-03T19:07:00' + status: PartiallyPaid + currency: GBP + totalAmount: 7191.32 + amountDue: 5036.83 + modifiedDate: '2022-04-11T13:49:37Z' + sourceModifiedDate: '2021-03-27T08:54:00' + payments: + - id: a343b2a0-d327-41b0-993e-7b6b92fde425 + date: '2021-06-03T19:07:00' + paymentType: payments + amount: 2154.49 + currency: GBP + currencyRate: 1 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: Gets a list of invoices linked to the corresponding banking transaction + '/companies/{companyId}/reports/liabilities/loans/transactions': + parameters: + - $ref: '#/components/parameters/companyId' + - schema: + type: string + enum: + - banking + - commerce + - accounting + in: query + name: sourceType + description: Data source type. + required: true + post: + summary: Generate loan transactions report + description: | + The _Generate loan transactions_ endpoint requests the generation of the Loan Transactions report. + + Learn more about Codat's liabilities feature [here](https://docs.codat.io/lending/features/liabilities-overview). + + Make sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint. + tags: + - Liabilities + responses: + '202': + description: Accepted + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: generate-loan-transactions + x-speakeasy-name-override: generate-loan-transactions + get: + summary: List loan transactions + description: | + The *List loan transactions* endpoint returns all [loan transactions](https://docs.codat.io/lending-api#/schemas/LoanTransactions) identified from a company's accounting, banking, and commerce integrations. + + This detail gives analysts a better idea of the loan obligations a company may have. + + Make sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint. + tags: + - Liabilities + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/LoanTransactions' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: list-loan-transactions + x-speakeasy-name-override: list-loan-transactions + '/companies/{companyId}/reports/liabilities/loans': + parameters: + - $ref: '#/components/parameters/companyId' + - schema: + type: string + enum: + - banking + - commerce + - accounting + in: query + name: sourceType + description: Data source type. + required: true + post: + summary: Generate loan summaries report + description: | + The _Generate loan summaries_ endpoint requests the generation of the Loan Summaries report. + + Learn more about Codat's liabilities feature [here](https://docs.codat.io/lending/features/liabilities-overview). + + Make sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint. + tags: + - Liabilities + responses: + '202': + description: Accepted + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: generate-loan-summary + x-speakeasy-name-override: generate-loan-summary + get: + summary: Get loan summaries + description: | + The *Get loan summaries* endpoint returns a summary by integration type of all loans identified from a company's accounting, banking, and commerce integrations. + + The endpoint returns a list of a company's [loan summaries](https://docs.codat.io/lending-api#/schemas/LoanSummary) for each valid data connection. + + Make sure you have [synced a company](https://docs.codat.io/lending-api#/operations/refresh-company-data) recently before calling the endpoint. + tags: + - Liabilities + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/LoanSummary' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-loan-summary + x-speakeasy-name-override: get-loan-summary + '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/revenue': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get commerce revenue metrics + tags: + - Sales + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceReport' + example: + - reportInfo: + name: revenue + displayName: Revenue + dimensions: + - index: 0 + displayName: Period + type: datespan + items: + - index: 0 + displayName: Period 0 + start: '2022-01-01' + end: '2022-12-31' + - index: 1 + displayName: Revenue metrics + type: string + items: + - index: 0 + value: Revenue + - index: 1 + value: Revenue growth + measures: + - displayName: Value + units: GBP + index: 0 + type: currency + - displayName: Percentage change vs. previous period + units: '%' + index: 1 + type: percentage + reportData: + - dimension: 0 + dimensionDisplayName: Period + item: 0 + itemDisplayName: Period 0 + components: + - dimension: 1 + dimensionDisplayName: Revenue metrics + item: 0 + itemDisplayName: Revenue + measures: + - index: 0 + measureDisplayName: Value + value: 2392.48 + - dimension: 1 + dimensionDisplayName: Revenue metrics + item: 1 + itemDisplayName: Revenue growth + measures: + - index: 1 + measureDisplayName: Percentage change vs. previous period + value: 276.65 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-commerce-revenue-metrics + x-speakeasy-name-override: get-revenue + x-speakeasy-group: sales.metrics + description: "The *Get revenue report* endpoint returns the revenue and revenue growth for a specific company connection over one or more periods of time.\n\nThis detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. \n\n[Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate the revenue metrics.\n\n#### Response structure\n\nThe Revenue report's dimensions and measures are:\n\n| Index | Dimensions |\n|---------------|------------|\n| `index` = 0 | Period |\n| `index` = 1 | Revenue |\n\n| Index | Measures |\n|---------------|--------------------------------------------------------------------------------------------------------------------------|\n| `index` = 0 | Value |\n| `index` = 1 | Percentage change, defined as the change between the current and previous periods' values and expressed as a percentage. |\n\nThe report data then combines multiple reporting dimensions and measures and outputs the value of each combination.\n" + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/periodLength' + - $ref: '#/components/parameters/numberOfPeriodsRequired' + - $ref: '#/components/parameters/periodUnit' + - $ref: '#/components/parameters/includeDisplayNames' + '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/orders': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get orders report + tags: + - Sales + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceReport' + example: + - reportInfo: + name: orders + displayName: Orders + dimensions: + - index: 0 + displayName: Period + type: datespan + items: + - index: 0 + displayName: Period 0 + start: '2022-01-01' + end: '2022-12-31' + - index: 1 + displayName: Order metrics + type: string + items: + - index: 0 + value: Number of orders + - index: 1 + value: Total value + - index: 2 + value: Average order value + measures: + - displayName: Count + index: 0 + type: int + - displayName: Value + units: GBP + index: 1 + type: currency + reportData: + - dimension: 0 + dimensionDisplayName: Period + item: 0 + itemDisplayName: Period 0 + components: + - dimension: 1 + dimensionDisplayName: Order metrics + item: 0 + itemDisplayName: Number of orders + measures: + - index: 0 + measureDisplayName: Count + value: 94 + - dimension: 1 + dimensionDisplayName: Order metrics + item: 1 + itemDisplayName: Total value + measures: + - index: 1 + measureDisplayName: Value + value: 3315.18 + - dimension: 1 + dimensionDisplayName: Order metrics + item: 2 + itemDisplayName: Average order value + measures: + - index: 1 + measureDisplayName: Value + value: 35.27 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-commerce-orders-report + x-speakeasy-name-override: get-orders + x-speakeasy-group: sales.reports + description: "The *Get orders report* endpoint returns the number of orders, total value, and average order value for a specific company's commerce connection over one or more periods of time.\n\nThis detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. \n\n[Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate the order metrics.\n\n#### Response structure\n\nThe Orders report's dimensions and measures are:\n\n| Index | Dimensions |\n|---------------|----------------|\n| `index` = 0 | Period |\n| `index` = 1 | Order metrics |\n\n| Index | Measures |\n|---------------|------------|\n| `index` = 0 | Count |\n| `index` = 1 | Value |\n\nThe report data then combines multiple reporting dimensions and measures and outputs the value of each combination.\n" + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/periodLength' + - $ref: '#/components/parameters/numberOfPeriodsRequired' + - $ref: '#/components/parameters/periodUnit' + - $ref: '#/components/parameters/includeDisplayNames' + '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/refunds': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get refunds report + tags: + - Sales + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceReport' + example: + - reportInfo: + name: refunds + displayName: Refunds + dimensions: + - index: 0 + displayName: Period + type: datespan + items: + - index: 0 + displayName: Period 0 + start: '2022-01-01' + end: '2022-12-31' + - index: 1 + displayName: Refund metrics + type: string + items: + - index: 0 + value: Number of refunds + - index: 1 + value: Value of refunds + - index: 2 + value: Refund rate + measures: + - displayName: Count + index: 0 + type: int + - displayName: Value + units: GBP + index: 1 + type: currency + - displayName: Percentage + units: '%' + index: 2 + type: percentage + reportData: + - dimension: 0 + dimensionDisplayName: Period + item: 0 + itemDisplayName: Period 0 + components: + - dimension: 1 + dimensionDisplayName: Refund metrics + item: 0 + itemDisplayName: Number of refunds + measures: + - index: 0 + measureDisplayName: Count + value: 39 + - dimension: 1 + dimensionDisplayName: Refund metrics + item: 1 + itemDisplayName: Value of refunds + measures: + - index: 1 + measureDisplayName: Value + value: 642.82 + - dimension: 1 + dimensionDisplayName: Refund metrics + item: 2 + itemDisplayName: Refund rate + measures: + - index: 2 + measureDisplayName: Percentage + value: 0.41 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-commerce-refunds-report + x-speakeasy-name-override: get-refunds + x-speakeasy-group: sales.reports + description: "The *Get refunds report* endpoint returns the number and total value of refunds and the refund rate for a specific company's commerce connection over one or more periods of time.\n\nThis detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. \n\n[Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate the refunds metrics.\n\n#### Response structure\n\nThe Refunds report's dimensions and measures are:\n\n| Index | Dimensions |\n|----------------|----------------|\n| `index` = 0 | Period |\n| `index` = 1 | Refund metrics |\n\n| Index | Measures |\n|----------------|------------|\n| `index` = 0 | Count |\n| `index` = 1 | Value |\n| `index` = 2 | Percentage |\n\nThe report data then combines multiple reporting dimensions and measures and outputs the value of each combination.\n" + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/periodLength' + - $ref: '#/components/parameters/numberOfPeriodsRequired' + - $ref: '#/components/parameters/periodUnit' + - $ref: '#/components/parameters/includeDisplayNames' + '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/customerRetention': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get customer retention metrics + tags: + - Sales + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceReport' + example: + - reportInfo: + name: customer_retention + displayName: Customer Retention + dimensions: + - index: 0 + displayName: Period + type: datespan + items: + - index: 0 + displayName: Period 0 + start: '2022-01-01' + end: '2022-12-31' + - index: 1 + displayName: Customer retention metrics + type: string + items: + - index: 0 + value: Existing customers + - index: 1 + value: New customers + - index: 2 + value: Total customers + - index: 3 + value: Retention rate + - index: 4 + value: Repeat rate + measures: + - displayName: Count + index: 0 + type: int + - displayName: Percentage + index: 1 + type: percentage + reportData: + - dimension: 0 + dimensionDisplayName: Period + item: 0 + itemDisplayName: Period 0 + components: + - dimension: 1 + dimensionDisplayName: Customer retention metrics + item: 0 + itemDisplayName: Existing customers + measures: + - index: 0 + measureDisplayName: Count + value: 13 + - dimension: 1 + dimensionDisplayName: Customer retention metrics + item: 1 + itemDisplayName: New customers + measures: + - index: 0 + measureDisplayName: Count + value: 47 + - dimension: 1 + dimensionDisplayName: Customer retention metrics + item: 2 + itemDisplayName: Total customers + measures: + - index: 0 + measureDisplayName: Count + value: 60 + - dimension: 1 + dimensionDisplayName: Customer retention metrics + item: 3 + itemDisplayName: Retention rate + measures: + - index: 1 + measureDisplayName: Percentage + value: 0 + - dimension: 1 + dimensionDisplayName: Customer retention metrics + item: 4 + itemDisplayName: Repeat rate + measures: + - index: 1 + measureDisplayName: Percentage + value: 21.67 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-commerce-customer-retention-metrics + x-speakeasy-name-override: get-customer-retention + x-speakeasy-group: sales.metrics + description: "The *Get customer retention metrics* endpoint returns customer retention insights for a specific company's commerce connection over one or more periods of time.\n\nThis detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. \n\n#### Customer retention metrics\n\n- __Existing customers__: the number of unique customers that have placed an order(s) in the specified period and any previous period. \n- __New customers__: the number of unique customers that have placed an order(s) in the specified period and none in any previous period.\n- __Total customers__: the total number of existing and new customers within the specified period.\n- __Retention rate__: the ratio of existing customers within the specified period compared to the total customers at the end of the previous period represented as a percentage.\n- __Repeat rate__: the ratio of existing customers to total customers over the specified period represented as a percentage.\n\n[Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate customer retention metrics.\n\n#### Response structure\n\nThe Customer retention report's dimensions and measures are:\n\n| Index | Dimensions |\n|-----------------------------|----------------------------|\n| `index` = 0 | Period |\n| `index` = 1 | Customer retention metrics |\n\n| Index | Measures |\n|----------------------|------------|\n| `index` = 0 | Count |\n| `index` = 1 | Percentage |\n\nThe report data then combines multiple reporting dimensions and measures and outputs the value of each combination." + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/periodLength' + - $ref: '#/components/parameters/numberOfPeriodsRequired' + - $ref: '#/components/parameters/periodUnit' + - $ref: '#/components/parameters/includeDisplayNames' + '/data/companies/{companyId}/connections/{connectionId}/assess/commerceMetrics/lifetimeValue': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get lifetime value metrics + tags: + - Sales + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceReport' + example: + - reportInfo: + name: lifetime_value + displayName: Lifetime Value + dimensions: + - index: 0 + displayName: Period + type: datespan + items: + - index: 0 + displayName: Period 0 + start: '2022-01-01' + end: '2022-12-31' + - index: 1 + displayName: Lifetime value metrics + type: string + items: + - index: 0 + value: Lifetime value + measures: + - displayName: Value + units: GBP + index: 0 + type: currency + reportData: + - dimension: 0 + dimensionDisplayName: Period + item: 0 + itemDisplayName: Period 0 + components: + - dimension: 1 + dimensionDisplayName: Lifetime value metrics + item: 0 + itemDisplayName: Lifetime value + measures: + - index: 0 + measureDisplayName: Value + value: 3782.07 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-commerce-lifetime-value-metrics + x-speakeasy-name-override: get-lifetime-value + x-speakeasy-group: sales.metrics + description: | + The *Get lifetime value metrics* endpoint returns the average revenue that a specific company will generate throughout its lifespan over one or more periods of time. + + This detail helps you assess a merchant's health and advise them on performance improvement strategies. It also provides you with key insights you need to assess the credit risk of a company. + + [Learn more](https://docs.codat.io/lending/features/sales-overview#metrics) about the formulas used to calculate the lifetime value metrics. + + #### Response structure + + The Lifetime value report's dimensions and measures are: + + | Index | Dimensions | + |---------------|------------------------| + | `index` = 0 | Period | + | `index` = 1 | Lifetime value metrics | + + | Index | Measures | + |-------------------|---------| + | `index` = 1 | Value | + + The report data then combines multiple reporting dimensions and measures and outputs the value of each combination. + parameters: + - $ref: '#/components/parameters/reportDateRequired' + - $ref: '#/components/parameters/periodLength' + - $ref: '#/components/parameters/numberOfPeriodsRequired' + - $ref: '#/components/parameters/periodUnit' + - $ref: '#/components/parameters/includeDisplayNames' + '/data/companies/{companyId}/assess/excel': + parameters: + - $ref: '#/components/parameters/companyId' + post: + summary: Generate Excel report + tags: + - Excel reports + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ExcelStatus' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: generate-excel-report + x-speakeasy-name-override: generate + description: |+ + The *Generate Excel report* endpoint requests the production of a downloadable Excel file for a report type specified in the `reportType` query parameter. + + In response, the endpoint returns the [status](https://docs.codat.io/lending-api#/schemas/ExcelStatus) detailing the current state of the report generation request. + + ### Report types + + | reportType | Description | + |--------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------| + | `audit` | Identifies inaccurate or out-of-date accounts, helping you to make decisions with confidence. || [audit](https://docs.codat.io/lending/excel/audit-report) | Identify inaccurate or out-of-date accounts, helping you to make decisions with confidence. | + | `enhancedCashFlow` | Provides a fully categorized list of bank transactions for a company, allowing lenders to accurately forecast a company's cash flow. | + | `enhancedFinancials` | Supports decision-making using fully categorized financial statements to allow lenders to automate their underwriting processes. | + | `enhancedInvoices` | Helps verify that payments have been made against historic invoices. Great for invoice finance lenders. | + + [Learn more](https://docs.codat.io/lending/features/excel-download-overview#feature-components) about valid Excel report types. + + + parameters: + - $ref: '#/components/parameters/excelReportType' + get: + summary: Get Excel report status + tags: + - Excel reports + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/ExcelStatus' + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-excel-report-generation-status + x-speakeasy-name-override: get-status + description: "\uFEFF\x54\x68\x65\x20\x2A\x47\x65\x74\x20\x45\x78\x63\x65\x6C\x20\x72\x65\x70\x6F\x72\x74\x20\x73\x74\x61\x74\x75\x73\x2A\x20\x72\x65\x74\x75\x72\x6E\x73\x20\x74\x68\x65\x20\x73\x74\x61\x74\x75\x73\x20\x6F\x66\x20\x74\x68\x65\x20\x72\x65\x70\x6F\x72\x74\x20\x6D\x6F\x73\x74\x6C\x79\x20\x72\x65\x63\x65\x6E\x74\x6C\x79\x20\x72\x65\x71\x75\x65\x73\x74\x65\x64\x20\x66\x6F\x72\x20\x45\x78\x63\x65\x6C\x20\x67\x65\x6E\x65\x72\x61\x74\x69\x6F\x6E\x2E\x20\x49\x74\x20\x64\x6F\x65\x73\x20\x6E\x6F\x74\x20\x72\x65\x74\x75\x72\x6E\x20\x74\x68\x65\x20\x73\x74\x61\x74\x75\x73\x20\x6F\x66\x20\x61\x6E\x79\x20\x68\x69\x73\x74\x6F\x72\x69\x63\x61\x6C\x20\x72\x65\x70\x6F\x72\x74\x20\x72\x65\x71\x75\x65\x73\x74\x73\x2E\x20\n\n\x50\x6F\x6C\x6C\x20\x74\x68\x69\x73\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x74\x6F\x20\x63\x68\x65\x63\x6B\x20\x74\x68\x65\x20\x70\x72\x6F\x67\x72\x65\x73\x73\x20\x6F\x66\x20\x74\x68\x65\x20\x72\x65\x70\x6F\x72\x74\x20\x6F\x6E\x63\x65\x20\x79\x6F\x75\x20\x68\x61\x76\x65\x20\x72\x65\x71\x75\x65\x73\x74\x65\x64\x20\x69\x74\x73\x20\x67\x65\x6E\x65\x72\x61\x74\x69\x6F\x6E\x2E\x20\x54\x68\x69\x73\x20\x77\x69\x6C\x6C\x20\x6E\x6F\x74\x20\x61\x66\x66\x65\x63\x74\x20\x74\x68\x65\x20\x67\x65\x6E\x65\x72\x61\x74\x69\x6F\x6E\x20\x6F\x66\x20\x74\x68\x65\x20\x72\x65\x70\x6F\x72\x74\x2E\x20\n\n\x57\x68\x65\x6E\x20\x74\x68\x65\x20\x72\x65\x70\x6F\x72\x74\x20\x67\x65\x6E\x65\x72\x61\x74\x69\x6F\x6E\x20\x63\x6F\x6D\x70\x6C\x65\x74\x65\x73\x20\x73\x75\x63\x63\x65\x73\x73\x66\x75\x6C\x6C\x79\x2C\x20\x74\x68\x65\x20\x60\x69\x6E\x50\x72\x6F\x67\x72\x65\x73\x73\x60\x20\x70\x72\x6F\x70\x65\x72\x74\x79\x20\x77\x69\x6C\x6C\x20\x62\x65\x20\x6D\x61\x72\x6B\x65\x64\x20\x61\x73\x20\x60\x66\x61\x6C\x73\x65\x60\x20\x61\x6E\x64\x20\x74\x68\x65\x20\x60\x73\x75\x63\x63\x65\x73\x73\x60\x20\x66\x69\x65\x6C\x64\x20\x77\x69\x6C\x6C\x20\x62\x65\x20\x6D\x61\x72\x6B\x65\x64\x20\x61\x73\x20\x60\x74\x72\x75\x65\x60\x2E" + parameters: + - $ref: '#/components/parameters/excelReportType' + '/data/companies/{companyId}/assess/excel/download': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: Download Excel report + tags: + - Excel reports + responses: + '200': + description: OK + content: + application/octet-stream: + schema: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: download-excel-report + x-speakeasy-name-override: download + description: "\uFEFF\x54\x68\x65\x20\x2A\x44\x6F\x77\x6E\x6C\x6F\x61\x64\x20\x45\x78\x63\x65\x6C\x20\x72\x65\x70\x6F\x72\x74\x2A\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x20\x64\x6F\x77\x6E\x6C\x6F\x61\x64\x73\x20\x74\x68\x65\x20\x6C\x61\x74\x65\x73\x74\x20\x73\x75\x63\x63\x65\x73\x73\x66\x75\x6C\x6C\x79\x20\x67\x65\x6E\x65\x72\x61\x74\x65\x64\x20\x45\x78\x63\x65\x6C\x20\x72\x65\x70\x6F\x72\x74\x20\x6F\x66\x20\x61\x20\x73\x70\x65\x63\x69\x66\x69\x65\x64\x20\x72\x65\x70\x6F\x72\x74\x20\x74\x79\x70\x65\x20\x66\x6F\x72\x20\x61\x20\x67\x69\x76\x65\x6E\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\x20\n\n\x54\x68\x65\x20\x64\x6F\x77\x6E\x6C\x6F\x61\x64\x61\x62\x6C\x65\x20\x45\x78\x63\x65\x6C\x20\x66\x69\x6C\x65\x20\x69\x73\x20\x72\x65\x74\x75\x72\x6E\x65\x64\x20\x69\x6E\x20\x74\x68\x65\x20\x72\x65\x73\x70\x6F\x6E\x73\x65\x2E\x20\x59\x6F\x75\x20\x63\x61\x6E\x20\x73\x61\x76\x65\x20\x69\x74\x20\x74\x6F\x20\x79\x6F\x75\x72\x20\x6C\x6F\x63\x61\x6C\x20\x6D\x61\x63\x68\x69\x6E\x65\x2E\n\n\x59\x6F\x75\x20\x63\x61\x6E\x20\x5B\x6C\x65\x61\x72\x6E\x20\x6D\x6F\x72\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\x6C\x65\x6E\x64\x69\x6E\x67\x2F\x66\x65\x61\x74\x75\x72\x65\x73\x2F\x65\x78\x63\x65\x6C\x2D\x64\x6F\x77\x6E\x6C\x6F\x61\x64\x2D\x6F\x76\x65\x72\x76\x69\x65\x77\x23\x66\x65\x61\x74\x75\x72\x65\x2D\x63\x6F\x6D\x70\x6F\x6E\x65\x6E\x74\x73\x29\x20\x61\x62\x6F\x75\x74\x20\x76\x61\x6C\x69\x64\x20\x45\x78\x63\x65\x6C\x20\x72\x65\x70\x6F\x72\x74\x20\x74\x79\x70\x65\x73\x2E" + parameters: + - $ref: '#/components/parameters/excelReportType' + '/companies/{companyId}/connections/{connectionId}/data/accountTransactions': + get: + tags: + - Transactions + summary: List account transactions + description: "The *List account transactions* endpoint returns a list of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) for a given company's connection.\n\n[Account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) represent bank activity within an accounting software. All transactions that go through a bank account are recorded as account transactions.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-account-transactions + x-speakeasy-group: transactions.account-transactions + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAccountTransactions' + examples: + Clear Books: + value: + results: + - id: 062b3a9b-b04f-4d9c-9ebc-81dcb5bbf285 + transactionId: 356deb9f-98e6-4d6f-8db3-b378241895a1 + note: Direct income 38e8c917-0afc-4583-8ffe-1b53ad601197 + bankAccountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + date: '2022-04-19T00:00:00' + status: Unreconciled + currency: GBP + currencyRate: 1 + lines: + - description: Payment for direct income $38e8c917-0afc-4583-8ffe-1b53ad601197 + recordRef: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + dataType: directIncomes + amount: 188.33 + totalAmount: 188.33 + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2022-05-13T01:06:00' + metadata: + isDeleted: false + - id: f2656119-9521-4d51-a24d-003b44c1410b + transactionId: 1fde4f8f-68ca-48fc-8fe7-79ac467d2946 + note: Direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + bankAccountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + date: '2022-04-19T00:00:00' + status: Void + currency: GBP + currencyRate: 1 + lines: + - description: Payment for direct income $c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + recordRef: + id: c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + dataType: directIncomes + amount: 32095.91 + totalAmount: 32095.91 + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2023-02-13T00:34:00' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1745 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/accountTransactions?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/accountTransactions + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/accountTransactions?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: D7B-933784104 + transactionId: D7B-933784104 + bankAccountRef: + id: 20000-933270541 + name: Checking + date: '2022-12-01T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: D7B-933784104 + dataType: directCosts + amount: -1200 + totalAmount: -1200 + modifiedDate: '2023-04-26T09:13:23' + sourceModifiedDate: '2023-12-16T05:04:10' + metadata: + isDeleted: false + - id: DFA-933785132 + transactionId: DFA-933785132 + bankAccountRef: + id: 20000-933270541 + name: Checking + date: '2022-12-05T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: DFA-933785132 + dataType: directCosts + amount: -35 + totalAmount: -35 + modifiedDate: '2023-04-26T09:13:23' + sourceModifiedDate: '2023-12-16T05:04:11' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 652 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/accountTransactions?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/accountTransactions + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/accountTransactions?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '85' + transactionId: '85' + note: Opening Balance from Bank + bankAccountRef: + id: '57' + name: Visa Credit Card + date: '2015-08-12T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - description: Opening Balance from Bank + recordRef: + id: PUR-85 + dataType: directCosts + amount: -3831.8 + totalAmount: -3831.8 + modifiedDate: '2023-04-26T09:37:16' + sourceModifiedDate: '2016-09-12T18:13:07Z' + metadata: + isDeleted: false + - id: '5' + transactionId: '5' + bankAccountRef: + id: '81' + name: Current + date: '2015-11-24T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - description: contribution to start business + recordRef: + id: 5-1 + dataType: directIncomes + amount: 10000 + - description: funds borrowed to start business + recordRef: + id: 5-2 + dataType: directIncomes + amount: 25000 + totalAmount: 35000 + modifiedDate: '2023-04-26T09:37:17' + sourceModifiedDate: '2016-09-12T15:26:26Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 9141 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/accountTransactions?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/accountTransactions + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/accountTransactions?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '1' + transactionId: '1' + note: Opening Balance from Bank + bankAccountRef: + id: '61' + name: Dave PP Current + date: '2018-09-21T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: '1' + dataType: directIncomes + amount: 170.23 + totalAmount: 170.23 + modifiedDate: '2023-01-18T11:03:12' + sourceModifiedDate: '2018-12-17T14:56:20Z' + - id: '15' + transactionId: '15' + note: Payment to Google + bankAccountRef: + id: '61' + name: Dave PP Current + date: '2018-09-21T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - description: Payment to Google + recordRef: + id: PUR-15 + dataType: directCosts + amount: -1.59 + totalAmount: -1.59 + modifiedDate: '2023-01-18T11:03:11' + sourceModifiedDate: '2018-12-17T14:56:44Z' + pageNumber: 1 + pageSize: 2 + totalResults: 5984 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/accountTransactions?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/accountTransactions + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/accountTransactions?page=2&pageSize=2 + Xero: + value: + results: + - id: 74004690-82a1-4810-aaca-6ce575af94b4 + transactionId: 74004690-82a1-4810-aaca-6ce575af94b4 + bankAccountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + date: '2021-12-20T00:00:00' + status: Reconciled + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + dataType: billPayments + amount: -7267.2 + totalAmount: -7267.2 + modifiedDate: '2023-03-15T20:37:10' + sourceModifiedDate: '2021-01-02T22:51:40' + metadata: + isDeleted: false + - id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + transactionId: 65b746c8-9a5d-4a95-8096-d2316fcff592 + bankAccountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + date: '2022-02-17T00:00:00' + status: Reconciled + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + dataType: payments + amount: 4200 + totalAmount: 4200 + modifiedDate: '2023-03-15T20:37:10' + sourceModifiedDate: '2021-01-02T22:50:58' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 70 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/accountTransactions?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/accountTransactions + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/accountTransactions?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/accountTransactions/{accountTransactionId}': + get: + tags: + - Transactions + summary: Get account transaction + operationId: get-accounting-account-transaction + x-speakeasy-group: transactions.account-transactions + description: | + The *Get account transaction* endpoint returns a single account transaction for a given accountTransactionId. + + [Account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction) represent bank activity within an accounting software. All transactions that go through a bank account are recorded as account transactions. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: accountTransactionId + in: path + required: true + schema: + type: string + description: Unique identifier for an account transaction. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAccountTransaction' + examples: + Clear Books: + value: + id: 062b3a9b-b04f-4d9c-9ebc-81dcb5bbf285 + transactionId: 356deb9f-98e6-4d6f-8db3-b378241895a1 + note: Direct income 38e8c917-0afc-4583-8ffe-1b53ad601197 + bankAccountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + date: '2022-04-19T00:00:00' + status: Unreconciled + currency: GBP + currencyRate: 1 + lines: + - description: Payment for direct income $38e8c917-0afc-4583-8ffe-1b53ad601197 + recordRef: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + dataType: directIncomes + amount: 188.33 + totalAmount: 188.33 + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2022-05-13T01:06:00' + metadata: + isDeleted: false + QuickBooks Desktop: + value: + id: D7B-933784104 + transactionId: D7B-933784104 + bankAccountRef: + id: 20000-933270541 + name: Checking + date: '2022-12-01T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: D7B-933784104 + dataType: directCosts + amount: -1200 + totalAmount: -1200 + modifiedDate: '2023-04-26T09:13:23' + sourceModifiedDate: '2023-12-16T05:04:10' + metadata: + isDeleted: false + QuickBooks Online Sandbox: + value: + id: '85' + transactionId: '85' + note: Opening Balance from Bank + bankAccountRef: + id: '57' + name: Visa Credit Card + date: '2015-08-12T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - description: Opening Balance from Bank + recordRef: + id: PUR-85 + dataType: directCosts + amount: -3831.8 + totalAmount: -3831.8 + modifiedDate: '2023-04-26T09:37:16' + sourceModifiedDate: '2016-09-12T18:13:07Z' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '1' + transactionId: '1' + note: Opening Balance from Bank + bankAccountRef: + id: '61' + name: Dave PP Current + date: '2018-09-21T00:00:00' + status: Unknown + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: '1' + dataType: directIncomes + amount: 170.23 + totalAmount: 170.23 + modifiedDate: '2023-01-18T11:03:12' + sourceModifiedDate: '2018-12-17T14:56:20Z' + Xero: + value: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + transactionId: 74004690-82a1-4810-aaca-6ce575af94b4 + bankAccountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + date: '2021-12-20T00:00:00' + status: Reconciled + currency: GBP + currencyRate: 1 + lines: + - recordRef: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + dataType: billPayments + amount: -7267.2 + totalAmount: -7267.2 + modifiedDate: '2023-03-15T20:37:10' + sourceModifiedDate: '2021-01-02T22:51:40' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/accounts': + get: + tags: + - Financial statements + summary: List accounts + description: "\uFEFF\x54\x68\x65\x20\x2A\x4C\x69\x73\x74\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\x61\x20\x6C\x69\x73\x74\x20\x6F\x66\x20\x5B\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\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\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\x41\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\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x41\x63\x63\x6F\x75\x6E\x74\x29\x20\x61\x72\x65\x20\x74\x68\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x65\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x75\x73\x65\x73\x20\x74\x6F\x20\x72\x65\x63\x6F\x72\x64\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x74\x72\x61\x6E\x73\x61\x63\x74\x69\x6F\x6E\x73\x2E\n\n\x42\x65\x66\x6F\x72\x65\x20\x75\x73\x69\x6E\x67\x20\x74\x68\x69\x73\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x2C\x20\x79\x6F\x75\x20\x6D\x75\x73\x74\x20\x68\x61\x76\x65\x20\x5B\x72\x65\x74\x72\x69\x65\x76\x65\x64\x20\x64\x61\x74\x61\x20\x66\x6F\x72\x20\x74\x68\x65\x20\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\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x6F\x70\x65\x72\x61\x74\x69\x6F\x6E\x73\x2F\x72\x65\x66\x72\x65\x73\x68\x2D\x63\x6F\x6D\x70\x61\x6E\x79\x2D\x64\x61\x74\x61\x29\x2E" + operationId: list-accounting-accounts + x-speakeasy-group: financial-statements.accounts + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + x-speakeasy-usage-example: true + schema: + $ref: '#/components/schemas/AccountingAccounts' + examples: + Clear Books: + value: + results: + - id: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + nominalCode: '610' + name: Accounts Receivable + description: Invoices the business has issued but has not yet collected payment on. + fullyQualifiedCategory: Asset.Current + fullyQualifiedName: Asset.Current.Accounts Receivable + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T12:38:15Z' + sourceModifiedDate: '2022-12-10T16:39:00' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: 76d5f23b-9623-4e3b-89cd-da57228764d3 + nominalCode: '611' + name: Accounts Receivable + description: A provision anticipating that a portion of accounts receivable will never be collected. + fullyQualifiedCategory: Asset.Current + fullyQualifiedName: Asset.Current.Accounts Receivable + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T12:38:15Z' + sourceModifiedDate: '2022-10-19T05:49:00' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 98 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/accounts?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/accounts + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/accounts?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 8eaed16d-c69f-ec11-80f1-0022481b4546 + nominalCode: 45422026-68CA-4EF2-9 + name: '' + fullyQualifiedCategory: ' .' + fullyQualifiedName: .. + currency: GBP + currentBalance: 0 + type: Unknown + status: Active + isBankAccount: false + modifiedDate: '2023-03-27T14:21:18Z' + sourceModifiedDate: '2022-03-09T16:31:54Z' + validDatatypeLinks: + - property: Id + links: + - DirectCost.LineItems.AccountRef.Id + metadata: + isDeleted: false + - id: c0861a65-c69f-ec11-80f1-0022481b4546 + nominalCode: '10' + name: Account no cat Balance Sheet + fullyQualifiedCategory: ' .' + fullyQualifiedName: ..Account no cat Balance Sheet + currency: GBP + currentBalance: 27.34 + type: Unknown + status: Active + isBankAccount: false + modifiedDate: '2023-03-27T14:21:18Z' + sourceModifiedDate: '2022-09-13T14:45:01Z' + validDatatypeLinks: + - property: Id + links: + - DirectCost.LineItems.AccountRef.Id + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 122 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/accounts?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/accounts + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/accounts?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: ef2fde36-4416-4bc5-b239-315b2929348c + nominalCode: '1300' + name: Debiteuren + description: Debiteuren + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.Debiteuren.PaymentsEnabled + currency: EUR + currentBalance: 864435.44 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:36:17Z' + sourceModifiedDate: '2020-01-08T09:42:54Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - id: 2052b65b-20e9-4da1-85d8-fd5ca0ea3d38 + nominalCode: '888777888' + name: One more AR account + description: One more AR account + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.One more AR account.PaymentsEnabled + currency: EUR + currentBalance: 2174.82 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:36:17Z' + sourceModifiedDate: '2021-06-10T11:00:20Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + pageNumber: 1 + pageSize: 2 + totalResults: 230 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/accounts?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/accounts + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/accounts?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: ca2b96b7-cc45-4e35-9fa3-82a2ba1eec40 + nominalCode: THING + name: Some thing account + description: Some thing account + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.Some thing account.PaymentsEnabled + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:35:15Z' + sourceModifiedDate: '2017-08-01T17:31:12Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - id: cf9572e7-8afa-4339-9113-af32a66d9df9 + nominalCode: '15400' + name: Trade Debtors + description: Trade Debtors + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.Trade Debtors.PaymentsEnabled + currency: GBP + currentBalance: 4484655.39 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:35:15Z' + sourceModifiedDate: '2020-01-08T13:48:38Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + pageNumber: 1 + pageSize: 2 + totalResults: 121 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/accounts?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/accounts + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/accounts?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '601' + nominalCode: '601' + name: Capital Asset Brought Forward + fullyQualifiedCategory: Asset.Capital + fullyQualifiedName: Asset.Capital.Capital Asset Brought Forward + currency: GBP + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-25T14:19:12Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: '605' + nominalCode: '605' + name: Capital Asset Depreciation Brought Forward + fullyQualifiedCategory: Asset.Capital + fullyQualifiedName: Asset.Capital.Capital Asset Depreciation Brought Forward + currency: GBP + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-25T14:19:12Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 292 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/accounts?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/accounts + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/accounts?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '67357' + nominalCode: '1200' + name: Accounts Receivable + fullyQualifiedCategory: Asset + fullyQualifiedName: Asset.Accounts Receivable + currency: GBP + currentBalance: 51445.53 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-24T16:07:24Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: '128611' + nominalCode: 1200-1 + name: Accounts Receivable + fullyQualifiedCategory: Asset.Accounts Receivable + fullyQualifiedName: Asset.Accounts Receivable.Accounts Receivable + currency: GBP + currentBalance: 51445.53 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-24T16:07:24Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 96 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/accounts?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/accounts + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/accounts?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '27840056' + nominalCode: '70700' + name: 16th Account + fullyQualifiedCategory: Asset.BankAccount + fullyQualifiedName: Asset.BankAccount.16th Account + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-09-30T10:29:16Z' + validDatatypeLinks: [] + - id: '27840049' + nominalCode: '70600' + name: 1a1a + fullyQualifiedCategory: Asset.BankAccount + fullyQualifiedName: Asset.BankAccount.1a1a + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-09-30T10:29:16Z' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 157 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/accounts?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/accounts + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/accounts?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '111' + name: Accounts Payable + fullyQualifiedCategory: AcctPay.AcctPay + fullyQualifiedName: AcctPay.AcctPay.Accounts Payable + currentBalance: -635.55 + type: Liability + status: Active + isBankAccount: false + modifiedDate: '2023-01-30T14:48:33Z' + sourceModifiedDate: '2021-08-11T12:51:21' + validDatatypeLinks: [] + - id: '119' + name: Accounts Receivable + fullyQualifiedCategory: AcctRec.AcctRec + fullyQualifiedName: AcctRec.AcctRec.Accounts Receivable + currentBalance: -565 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-01-30T14:48:33Z' + sourceModifiedDate: '2021-09-08T15:23:31' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 44 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/accounts?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/accounts + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/accounts?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 40000-933270541 + nominalCode: '11000' + name: Accounts Receivable + description: Accounts Receivable + fullyQualifiedCategory: Asset.CurrentAsset.AccountsReceivable + fullyQualifiedName: Asset.CurrentAsset.AccountsReceivable.Accounts Receivable + currency: GBP + currentBalance: 93007.93 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T09:06:23Z' + sourceModifiedDate: '2023-12-16T05:06:45' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: 20000-933270541 + nominalCode: '10100' + name: Checking + description: Cash + fullyQualifiedCategory: Asset.CurrentAsset.Bank + fullyQualifiedName: Asset.CurrentAsset.Bank.Checking + currency: GBP + currentBalance: 46954.1 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2023-04-26T09:06:23Z' + sourceModifiedDate: '2023-12-16T05:06:45' + validDatatypeLinks: + - property: Id + links: + - BillLineItem.AccountRef.Id + - BillPayment.AccountRef.Id + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 116 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/accounts?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/accounts + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/accounts?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '62' + nominalCode: '246' + name: Debtors + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors + currency: GBP + currentBalance: 41289.37 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-01-18T11:02:34Z' + sourceModifiedDate: '2022-12-08T15:42:59Z' + validDatatypeLinks: [] + - id: '92' + nominalCode: '247' + name: Debtors - AED + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors - AED + currency: AED + currentBalance: -1533.44 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-01-18T11:02:34Z' + sourceModifiedDate: '2021-02-19T14:04:45Z' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 234 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/accounts?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/accounts + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/accounts?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '70' + name: Debtors + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors + currency: GBP + currentBalance: 3041173.77 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-26T01:18:15Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: '80' + name: Debtors - USD + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors - USD + currency: USD + currentBalance: 54822.37 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-12T15:10:38Z' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 186 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/accounts?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/accounts + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/accounts?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '2864' + nominalCode: '1200' + name: Bank Account + description: Bank Account + fullyQualifiedCategory: Asset.Bank Account + fullyQualifiedName: Asset.Bank Account.Bank Account + type: Asset + status: Archived + isBankAccount: false + modifiedDate: '2022-10-14T09:35:52Z' + validDatatypeLinks: [] + metadata: + isDeleted: true + - id: '2368' + nominalCode: '1200' + name: Bank Current Account + description: Bank Current Account + fullyQualifiedCategory: Asset.Bank Account + fullyQualifiedName: Asset.Bank Account.Bank Current Account + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-10-14T09:35:52Z' + sourceModifiedDate: '2020-09-11T13:53:12Z' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 344 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/accounts?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/accounts + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/accounts?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '1100' + nominalCode: '1100' + name: Debtors Control Account + fullyQualifiedCategory: Asset.CurrentAssets.Debtors + fullyQualifiedName: Asset.CurrentAssets.Debtors.Debtors Control Account + currency: GBP + currentBalance: 90640.61 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: '1102' + nominalCode: '1102' + name: Other Debtors + fullyQualifiedCategory: Asset.CurrentAssets.Debtors + fullyQualifiedName: Asset.CurrentAssets.Debtors.Other Debtors + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 155 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/accounts?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/accounts + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/accounts?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: e5889b459f544926ac5b8e6756df2ad4 + nominalCode: '1560' + name: Abdi Internet Bank + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Abdi Internet Bank + currency: GBP + currentBalance: 49.61 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-27T10:53:26Z' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - id: b17083bc9b2748b4ab321b024e260eda + nominalCode: '147852' + name: Abdi Live Test + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Abdi Live Test + currency: GBP + currentBalance: 225830.75 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-28T14:00:20Z' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + pageNumber: 1 + pageSize: 2 + totalResults: 283 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/accounts?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/accounts + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/accounts?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '2' + nominalCode: '12100' + name: Accounts Receivable + fullyQualifiedCategory: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable' + fullyQualifiedName: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable.Accounts Receivable' + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-04T16:31:51Z' + sourceModifiedDate: '2020-01-29T01:42:43' + validDatatypeLinks: [] + metadata: + isDeleted: false + - id: '155' + nominalCode: '12710' + name: AR - Retainage + fullyQualifiedCategory: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable' + fullyQualifiedName: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable.AR - Retainage' + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-04T16:31:51Z' + sourceModifiedDate: '2020-10-15T15:33:15' + validDatatypeLinks: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 181 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/accounts?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/accounts + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/accounts?page=2&pageSize=2 + Wave: + value: + results: + - id: QWNjb3VudDo5MjIzNDE3NjkzMzk3NjA2MzM7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Abdi Bank + description: Test Balance Sheet + fullyQualifiedCategory: Asset.CashAndBank + fullyQualifiedName: Asset.CashAndBank.Abdi Bank + currency: GBP + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-11-16T18:15:17Z' + validDatatypeLinks: [] + - id: QWNjb3VudDo3OTE3NTA1OTcwOTQxNzQ3MTU7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Cash on Hand + description: Cash you haven�t deposited in the bank. Add your bank and credit card accounts to accurately categorize transactions that aren't cash. + fullyQualifiedCategory: Asset.CashAndBank + fullyQualifiedName: Asset.CashAndBank.Cash on Hand + currency: GBP + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-11-16T18:15:17Z' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 85 + _links: + current: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/accounts?page=1&pageSize=2 + self: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/accounts + next: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/accounts?page=2&pageSize=2 + Xero: + value: + results: + - id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + nominalCode: A090 + name: Business Bank Account + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Business Bank Account + currency: GBP + currentBalance: 924.25 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2023-03-15T20:35:08Z' + sourceModifiedDate: '2023-02-17T11:10:49' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - DirectIncome.LineItems.AccountRef.Id + - DirectCost.LineItems.AccountRef.Id + metadata: + isDeleted: false + - id: a8d6fb1a-8c5d-4683-90ce-bf9d28fc62ba + nominalCode: A091 + name: Business Savings Account + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Business Savings Account + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2023-03-15T20:35:08Z' + sourceModifiedDate: '2023-02-17T11:10:49' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - DirectIncome.LineItems.AccountRef.Id + - DirectCost.LineItems.AccountRef.Id + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 90 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/accounts?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/accounts + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/accounts?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000000352' + nominalCode: '' + name: Accounts Receivable + description: The money that customers owe you becomes the accounts receivable. A good example of this is a payment expected from an invoice sent to your customer. + fullyQualifiedCategory: Asset.accounts_receivable + fullyQualifiedName: Asset.accounts_receivable.Accounts Receivable + currency: GBP + currentBalance: -959.64 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-02-05T14:58:44' + validDatatypeLinks: [] + - id: '104957000000060010' + nominalCode: '' + name: Abdi Test + description: '' + fullyQualifiedCategory: Asset.bank + fullyQualifiedName: Asset.bank.Abdi Test + currency: GBP + currentBalance: 69858.44 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-02-17T12:19:47' + validDatatypeLinks: [] + pageNumber: 1 + pageSize: 2 + totalResults: 68 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/accounts?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/accounts + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/accounts?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/accounts/{accountId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/accountingAccountId' + get: + tags: + - Financial statements + summary: Get account + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAccount' + examples: + Clear Books: + value: + id: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + nominalCode: '610' + name: Accounts Receivable + description: Invoices the business has issued but has not yet collected payment on. + fullyQualifiedCategory: Asset.Current + fullyQualifiedName: Asset.Current.Accounts Receivable + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T12:38:15Z' + sourceModifiedDate: '2022-12-10T16:39:00' + validDatatypeLinks: [] + Dynamics 365 Business Central: + value: + id: 8eaed16d-c69f-ec11-80f1-0022481b4546 + nominalCode: 45422026-68CA-4EF2-9 + name: '' + fullyQualifiedCategory: ' .' + fullyQualifiedName: .. + currency: GBP + currentBalance: 0 + type: Unknown + status: Active + isBankAccount: false + modifiedDate: '2023-03-27T14:21:18Z' + sourceModifiedDate: '2022-03-09T16:31:54Z' + validDatatypeLinks: + - property: Id + links: + - DirectCost.LineItems.AccountRef.Id + Exact (Netherlands): + value: + id: ef2fde36-4416-4bc5-b239-315b2929348c + nominalCode: '1300' + name: Debiteuren + description: Debiteuren + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.Debiteuren.PaymentsEnabled + currency: EUR + currentBalance: 864435.44 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:36:17Z' + sourceModifiedDate: '2020-01-08T09:42:54Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + Exact (UK): + value: + id: ca2b96b7-cc45-4e35-9fa3-82a2ba1eec40 + nominalCode: THING + name: Some thing account + description: Some thing account + fullyQualifiedCategory: Asset.Assets.AccountsReceivable + fullyQualifiedName: Asset.Assets.AccountsReceivable.Some thing account.PaymentsEnabled + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-26T13:35:15Z' + sourceModifiedDate: '2017-08-01T17:31:12Z' + validDatatypeLinks: + - property: Id + links: + - Transfer.To.AccountRef.Id + - Transfer.From.AccountRef.Id + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + FreeAgent: + value: + id: '601' + nominalCode: '601' + name: Capital Asset Brought Forward + fullyQualifiedCategory: Asset.Capital + fullyQualifiedName: Asset.Capital.Capital Asset Brought Forward + currency: GBP + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-25T14:19:12Z' + validDatatypeLinks: [] + FreshBooks: + value: + id: '67357' + nominalCode: '1200' + name: Accounts Receivable + fullyQualifiedCategory: Asset + fullyQualifiedName: Asset.Accounts Receivable + currency: GBP + currentBalance: 51445.53 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-24T16:07:24Z' + validDatatypeLinks: [] + KashFlow: + value: + id: '27840056' + nominalCode: '70700' + name: 16th Account + fullyQualifiedCategory: Asset.BankAccount + fullyQualifiedName: Asset.BankAccount.16th Account + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-09-30T10:29:16Z' + validDatatypeLinks: [] + Oracle NetSuite: + value: + id: '111' + name: Accounts Payable + fullyQualifiedCategory: AcctPay.AcctPay + fullyQualifiedName: AcctPay.AcctPay.Accounts Payable + currentBalance: -635.55 + type: Liability + status: Active + isBankAccount: false + modifiedDate: '2023-01-30T14:48:33Z' + sourceModifiedDate: '2021-08-11T12:51:21' + validDatatypeLinks: [] + QuickBooks Desktop: + value: + id: 40000-933270541 + nominalCode: '11000' + name: Accounts Receivable + description: Accounts Receivable + fullyQualifiedCategory: Asset.CurrentAsset.AccountsReceivable + fullyQualifiedName: Asset.CurrentAsset.AccountsReceivable.Accounts Receivable + currency: GBP + currentBalance: 93007.93 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T09:06:23Z' + sourceModifiedDate: '2023-12-16T05:06:45' + validDatatypeLinks: [] + QuickBooks Online: + value: + id: '62' + nominalCode: '246' + name: Debtors + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors + currency: GBP + currentBalance: 41289.37 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-01-18T11:02:34Z' + sourceModifiedDate: '2022-12-08T15:42:59Z' + validDatatypeLinks: [] + QuickBooks Online Sandbox: + value: + id: '70' + name: Debtors + fullyQualifiedCategory: Asset.Accounts Receivable.AccountsReceivable + fullyQualifiedName: Asset.Accounts Receivable.AccountsReceivable.Debtors + currency: GBP + currentBalance: 3041173.77 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-26T01:18:15Z' + validDatatypeLinks: [] + Sage 200cloud: + value: + id: '2864' + nominalCode: '1200' + name: Bank Account + description: Bank Account + fullyQualifiedCategory: Asset.Bank Account + fullyQualifiedName: Asset.Bank Account.Bank Account + type: Asset + status: Archived + isBankAccount: false + modifiedDate: '2022-10-14T09:35:52Z' + validDatatypeLinks: [] + Sage 50 (UK): + value: + id: '1100' + nominalCode: '1100' + name: Debtors Control Account + fullyQualifiedCategory: Asset.CurrentAssets.Debtors + fullyQualifiedName: Asset.CurrentAssets.Debtors.Debtors Control Account + currency: GBP + currentBalance: 90640.61 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + validDatatypeLinks: [] + Sage Business Cloud Accounting: + value: + id: e5889b459f544926ac5b8e6756df2ad4 + nominalCode: '1560' + name: Abdi Internet Bank + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Abdi Internet Bank + currency: GBP + currentBalance: 49.61 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-27T10:53:26Z' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + Sage Intacct: + value: + id: '2' + nominalCode: '12100' + name: Accounts Receivable + fullyQualifiedCategory: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable' + fullyQualifiedName: 'Assets.Current Assets.Account Receivable, Net of Allowance.Accounts Receivable.Accounts Receivable.Accounts Receivable' + currency: GBP + currentBalance: 0 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2023-04-04T16:31:51Z' + sourceModifiedDate: '2020-01-29T01:42:43' + validDatatypeLinks: [] + Wave: + value: + id: QWNjb3VudDo5MjIzNDE3NjkzMzk3NjA2MzM7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Abdi Bank + description: Test Balance Sheet + fullyQualifiedCategory: Asset.CashAndBank + fullyQualifiedName: Asset.CashAndBank.Abdi Bank + currency: GBP + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2022-11-16T18:15:17Z' + validDatatypeLinks: [] + Xero: + value: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + nominalCode: A090 + name: Business Bank Account + fullyQualifiedCategory: Asset.Bank + fullyQualifiedName: Asset.Bank.Business Bank Account + currency: GBP + currentBalance: 924.25 + type: Asset + status: Active + isBankAccount: true + modifiedDate: '2023-03-15T20:35:08Z' + sourceModifiedDate: '2023-02-17T11:10:49' + validDatatypeLinks: + - property: Id + links: + - Payment.AccountRef.Id + - BillPayment.AccountRef.Id + - DirectIncome.LineItems.AccountRef.Id + - DirectCost.LineItems.AccountRef.Id + Zoho Books: + value: + id: '104957000000000352' + nominalCode: '' + name: Accounts Receivable + description: The money that customers owe you becomes the accounts receivable. A good example of this is a payment expected from an invoice sent to your customer. + fullyQualifiedCategory: Asset.accounts_receivable + fullyQualifiedName: Asset.accounts_receivable.Accounts Receivable + currency: GBP + currentBalance: -959.64 + type: Asset + status: Active + isBankAccount: false + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-02-05T14:58:44' + validDatatypeLinks: [] + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get account* endpoint returns a single account for a given accountId. + + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-account + x-speakeasy-group: financial-statements.accounts + '/companies/{companyId}/data/billCreditNotes': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + summary: List bill credit notes + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBillCreditNotes' + examples: + Dynamics 365 Business Central: + value: + results: + - id: 0deaed0a-9f51-eb11-89f9-00224800af18 + billCreditNoteNumber: '109001' + supplierRef: + id: be1217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: 'Fabrikam, Inc.' + withholdingTax: [] + totalAmount: 8 + totalDiscount: 0 + subTotal: 8 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 8 + status: Submitted + issueDate: '2020-12-21T00:00:00' + currency: GBP + lineItems: + - description: Abdi Item No VAT + unitAmount: 8 + quantity: 1 + discountAmount: 0 + subTotal: 8 + taxAmount: 0 + totalAmount: 8 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + discountPercentage: 0 + taxRateRef: + id: 6bbc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for EXPORT / ZERO + effectiveTaxRate: 0 + itemRef: + id: ITEM-dbc37b18-4209-eb11-bbf6-0022481ad2e8-EXPORT-EXPORT + name: 'Abdi Item No VAT / General Business Posting Group: ''EXPORT'' / VAT Business Posting Group: ''EXPORT''' + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2023-03-27T14:21:26Z' + metadata: + isDeleted: false + note: BCN001 + - id: 157c025f-a19e-eb11-8ce6-0022481a7bed + billCreditNoteNumber: '109002' + supplierRef: + id: be1217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: 'Fabrikam, Inc.' + withholdingTax: [] + totalAmount: 20 + totalDiscount: 0 + subTotal: 20 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 10 + status: PartiallyPaid + issueDate: '2021-01-26T00:00:00' + currency: GBP + lineItems: + - description: Abdi Item No VAT + unitAmount: 20 + quantity: 1 + discountAmount: 0 + subTotal: 20 + taxAmount: 0 + totalAmount: 20 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + discountPercentage: 0 + taxRateRef: + id: 6bbc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for EXPORT / ZERO + effectiveTaxRate: 0 + itemRef: + id: ITEM-dbc37b18-4209-eb11-bbf6-0022481ad2e8-EXPORT-EXPORT + name: 'Abdi Item No VAT / General Business Posting Group: ''EXPORT'' / VAT Business Posting Group: ''EXPORT''' + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 257c025f-a19e-eb11-8ce6-0022481a7bed + note: Credit Memo 1002 + reference: '109002' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-26T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-04-16T00:00:00' + totalAmount: 10 + modifiedDate: '2023-03-27T14:21:26Z' + metadata: + isDeleted: false + note: '16042021' + pageNumber: 1 + pageSize: 2 + totalResults: 224 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billCreditNotes + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billCreditNotes?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 443bd109-e1ed-4de2-b1ab-3b13e980d288 + billCreditNoteNumber: '19600007' + supplierRef: + id: 5e6f49b9-6489-4b82-83e7-291d308919bb + supplierName: Mickey Mouse + withholdingTax: [] + totalAmount: 12.1 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 2.1 + discountPercentage: 0 + remainingCredit: 12.1 + status: Submitted + issueDate: '2019-12-16T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Cheesecake + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + accountRef: + id: 5f139759-b554-4314-862e-b9d88e5b2e1b + name: Af te dragen loonheffing + taxRateRef: + id: 84277189-ad16-456c-b501-ca31f0a483cc + name: BTW prive gebruik + effectiveTaxRate: 21 + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-03T15:06:19Z' + - id: 6643f559-d7e9-4cfe-802f-60beddbc4ed9 + billCreditNoteNumber: '20600003' + supplierRef: + id: f87070e2-bbd7-4383-a7c9-824748c1d70e + supplierName: Exact Software Nederland B.V. + withholdingTax: [] + totalAmount: 13.57 + totalDiscount: 0 + subTotal: 13.57 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 13.57 + status: Submitted + issueDate: '2020-01-20T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: 1 transactions of type CARD_PAYMENT_FEE_REFUND + unitAmount: 13.57 + quantity: 1 + discountAmount: 0 + subTotal: 13.57 + totalAmount: 13.57 + accountRef: + id: f6c251f5-21d0-4164-9b8f-17789fd2fee9 + name: Kosten werkgeverslasten vakantiegeld + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-20T19:38:37Z' + pageNumber: 1 + pageSize: 2 + totalResults: 42 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billCreditNotes + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billCreditNotes?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: f9083d38-40c7-4b5f-a693-f4670e3d85bc + billCreditNoteNumber: '19600008' + supplierRef: + id: 1c703cce-967c-4476-a86a-32e35341a8f5 + supplierName: Customer Bill Supplier + withholdingTax: [] + totalAmount: 99999 + totalDiscount: 0 + subTotal: 99999 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 99999 + status: Submitted + issueDate: '2019-10-30T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Oil Change + unitAmount: -150 + quantity: 1000.5 + discountAmount: 0 + subTotal: -150075 + totalAmount: -150075 + accountRef: + id: 885ff551-664d-451b-995b-cb114c9877d0 + name: Unallocated Cash + itemRef: + id: '3001' + trackingCategoryRefs: [] + - description: description + unitAmount: 250074 + quantity: 1 + discountAmount: 0 + subTotal: 250074 + totalAmount: 250074 + accountRef: + id: 885ff551-664d-451b-995b-cb114c9877d0 + name: Unallocated Cash + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:33:23Z' + sourceModifiedDate: '2019-10-30T13:12:56Z' + - id: 05023688-5bd5-4034-ae4c-5e3e5099bbfb + billCreditNoteNumber: '19600009' + supplierRef: + id: 1c703cce-967c-4476-a86a-32e35341a8f5 + supplierName: Customer Bill Supplier + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 10 + status: Submitted + issueDate: '2019-11-01T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Credit note line item #5' + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + totalAmount: 10 + accountRef: + id: 62be6536-f4ea-49b8-9797-1adc23982334 + name: Depreciation + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:33:23Z' + sourceModifiedDate: '2019-11-01T15:07:18Z' + pageNumber: 1 + pageSize: 2 + totalResults: 40 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billCreditNotes + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billCreditNotes?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '10665024' + billCreditNoteNumber: Bill Credit + supplierRef: + id: '6161941' + supplierName: A & J Fabtech Ltd + withholdingTax: [] + totalAmount: 1500 + totalDiscount: 0 + subTotal: 1250 + totalTaxAmount: 250 + discountPercentage: 0 + remainingCredit: 1500 + status: Submitted + issueDate: '2018-08-22T00:00:00' + currency: GBP + lineItems: + - description: A & J Fabtech Ltd - Bill Credit Note Bill Credit + unitAmount: 1250 + quantity: 1 + taxAmount: 250 + totalAmount: 1500 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2018-08-22T13:22:08Z' + metadata: + isDeleted: false + - id: '11007024' + billCreditNoteNumber: Draft test + supplierRef: + id: '6161963' + supplierName: ABB Ltd + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 8.33 + totalTaxAmount: 1.67 + discountPercentage: 0 + remainingCredit: 10 + status: Submitted + issueDate: '2018-10-17T00:00:00' + currency: GBP + lineItems: + - description: ABB Ltd - Bill Credit Note Draft test + unitAmount: 8.33 + quantity: 1 + taxAmount: 1.67 + totalAmount: 10 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2018-10-17T12:56:54Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 45 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billCreditNotes + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billCreditNotes?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '91339087' + billCreditNoteNumber: '5' + supplierRef: + id: '6202387' + supplierName: Dell + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2020-02-25T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Oil refund + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: '21481832' + name: Oil + itemRef: + id: '114817740' + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-09-30T10:29:16Z' + - id: '91341939' + billCreditNoteNumber: '6' + supplierRef: + id: '6202387' + supplierName: Dell + withholdingTax: [] + totalAmount: 240 + totalDiscount: 0 + subTotal: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2020-02-25T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: -200 + quantity: -1 + subTotal: 200 + taxAmount: -40 + totalAmount: 240 + accountRef: + id: '21481820' + name: Materials purchased + itemRef: + id: '114821376' + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-09-30T10:29:16Z' + pageNumber: 1 + pageSize: 2 + totalResults: 8 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/billCreditNotes + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/billCreditNotes?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '1781' + billCreditNoteNumber: VENDCRED1 + supplierRef: + id: '749' + supplierName: Jo's Cheese + withholdingTax: [] + totalAmount: 174.6 + totalDiscount: 0 + subTotal: 145.5 + totalTaxAmount: 29.1 + discountPercentage: 0 + remainingCredit: 174.6 + status: Submitted + issueDate: '2021-11-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: billcredit_test + unitAmount: 145.5 + quantity: 1 + unitOfMeasurement: pack + subTotal: 145.5 + totalAmount: 145.5 + accountRef: + id: '713' + name: Inventory Asset + trackingCategoryRefs: + - id: department-1 + - id: location-1 + tracking: + categoryRefs: + - id: department-1 + - id: location-1 + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2022-09-20T08:16:22Z' + sourceModifiedDate: '2021-11-02T19:58:58' + note: Codat1 + - id: '1782' + billCreditNoteNumber: VENDCRED2 + supplierRef: + id: '749' + supplierName: Jo's Cheese + withholdingTax: [] + totalAmount: 642.3 + totalDiscount: 0 + subTotal: 535.25 + totalTaxAmount: 107.05 + discountPercentage: 0 + remainingCredit: 342.3 + status: PartiallyPaid + issueDate: '2021-11-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Cheese + unitAmount: 400 + quantity: 1 + unitOfMeasurement: pack + subTotal: 400 + totalAmount: 400 + accountRef: + id: '714' + name: Cost of Goods Sold + createdFromLineRef: + id: '7462' + dataType: bills + lineNumber: '1' + trackingCategoryRefs: + - id: location-1 + tracking: + categoryRefs: + - id: location-1 + isBilledTo: Unknown + isRebilledTo: Unknown + - description: double cream + unitAmount: 100 + quantity: 1 + subTotal: 100 + totalAmount: 100 + accountRef: + id: '714' + name: Cost of Goods Sold + trackingCategoryRefs: + - id: location-1 + tracking: + categoryRefs: + - id: location-1 + isBilledTo: Unknown + isRebilledTo: Unknown + - description: '' + unitAmount: 35.25 + quantity: 1 + subTotal: 35.25 + totalAmount: 35.25 + accountRef: + id: '54' + name: Sales + itemRef: + id: '128' + name: Test Item + trackingCategoryRefs: + - id: location-1 + tracking: + categoryRefs: + - id: location-1 + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: + - payment: + id: '1782' + note: Codat1 + reference: Bill Credit 02/11/2021 + currency: GBP + currencyRate: 1 + paidOnDate: '2021-11-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 300 + createdFromRefs: + - id: '7462' + dataType: bills + modifiedDate: '2022-09-20T08:16:22Z' + sourceModifiedDate: '2021-11-03T18:27:14' + note: Codat1 + pageNumber: 1 + pageSize: 2 + totalResults: 16 + _links: + current: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/billCreditNotes + next: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/billCreditNotes?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 6D2C-1197698059 + billCreditNoteNumber: Return + supplierRef: + id: E0000-933272656 + supplierName: Timberloft Lumber + withholdingTax: [] + totalAmount: 475 + totalDiscount: 0 + subTotal: 475 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 475 + status: Submitted + issueDate: '2024-10-30T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Lumber:Rough - Rough lumber' + unitAmount: 475 + quantity: 0 + discountAmount: 0 + subTotal: 475 + taxAmount: 0 + totalAmount: 475 + discountPercentage: 0 + itemRef: + id: 1C0000-933272656 + name: 'Lumber:Rough' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: + - payment: + id: 6D2C-1197698059 + reference: Return + currency: GBP + currencyRate: 1 + paidOnDate: '2024-10-30T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 475 + modifiedDate: '2023-04-26T09:12:30Z' + sourceModifiedDate: '2023-12-16T05:06:19' + metadata: + isDeleted: false + - id: F3A-933787869 + billCreditNoteNumber: CR-1098 + supplierRef: + id: 80000-933272656 + supplierName: Sloan Roofing + withholdingTax: [] + totalAmount: 850 + totalDiscount: 0 + subTotal: 850 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 850 + status: Submitted + issueDate: '2024-12-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Subs:Roofing - Roofing' + unitAmount: 850 + quantity: 0 + discountAmount: 0 + subTotal: 850 + taxAmount: 0 + totalAmount: 850 + discountPercentage: 0 + itemRef: + id: D0000-933272656 + name: 'Subs:Roofing' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: + - payment: + id: F3A-933787869 + reference: CR-1098 + currency: GBP + currencyRate: 1 + paidOnDate: '2024-12-12T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 850 + modifiedDate: '2023-04-26T09:12:30Z' + sourceModifiedDate: '2023-12-16T05:05:03' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billCreditNotes + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billCreditNotes?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '19' + billCreditNoteNumber: '19' + supplierRef: + id: '4' + supplierName: BILLy elliot + withholdingTax: [] + totalAmount: 5 + totalDiscount: 0 + subTotal: 5 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: + - payment: + id: '20' + currency: GBP + currencyRate: 1 + paidOnDate: '2019-05-13T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 5 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2019-05-13T13:14:06Z' + - id: '677' + billCreditNoteNumber: '677' + supplierRef: + id: '4' + supplierName: BILLy elliot + withholdingTax: [] + totalAmount: 5 + totalDiscount: 0 + subTotal: 5 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2020-03-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: + - payment: + id: '678' + note: payment note test + currency: GBP + currencyRate: 1 + paidOnDate: '2020-03-23T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 5 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2020-03-23T10:44:06Z' + note: Codat Note field + pageNumber: 1 + pageSize: 2 + totalResults: 11 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billCreditNotes + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billCreditNotes?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '424' + billCreditNoteNumber: '424' + supplierRef: + id: '24' + supplierName: Brijesh Jain + withholdingTax: [] + totalAmount: 69 + totalDiscount: 0 + subTotal: 69 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 69 + status: Submitted + issueDate: '2019-06-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refund of iZettle Fees + unitAmount: 69 + quantity: 1 + subTotal: 69 + taxAmount: 0 + totalAmount: 69 + accountRef: + id: '30' + name: Janitorial Expense + taxRateRef: + id: 20_Bills + name: 5.0% RC CIS Bills + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: [] + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2019-06-20T15:48:50Z' + metadata: + isDeleted: false + - id: '455' + billCreditNoteNumber: '455' + supplierRef: + id: '53' + supplierName: Bank of AnyCity + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-06-26T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: a + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: '11' + name: Ask My Accountant + taxRateRef: + id: 20_Bills + name: 5.0% RC CIS Bills + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: + - payment: + id: '530' + reference: '4' + accountRef: + id: '100' + name: Savings2 + currency: GBP + currencyRate: 1 + paidOnDate: '2019-07-16T00:00:00' + totalAmount: 170 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 10 + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2019-07-16T09:49:14Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 26 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billCreditNotes + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billCreditNotes?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '45391' + billCreditNoteNumber: Return 1 + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + withholdingTax: [] + totalAmount: 120 + totalDiscount: 2.5 + subTotal: 100 + totalTaxAmount: 20 + discountPercentage: 2.5 + remainingCredit: 109.5 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + allocatedOnDate: '2020-01-20T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0.5 + subTotal: 0 + taxAmount: 20 + totalAmount: 20 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 2.5 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '45391' + note: ret1 + reference: Return 1 + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.5 + modifiedDate: '2022-10-14T09:35:52Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: ret1 + - id: '45421' + billCreditNoteNumber: Return 2 + supplierRef: + id: QUA001 + supplierName: Quality Motors + withholdingTax: [] + totalAmount: 60 + totalDiscount: 1.25 + subTotal: 50 + totalTaxAmount: 10 + discountPercentage: 2.5 + remainingCredit: 60 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + allocatedOnDate: '2020-02-03T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0.25 + subTotal: 0 + taxAmount: 10 + totalAmount: 10 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 1.25 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-14T09:35:52Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: ret2 + pageNumber: 1 + pageSize: 2 + totalResults: 21 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billCreditNotes + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billCreditNotes?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '20' + billCreditNoteNumber: O/BAL + supplierRef: + id: NEW001 + supplierName: Newtown Builders Ltd + withholdingTax: [] + totalAmount: 0.01 + totalDiscount: 0 + subTotal: 0.01 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0.01 + status: Submitted + issueDate: '2021-12-31T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Opening Balance + unitAmount: 0.01 + quantity: 1 + subTotal: 0.01 + taxAmount: 0 + totalAmount: 0.01 + accountRef: + id: '9998' + name: Suspense Account + taxRateRef: + id: '9' + name: Non-Vatable Tax Code + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: department_0 + name: Default + tracking: + categoryRefs: + - id: department_0 + name: Default + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + note: Opening Balance + - id: '323' + billCreditNoteNumber: Return + supplierRef: + id: UNI001 + supplierName: Unique Systems + withholdingTax: [] + totalAmount: 103.4 + totalDiscount: 0 + subTotal: 88 + totalTaxAmount: 15.4 + discountPercentage: 0 + remainingCredit: 103.4 + status: Submitted + issueDate: '2022-02-28T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Returned Goods, damaged' + unitAmount: 103.4 + quantity: 1 + subTotal: 88 + taxAmount: 15.4 + totalAmount: 103.4 + accountRef: + id: '5000' + name: Materials Purchased + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_0 + name: Default + tracking: + categoryRefs: + - id: department_0 + name: Default + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + note: 'Returned Goods, damaged' + pageNumber: 1 + pageSize: 2 + totalResults: 12 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billCreditNotes + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billCreditNotes?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: b6c6fce9866849b0b44cac99ab7dc579 + billCreditNoteNumber: Supplier credit note + supplierRef: + id: ec716559789111e8aaa5027d54329956 + supplierName: Bagels Limited + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2018-11-23T00:00:00' + currency: USD + currencyRate: 0.776970973 + lineItems: + - description: Consulting services + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + discountPercentage: 0 + taxRateRef: + id: GB_ZERO + name: Zero Rated 0.00% + effectiveTaxRate: 0 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: bf6496aaf0294883b27c423ce8266113 + note: Supplier refund using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: USD + currencyRate: 0.771449236 + paidOnDate: '2019-11-19T00:00:00' + totalAmount: -10 + allocation: + currency: USD + currencyRate: 1 + totalAmount: 10 + modifiedDate: '2022-10-24T14:53:32Z' + sourceModifiedDate: '2019-11-19T14:17:32Z' + - id: 23d866f6367d4f11956a36a71e47bc37 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + withholdingTax: [] + totalAmount: 60 + totalDiscount: 0 + subTotal: 50 + totalTaxAmount: 10 + discountPercentage: 0 + remainingCredit: 60 + status: Submitted + issueDate: '2019-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 10 + quantity: 5 + discountAmount: 0 + subTotal: 50 + taxAmount: 10 + totalAmount: 60 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-24T14:53:32Z' + sourceModifiedDate: '2020-07-16T15:00:36Z' + pageNumber: 1 + pageSize: 2 + totalResults: 747 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billCreditNotes + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billCreditNotes?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '3359' + billCreditNoteNumber: APADJ0001 + supplierRef: + id: '3' + supplierName: ADP + withholdingTax: [] + totalAmount: 12 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 2 + discountPercentage: 0 + remainingCredit: 12 + status: Submitted + issueDate: '2021-09-20T00:00:00' + currency: USD + currencyRate: 0.7283 + lineItems: + - description: No Description Provided + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 1 + totalAmount: 6 + accountRef: + id: '197' + name: Software and Licenses + taxRateRef: + id: '47' + name: EC Purchase Goods Standard Rate Input + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + tracking: + categoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + isBilledTo: Unknown + isRebilledTo: Unknown + - description: No Description Provided + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 1 + totalAmount: 6 + accountRef: + id: '197' + name: Software and Licenses + taxRateRef: + id: '47' + name: EC Purchase Goods Standard Rate Input + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + tracking: + categoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2022-10-28T11:10:22Z' + sourceModifiedDate: '2021-09-20T13:50:16' + note: '' + - id: '3399' + billCreditNoteNumber: APADJ0002 + supplierRef: + id: '3' + supplierName: ADP + withholdingTax: [] + totalAmount: 360 + totalDiscount: 0 + subTotal: 300 + totalTaxAmount: 60 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2021-09-24T00:00:00' + allocatedOnDate: '2021-09-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: No Description Provided + unitAmount: 300 + quantity: 1 + subTotal: 300 + taxAmount: 60 + totalAmount: 360 + accountRef: + id: '197' + name: Software and Licenses + taxRateRef: + id: '81' + name: UK Purchase Goods Standard Rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + tracking: + categoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2022-10-28T11:10:22Z' + sourceModifiedDate: '2021-09-29T13:34:47' + note: '' + pageNumber: 1 + pageSize: 2 + totalResults: 82 + _links: + current: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/data/billCreditNotes + next: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/data/billCreditNotes?page=2&pageSize=2 + Xero: + value: + results: + - id: ee8bec08-2be8-40ba-acd0-d53d5df11235 + billCreditNoteNumber: RPT429-1 + supplierRef: + id: 3a0d40a2-2698-4cf5-b7b2-30133c632ab6 + supplierName: Swanston Security + withholdingTax: [] + totalAmount: 25.44 + totalDiscount: 0 + subTotal: 25.44 + totalTaxAmount: 4.24 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-12-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refund as agreed due to window break when guard absent + unitAmount: 21.2 + quantity: 1 + discountAmount: 0 + subTotal: 21.2 + taxAmount: 4.24 + totalAmount: 25.44 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + discountPercentage: 0 + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: ee8bec08-2be8-40ba-acd0-d53d5df11235 + reference: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-12T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-12T00:00:00' + totalAmount: 25.44 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2011-04-07T07:26:30' + metadata: + isDeleted: false + - id: 7d1f4e11-e909-43b0-901c-2c824dff1e82 + billCreditNoteNumber: 720-2 + supplierRef: + id: cf8fa320-a527-496c-823e-22dd069d29e6 + supplierName: PC Complete + withholdingTax: [] + totalAmount: 270.36 + totalDiscount: 0 + subTotal: 270.36 + totalTaxAmount: 45.06 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-12-16T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Unable to supply DVD writer for laptop + unitAmount: 225.3 + quantity: 1 + discountAmount: 0 + subTotal: 225.3 + taxAmount: 45.06 + totalAmount: 270.36 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + discountPercentage: 0 + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 7d1f4e11-e909-43b0-901c-2c824dff1e82 + reference: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-16T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-16T00:00:00' + totalAmount: 270.36 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2011-04-06T21:00:33' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/billCreditNotes?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/billCreditNotes + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List bill credit notes* endpoint returns a list of [bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote) for a given company's connection.\n\n[Bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-bill-credit-notes + x-speakeasy-group: accounts-payable.bill-credit-notes + '/companies/{companyId}/data/billCreditNotes/{billCreditNoteId}': + parameters: + - $ref: '#/components/parameters/companyId' + - name: billCreditNoteId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a bill credit note. + get: + tags: + - Accounts payable + summary: Get bill credit note + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBillCreditNote' + examples: + Dynamics 365 Business Central: + value: + id: 0deaed0a-9f51-eb11-89f9-00224800af18 + billCreditNoteNumber: '109001' + supplierRef: + id: be1217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: 'Fabrikam, Inc.' + withholdingTax: [] + totalAmount: 8 + totalDiscount: 0 + subTotal: 8 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 8 + status: Submitted + issueDate: '2020-12-21T00:00:00' + currency: GBP + lineItems: + - description: Abdi Item No VAT + unitAmount: 8 + quantity: 1 + discountAmount: 0 + subTotal: 8 + taxAmount: 0 + totalAmount: 8 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + discountPercentage: 0 + taxRateRef: + id: 6bbc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for EXPORT / ZERO + effectiveTaxRate: 0 + itemRef: + id: ITEM-dbc37b18-4209-eb11-bbf6-0022481ad2e8-EXPORT-EXPORT + name: 'Abdi Item No VAT / General Business Posting Group: ''EXPORT'' / VAT Business Posting Group: ''EXPORT''' + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2023-03-27T14:21:26Z' + metadata: + isDeleted: false + note: BCN001 + Exact (Netherlands): + value: + id: 443bd109-e1ed-4de2-b1ab-3b13e980d288 + billCreditNoteNumber: '19600007' + supplierRef: + id: 5e6f49b9-6489-4b82-83e7-291d308919bb + supplierName: Mickey Mouse + withholdingTax: [] + totalAmount: 12.1 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 2.1 + discountPercentage: 0 + remainingCredit: 12.1 + status: Submitted + issueDate: '2019-12-16T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Cheesecake + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + accountRef: + id: 5f139759-b554-4314-862e-b9d88e5b2e1b + name: Af te dragen loonheffing + taxRateRef: + id: 84277189-ad16-456c-b501-ca31f0a483cc + name: BTW prive gebruik + effectiveTaxRate: 21 + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-03T15:06:19Z' + Exact (UK): + value: + id: f9083d38-40c7-4b5f-a693-f4670e3d85bc + billCreditNoteNumber: '19600008' + supplierRef: + id: 1c703cce-967c-4476-a86a-32e35341a8f5 + supplierName: Customer Bill Supplier + withholdingTax: [] + totalAmount: 99999 + totalDiscount: 0 + subTotal: 99999 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 99999 + status: Submitted + issueDate: '2019-10-30T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Oil Change + unitAmount: -150 + quantity: 1000.5 + discountAmount: 0 + subTotal: -150075 + totalAmount: -150075 + accountRef: + id: 885ff551-664d-451b-995b-cb114c9877d0 + name: Unallocated Cash + itemRef: + id: '3001' + trackingCategoryRefs: [] + - description: description + unitAmount: 250074 + quantity: 1 + discountAmount: 0 + subTotal: 250074 + totalAmount: 250074 + accountRef: + id: 885ff551-664d-451b-995b-cb114c9877d0 + name: Unallocated Cash + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-10-26T13:33:23Z' + sourceModifiedDate: '2019-10-30T13:12:56Z' + FreeAgent: + value: + id: '10665024' + billCreditNoteNumber: Bill Credit + supplierRef: + id: '6161941' + supplierName: A & J Fabtech Ltd + withholdingTax: [] + totalAmount: 1500 + totalDiscount: 0 + subTotal: 1250 + totalTaxAmount: 250 + discountPercentage: 0 + remainingCredit: 1500 + status: Submitted + issueDate: '2018-08-22T00:00:00' + currency: GBP + lineItems: + - description: A & J Fabtech Ltd - Bill Credit Note Bill Credit + unitAmount: 1250 + quantity: 1 + taxAmount: 250 + totalAmount: 1500 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2018-08-22T13:22:08Z' + metadata: + isDeleted: false + KashFlow: + value: + id: '91339087' + billCreditNoteNumber: '5' + supplierRef: + id: '6202387' + supplierName: Dell + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2020-02-25T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Oil refund + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: '21481832' + name: Oil + itemRef: + id: '114817740' + trackingCategoryRefs: [] + paymentAllocations: [] + modifiedDate: '2022-09-30T10:29:16Z' + Oracle NetSuite: + value: + id: '1781' + billCreditNoteNumber: VENDCRED1 + supplierRef: + id: '749' + supplierName: Jo's Cheese + withholdingTax: [] + totalAmount: 174.6 + totalDiscount: 0 + subTotal: 145.5 + totalTaxAmount: 29.1 + discountPercentage: 0 + remainingCredit: 174.6 + status: Submitted + issueDate: '2021-11-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: billcredit_test + unitAmount: 145.5 + quantity: 1 + unitOfMeasurement: pack + subTotal: 145.5 + totalAmount: 145.5 + accountRef: + id: '713' + name: Inventory Asset + createdFromLineRef: + id: '1432' + dataType: bills + lineNumber: '1' + trackingCategoryRefs: + - id: department-1 + - id: location-1 + tracking: + categoryRefs: + - id: department-1 + - id: location-1 + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + createdFromRefs: + - id: '1432' + dataType: bills + modifiedDate: '2022-09-20T08:16:22Z' + sourceModifiedDate: '2021-11-02T19:58:58' + note: Codat1 + QuickBooks Desktop: + value: + id: 6D2C-1197698059 + billCreditNoteNumber: Return + supplierRef: + id: E0000-933272656 + supplierName: Timberloft Lumber + withholdingTax: [] + totalAmount: 475 + totalDiscount: 0 + subTotal: 475 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 475 + status: Submitted + issueDate: '2024-10-30T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Lumber:Rough - Rough lumber' + unitAmount: 475 + quantity: 0 + discountAmount: 0 + subTotal: 475 + taxAmount: 0 + totalAmount: 475 + discountPercentage: 0 + itemRef: + id: 1C0000-933272656 + name: 'Lumber:Rough' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: + - payment: + id: 6D2C-1197698059 + reference: Return + currency: GBP + currencyRate: 1 + paidOnDate: '2024-10-30T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 475 + modifiedDate: '2023-04-26T09:12:30Z' + sourceModifiedDate: '2023-12-16T05:06:19' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '19' + billCreditNoteNumber: '19' + supplierRef: + id: '4' + supplierName: BILLy elliot + withholdingTax: [] + totalAmount: 5 + totalDiscount: 0 + subTotal: 5 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: + - payment: + id: '20' + currency: GBP + currencyRate: 1 + paidOnDate: '2019-05-13T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 5 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2019-05-13T13:14:06Z' + QuickBooks Online Sandbox: + value: + id: '424' + billCreditNoteNumber: '424' + supplierRef: + id: '24' + supplierName: Brijesh Jain + withholdingTax: [] + totalAmount: 69 + totalDiscount: 0 + subTotal: 69 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 69 + status: Submitted + issueDate: '2019-06-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refund of iZettle Fees + unitAmount: 69 + quantity: 1 + subTotal: 69 + taxAmount: 0 + totalAmount: 69 + accountRef: + id: '30' + name: Janitorial Expense + taxRateRef: + id: 20_Bills + name: 5.0% RC CIS Bills + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + paymentAllocations: [] + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2019-06-20T15:48:50Z' + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '45391' + billCreditNoteNumber: Return 1 + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + withholdingTax: [] + totalAmount: 120 + totalDiscount: 2.5 + subTotal: 100 + totalTaxAmount: 20 + discountPercentage: 2.5 + remainingCredit: 109.5 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + allocatedOnDate: '2020-01-20T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0.5 + subTotal: 0 + taxAmount: 20 + totalAmount: 20 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 2.5 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '45391' + note: ret1 + reference: Return 1 + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.5 + modifiedDate: '2022-10-14T09:35:52Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: ret1 + Sage 50 (UK): + value: + id: '20' + billCreditNoteNumber: O/BAL + supplierRef: + id: NEW001 + supplierName: Newtown Builders Ltd + withholdingTax: [] + totalAmount: 0.01 + totalDiscount: 0 + subTotal: 0.01 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0.01 + status: Submitted + issueDate: '2021-12-31T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Opening Balance + unitAmount: 0.01 + quantity: 1 + subTotal: 0.01 + taxAmount: 0 + totalAmount: 0.01 + accountRef: + id: '9998' + name: Suspense Account + taxRateRef: + id: '9' + name: Non-Vatable Tax Code + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: department_0 + name: Default + tracking: + categoryRefs: + - id: department_0 + name: Default + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + note: Opening Balance + Sage Business Cloud Accounting: + value: + id: b6c6fce9866849b0b44cac99ab7dc579 + billCreditNoteNumber: Supplier credit note + supplierRef: + id: ec716559789111e8aaa5027d54329956 + supplierName: Bagels Limited + withholdingTax: [] + totalAmount: 10 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2018-11-23T00:00:00' + currency: USD + currencyRate: 0.776970973 + lineItems: + - description: Consulting services + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + discountPercentage: 0 + taxRateRef: + id: GB_ZERO + name: Zero Rated 0.00% + effectiveTaxRate: 0 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: bf6496aaf0294883b27c423ce8266113 + note: Supplier refund using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: USD + currencyRate: 0.771449236 + paidOnDate: '2019-11-19T00:00:00' + totalAmount: -10 + allocation: + currency: USD + currencyRate: 1 + totalAmount: 10 + modifiedDate: '2022-10-24T14:53:32Z' + sourceModifiedDate: '2019-11-19T14:17:32Z' + Sage Intacct: + value: + id: '3359' + billCreditNoteNumber: APADJ0001 + supplierRef: + id: '3' + supplierName: ADP + withholdingTax: [] + totalAmount: 12 + totalDiscount: 0 + subTotal: 10 + totalTaxAmount: 2 + discountPercentage: 0 + remainingCredit: 12 + status: Submitted + issueDate: '2021-09-20T00:00:00' + currency: USD + currencyRate: 0.7283 + lineItems: + - description: No Description Provided + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 1 + totalAmount: 6 + accountRef: + id: '197' + name: Software and Licenses + taxRateRef: + id: '47' + name: EC Purchase Goods Standard Rate Input + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + tracking: + categoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + isBilledTo: Unknown + isRebilledTo: Unknown + - description: No Description Provided + unitAmount: 5 + quantity: 1 + subTotal: 5 + taxAmount: 1 + totalAmount: 6 + accountRef: + id: '197' + name: Software and Licenses + taxRateRef: + id: '47' + name: EC Purchase Goods Standard Rate Input + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + tracking: + categoryRefs: + - id: LOCATION-8 + name: United Kingdom + - id: SUPPLIER-3 + name: ADP + isBilledTo: Unknown + isRebilledTo: Unknown + paymentAllocations: [] + modifiedDate: '2022-10-28T11:10:22Z' + sourceModifiedDate: '2021-09-20T13:50:16' + note: '' + Xero: + value: + id: ee8bec08-2be8-40ba-acd0-d53d5df11235 + billCreditNoteNumber: RPT429-1 + supplierRef: + id: 3a0d40a2-2698-4cf5-b7b2-30133c632ab6 + supplierName: Swanston Security + withholdingTax: [] + totalAmount: 25.44 + totalDiscount: 0 + subTotal: 25.44 + totalTaxAmount: 4.24 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-12-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refund as agreed due to window break when guard absent + unitAmount: 21.2 + quantity: 1 + discountAmount: 0 + subTotal: 21.2 + taxAmount: 4.24 + totalAmount: 25.44 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + discountPercentage: 0 + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: ee8bec08-2be8-40ba-acd0-d53d5df11235 + reference: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-12T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-12T00:00:00' + totalAmount: 25.44 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2011-04-07T07:26:30' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get bill credit note* endpoint returns a single bill credit note for a given billCreditNoteId. + + [Bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-bill-credit-note + x-speakeasy-group: accounts-payable.bill-credit-notes + '/companies/{companyId}/data/billPayments': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + summary: List bill payments + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBillPayments' + examples: + Clear Books: + value: + results: + - id: dcb18480-8b69-44d8-aa26-268b6a80d170 + supplierRef: + id: 8GeHBdBZiZ + supplierName: 'DuBuque, Goyette and Franecki' + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + totalAmount: 71351.42 + currency: GBP + currencyRate: 1 + date: '2022-05-06T00:00:00' + note: Bill Payment against bill 81539597-e681-40c9-a4dd-ec2fffcde572 + paymentMethodRef: + id: cb4a5647-aa86-40ab-bb4f-158acaa99c12 + name: Check payments-u4p + lines: + - amount: 71351.42 + links: + - type: Bill + id: 81539597-e681-40c9-a4dd-ec2fffcde572 + amount: -71351.42 + currencyRate: 1 + allocatedOnDate: '2022-05-06T00:00:00' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-05-06T00:00:00' + metadata: + isDeleted: false + - id: ca0976d0-036d-4187-ab66-7169286b007d + supplierRef: + id: 9efd64dc-4b31-425d-9eb2-7c7773593713 + supplierName: 'Jacobson, Konopelski and Heidenreich' + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + totalAmount: 16221.64 + currency: GBP + currencyRate: 1 + date: '2022-05-14T13:12:00' + note: Bill Payment against bill 3f44d2be-d4c2-4cc3-8216-8add5265eb13 + paymentMethodRef: + id: fc87fba8-812e-4a54-b633-29ef2abf4c12 + name: CreditCard payments-u4p + lines: + - amount: 16221.64 + links: + - type: Bill + id: 3f44d2be-d4c2-4cc3-8216-8add5265eb13 + amount: -16221.64 + currencyRate: 1 + allocatedOnDate: '2022-05-14T13:12:00' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-05-14T13:12:00' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 232 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/billPayments?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/billPayments + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/billPayments?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 19387f05-8ad1-ea11-bbaa-000d3a2b9185 + supplierRef: + id: c41217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: Wide World Importers + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 234 + currency: GBP + currencyRate: 1 + date: '2019-01-01T00:00:00' + note: Invoice 107006 + lines: + - amount: 234 + links: + - type: Bill + id: c8cb06bf-89d1-ea11-bbaa-000d3a2b9185-108006 + amount: -234 + currencyRate: 1 + allocatedOnDate: '2019-01-01T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + reference: '108006' + metadata: + isDeleted: false + - id: 3d387f05-8ad1-ea11-bbaa-000d3a2b9185 + supplierRef: + id: be1217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: 'Fabrikam, Inc.' + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 390 + currency: GBP + currencyRate: 1 + date: '2019-01-01T00:00:00' + note: Invoice 107007 + lines: + - amount: 390 + links: + - type: Bill + id: cbcb06bf-89d1-ea11-bbaa-000d3a2b9185-108007 + amount: -390 + currencyRate: 1 + allocatedOnDate: '2019-01-01T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + reference: '108007' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 236 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billPayments?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billPayments + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/billPayments?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: da7e456f-76f7-42ac-8dad-d90a040f3afb + supplierRef: + id: 63fadca8-4905-475a-b32a-b4341293bcf4 + supplierName: Kelly's Industrial Supplies + accountRef: + id: d79d65bd-1d7d-4f55-95d3-76b3a7b7b823 + name: Bank 1 + totalAmount: -5 + currency: EUR + currencyRate: 1 + date: '2019-11-05T00:00:00Z' + lines: + - amount: -5 + links: + - type: PaymentOnAccount + id: 63fadca8-4905-475a-b32a-b4341293bcf4 + amount: 5 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:13Z' + sourceModifiedDate: '2019-11-05T14:26:22Z' + reference: '19200008' + - id: 002b8462-f3a3-4019-84fe-6a2af1f30c5a + supplierRef: + id: 5811b467-53eb-4491-8ca1-bc9b7889811b + supplierName: Ann's test supplier 2 + accountRef: + id: 1879b322-7758-4e20-8f3f-701df27f2340 + name: Kas + totalAmount: 0.13 + currency: EUR + currencyRate: 1 + date: '2019-11-07T00:00:00Z' + lines: + - amount: -0.12 + links: + - type: CreditNote + id: 33f3016c-2ecf-4d17-911e-b385537e7341 + amount: 0.12 + currencyRate: 1 + - amount: 0.12 + links: + - type: Bill + id: de6b3634-faf2-4688-b06b-72ed3ca6cf4e + amount: -0.12 + currencyRate: 1 + - amount: 0.13 + links: + - type: Bill + id: de6b3634-faf2-4688-b06b-72ed3ca6cf4e + amount: -0.13 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:14Z' + sourceModifiedDate: '2021-11-17T12:08:10Z' + reference: '19100002' + pageNumber: 1 + pageSize: 2 + totalResults: 1173 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billPayments?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billPayments + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/billPayments?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 7a5f621b-739f-4ed8-b738-2aae3ef886ac + supplierRef: + id: a7cad20d-44db-442b-ac1f-90475802d6fb + supplierName: Pencils Pencils Pencils + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 123 + currency: GBP + currencyRate: 1 + date: '2017-10-11T00:00:00Z' + lines: + - amount: 123 + links: + - type: Bill + id: e7a45898-2db3-424c-acb9-a51647740f26 + amount: -123 + currencyRate: 1 + modifiedDate: '2022-10-26T13:33:17Z' + sourceModifiedDate: '2017-10-11T10:12:29Z' + reference: '17200006' + - id: b358df76-3930-42ad-8f38-78edcc60172d + supplierRef: + id: 41302634-76b5-4442-b800-0bb63780e77c + supplierName: Some Supplier + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 55000 + currency: GBP + currencyRate: 1 + date: '2017-10-31T00:00:00Z' + lines: + - amount: 55000 + links: + - type: PaymentOnAccount + id: 41302634-76b5-4442-b800-0bb63780e77c + amount: -55000 + currencyRate: 1 + modifiedDate: '2022-10-26T13:33:17Z' + sourceModifiedDate: '2019-02-14T17:56:54Z' + reference: '17200001' + pageNumber: 1 + pageSize: 2 + totalResults: 39 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billPayments?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billPayments + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/billPayments?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '135234103' + supplierRef: + id: '7169654' + supplierName: The Eagle + totalAmount: 14.3 + currency: GBP + date: '2017-11-23T00:00:00' + note: 'ATOMIC SOFTWARE LIMITE WELLINGTON,NZL OTHER �14.30 - Bill payment against Pints1 (The Eagle)' + lines: + - amount: 14.3 + links: + - type: Bill + id: '10659723' + amount: -14.3 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:36Z' + metadata: + isDeleted: false + - id: '168350314' + supplierRef: + id: '6161941' + supplierName: A & J Fabtech Ltd + totalAmount: 30 + currency: GBP + date: '2019-01-03T00:00:00' + note: �30.00 - Bill payment against Test123 (A & J Fabtech Ltd) + lines: + - amount: 30 + links: + - type: Bill + id: '11224800' + amount: -30 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:36Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 89 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billPayments?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billPayments + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/billPayments?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '16' + supplierRef: + id: '29' + accountRef: + id: '167679' + name: Cash + totalAmount: 10 + currency: GBP + date: '2021-08-18T00:00:00' + note: Bill payment + lines: + - amount: 10 + links: + - type: Bill + id: '16' + amount: -10 + currencyRate: 1 + allocatedOnDate: '2021-08-18T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + metadata: + isDeleted: false + - id: '18' + supplierRef: + id: '39' + accountRef: + id: '167679' + name: Cash + totalAmount: 15 + currency: USD + date: '2021-08-18T00:00:00' + note: Bill payment Ikea + lines: + - amount: 15 + links: + - type: Bill + id: '18' + amount: -15 + currencyRate: 1 + allocatedOnDate: '2021-08-18T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 26 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/billPayments?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/billPayments + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/billPayments?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '112' + supplierRef: + id: '724' + supplierName: Vendor A.A.A + accountRef: + id: '825' + name: Codat Europe Bank + totalAmount: 120 + currency: GBP + currencyRate: 1 + date: '2021-03-26T00:00:00' + lines: + - amount: 120 + links: + - type: Bill + id: '7' + amount: -120 + currencyRate: 1 + modifiedDate: '2023-01-30T14:48:40Z' + sourceModifiedDate: '2021-03-26T10:31:06' + reference: 'Bill Payment #1' + - id: 159623-724 + supplierRef: + id: '724' + supplierName: Vendor A.A.A + accountRef: + id: '825' + name: Codat Europe Bank + totalAmount: -555.55 + currency: GBP + currencyRate: 1 + date: '2022-07-11T00:00:00' + lines: + - amount: -555.55 + links: + - type: PaymentOnAccount + id: '724' + amount: 555.55 + currencyRate: 1 + modifiedDate: '2023-01-30T14:48:40Z' + sourceModifiedDate: '2022-07-11T09:41:02' + reference: 'Deposit #DEP25' + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/billPayments?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/billPayments + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/billPayments?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 3A09-1071529982 + supplierRef: + id: 720000-1071512482 + supplierName: Bayshore Auto Mall + accountRef: + id: 20000-933270541 + name: Checking + totalAmount: 532.97 + currency: GBP + currencyRate: 1 + date: '2023-01-11T00:00:00' + note: Monthly Truck Payment + lines: + - amount: 532.97 + links: + - type: Bill + id: 38AA-1071513625 + amount: -532.97 + currencyRate: 1 + modifiedDate: '2023-04-26T09:09:20Z' + sourceModifiedDate: '2023-12-16T05:04:58' + reference: '101' + metadata: + isDeleted: false + - id: 84C2-1197705262 + supplierRef: + id: B0000-933272656 + supplierName: Patton Hardware Supplies + accountRef: + id: '8000007E-1197732180' + name: CalOil Credit Card + totalAmount: 4050.98 + currency: GBP + currencyRate: 1 + date: '2023-01-15T00:00:00' + lines: + - amount: 4050.98 + links: + - type: Bill + id: 84C2-1197705262 + amount: -4050.98 + currencyRate: 1 + allocatedOnDate: '2023-01-15T00:00:00' + modifiedDate: '2023-04-26T09:09:20Z' + sourceModifiedDate: '2023-12-16T05:06:15' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 214 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billPayments?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billPayments + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/billPayments?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '20' + supplierRef: + id: '4' + supplierName: BILLy elliot + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2019-05-13T00:00:00' + lines: + - amount: 0 + links: + - type: Bill + id: '18' + amount: -5 + currencyRate: 1 + - type: CreditNote + id: '19' + amount: 5 + currencyRate: 1 + modifiedDate: '2023-01-18T11:02:47Z' + sourceModifiedDate: '2019-05-13T13:14:26Z' + - id: '25' + supplierRef: + id: '5' + supplierName: Callum McGinley + accountRef: + id: '63' + name: Business Bank Account + totalAmount: 5999.99 + currency: GBP + currencyRate: 1 + date: '2019-05-31T00:00:00' + lines: + - amount: 5999.99 + links: + - type: Bill + id: '24' + amount: -5999.99 + currencyRate: 1 + modifiedDate: '2023-01-18T11:02:47Z' + sourceModifiedDate: '2019-05-31T12:55:10Z' + pageNumber: 1 + pageSize: 2 + totalResults: 126 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billPayments?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billPayments + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/billPayments?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '158' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + accountRef: + id: '81' + name: Current + totalAmount: 7940.6 + currency: HKD + currencyRate: 0.078807 + date: '2016-01-23T00:00:00' + lines: + - amount: 7940.6 + links: + - type: Bill + id: '157' + amount: -7940.6 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-13T21:19:36Z' + reference: '1067' + metadata: + isDeleted: false + - id: '159' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + accountRef: + id: '81' + name: Current + totalAmount: 742.5 + currency: HKD + currencyRate: 0.078807 + date: '2016-01-23T00:00:00' + lines: + - amount: 742.5 + links: + - type: Bill + id: '28' + amount: -742.5 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-13T21:19:49Z' + reference: '1068' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 191 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billPayments?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billPayments + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/billPayments?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '45462' + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + totalAmount: 27 + currency: GBP + currencyRate: 1 + date: '2020-01-05T00:00:00Z' + note: '' + lines: + - amount: 27 + links: + - type: PaymentOnAccount + id: CON001 + amount: -27 + currencyRate: 1 + modifiedDate: '2022-10-14T09:35:54Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: Payment invoice 1 + - id: '45502' + supplierRef: + id: SDE001 + supplierName: S D Enterprises + totalAmount: 59 + currency: GBP + currencyRate: 1 + date: '2020-01-17T00:00:00Z' + note: pay3 + lines: + - amount: 59 + links: + - type: PaymentOnAccount + id: SDE001 + amount: -59 + currencyRate: 1 + modifiedDate: '2022-10-14T09:35:54Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: payment inv3 + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billPayments?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billPayments + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/billPayments?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '255' + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + totalAmount: 370.71 + currency: GBP + currencyRate: 1 + date: '2022-01-29T00:00:00' + note: 'Purchase payment 255 linked to, purchase invoice 86, purchase invoice 87, purchase invoice 250, purchase invoice 251, purchase invoice 252.' + lines: + - amount: 117.5 + links: + - type: Bill + id: '86' + amount: -117.5 + currencyRate: 1 + - amount: 64.63 + links: + - type: Bill + id: '87' + amount: -64.63 + currencyRate: 1 + - amount: 50.57 + links: + - type: Bill + id: '250' + amount: -50.57 + currencyRate: 1 + - amount: 36.87 + links: + - type: Bill + id: '251' + amount: -36.87 + currencyRate: 1 + - amount: 101.14 + links: + - type: Bill + id: '252' + amount: -101.14 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + - id: '256' + supplierRef: + id: QUA001 + supplierName: Quality Motors + totalAmount: 256.36 + currency: GBP + currencyRate: 1 + date: '2022-01-29T00:00:00' + note: 'Purchase payment 256 linked to, purchase invoice 17.' + lines: + - amount: 256.36 + links: + - type: Bill + id: '17' + amount: -256.36 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 27 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billPayments?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billPayments + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/billPayments?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: d953b45e156011e8b45c025132dab352 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + totalAmount: 52.02 + currency: GBP + currencyRate: 1 + date: '2018-02-15T00:00:00' + note: Supplier payment using credit/debit card - Cool stuff + lines: + - amount: 52.02 + links: + - type: PaymentOnAccount + id: ca430e0d156011e8b45c025132dab352 + amount: -52.02 + currencyRate: 1 + modifiedDate: '2022-10-24T14:54:04Z' + sourceModifiedDate: '2019-11-20T09:30:03Z' + - id: a99b9aae216111e8b45c025132dab352 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + accountRef: + id: 9a3e4bc6267a11e797950a57719b2edb + name: Cash + totalAmount: 52.02 + currency: GBP + currencyRate: 1 + date: '2018-03-06T00:00:00' + note: Supplier payment using cash + lines: + - amount: 52.02 + links: + - type: PaymentOnAccount + id: ca430e0d156011e8b45c025132dab352 + amount: -52.02 + currencyRate: 1 + modifiedDate: '2022-10-24T14:54:04Z' + sourceModifiedDate: '2018-03-06T17:13:17Z' + pageNumber: 1 + pageSize: 2 + totalResults: 2225 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billPayments?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billPayments + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/billPayments?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '4471' + supplierRef: + id: '3' + supplierName: ADP + accountRef: + id: '353' + name: Current Account + totalAmount: 20 + currency: GBP + date: '2022-01-06T00:00:00' + note: '' + paymentMethodRef: + id: '6' + name: Cash + lines: + - amount: 20 + links: + - type: Bill + id: '4470' + amount: -20 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:13Z' + sourceModifiedDate: '2022-02-23T12:03:30' + metadata: + isDeleted: false + - id: '4472' + supplierRef: + id: '3' + supplierName: ADP + accountRef: + id: '353' + name: Current Account + totalAmount: 5 + currency: GBP + date: '2022-01-06T00:00:00' + note: '' + paymentMethodRef: + id: '6' + name: Cash + lines: + - amount: 5 + links: + - type: Bill + id: '4470' + amount: -5 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:13Z' + sourceModifiedDate: '2022-02-23T12:06:58' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/billPayments?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/billPayments + Xero: + value: + results: + - id: 74004690-82a1-4810-aaca-6ce575af94b4 + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 7267.2 + currency: GBP + currencyRate: 1 + date: '2021-12-20T00:00:00' + lines: + - amount: 7267.2 + links: + - type: Bill + id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + amount: -7267.2 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:10Z' + sourceModifiedDate: '2021-01-02T22:51:40' + metadata: + isDeleted: false + - id: f2062172-b444-4c8b-b797-9f4c7a4244c7 + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 7267.2 + currency: GBP + currencyRate: 1 + date: '2022-02-17T00:00:00' + lines: + - amount: 7267.2 + links: + - type: Bill + id: 09aa506f-cb81-4cd3-a1ea-6a0b91804d5a + amount: -7267.2 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:10Z' + sourceModifiedDate: '2021-01-02T22:51:38' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 30 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/billPayments?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/billPayments + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/billPayments?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List bill payments* endpoint returns a list of [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment) for a given company's connection.\n\n[Bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-bill-payments + x-speakeasy-group: accounts-payable.bill-payments + '/companies/{companyId}/data/billPayments/{billPaymentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/accountingBillPaymentId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBillPayment' + examples: + Clear Books: + value: + id: dcb18480-8b69-44d8-aa26-268b6a80d170 + supplierRef: + id: 8GeHBdBZiZ + supplierName: 'DuBuque, Goyette and Franecki' + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + totalAmount: 71351.42 + currency: GBP + currencyRate: 1 + date: '2022-05-06T00:00:00' + note: Bill Payment against bill 81539597-e681-40c9-a4dd-ec2fffcde572 + paymentMethodRef: + id: cb4a5647-aa86-40ab-bb4f-158acaa99c12 + name: Check payments-u4p + lines: + - amount: 71351.42 + links: + - type: Bill + id: 81539597-e681-40c9-a4dd-ec2fffcde572 + amount: -71351.42 + currencyRate: 1 + allocatedOnDate: '2022-05-06T00:00:00' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-05-06T00:00:00' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 19387f05-8ad1-ea11-bbaa-000d3a2b9185 + supplierRef: + id: c41217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: Wide World Importers + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 234 + currency: GBP + currencyRate: 1 + date: '2019-01-01T00:00:00' + note: Invoice 107006 + lines: + - amount: 234 + links: + - type: Bill + id: c8cb06bf-89d1-ea11-bbaa-000d3a2b9185-108006 + amount: -234 + currencyRate: 1 + allocatedOnDate: '2019-01-01T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + reference: '108006' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: da7e456f-76f7-42ac-8dad-d90a040f3afb + supplierRef: + id: 63fadca8-4905-475a-b32a-b4341293bcf4 + supplierName: Kelly's Industrial Supplies + accountRef: + id: d79d65bd-1d7d-4f55-95d3-76b3a7b7b823 + name: Bank 1 + totalAmount: -5 + currency: EUR + currencyRate: 1 + date: '2019-11-05T00:00:00Z' + lines: + - amount: -5 + links: + - type: PaymentOnAccount + id: 63fadca8-4905-475a-b32a-b4341293bcf4 + amount: 5 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:13Z' + sourceModifiedDate: '2019-11-05T14:26:22Z' + reference: '19200008' + Exact (UK): + value: + id: 7a5f621b-739f-4ed8-b738-2aae3ef886ac + supplierRef: + id: a7cad20d-44db-442b-ac1f-90475802d6fb + supplierName: Pencils Pencils Pencils + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 123 + currency: GBP + currencyRate: 1 + date: '2017-10-11T00:00:00Z' + lines: + - amount: 123 + links: + - type: Bill + id: e7a45898-2db3-424c-acb9-a51647740f26 + amount: -123 + currencyRate: 1 + modifiedDate: '2022-10-26T13:33:17Z' + sourceModifiedDate: '2017-10-11T10:12:29Z' + reference: '17200006' + FreeAgent: + value: + id: '135234103' + supplierRef: + id: '7169654' + supplierName: The Eagle + totalAmount: 14.3 + currency: GBP + date: '2017-11-23T00:00:00' + note: 'ATOMIC SOFTWARE LIMITE WELLINGTON,NZL OTHER �14.30 - Bill payment against Pints1 (The Eagle)' + lines: + - amount: 14.3 + links: + - type: Bill + id: '10659723' + amount: -14.3 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:36Z' + metadata: + isDeleted: false + FreshBooks: + value: + id: '16' + supplierRef: + id: '29' + accountRef: + id: '167679' + name: Cash + totalAmount: 10 + currency: GBP + date: '2021-08-18T00:00:00' + note: Bill payment + lines: + - amount: 10 + links: + - type: Bill + id: '16' + amount: -10 + currencyRate: 1 + allocatedOnDate: '2021-08-18T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + metadata: + isDeleted: false + Oracle NetSuite: + value: + id: '112' + supplierRef: + id: '724' + supplierName: Vendor A.A.A + accountRef: + id: '825' + name: Codat Europe Bank + totalAmount: 120 + currency: GBP + currencyRate: 1 + date: '2021-03-26T00:00:00' + lines: + - amount: 120 + links: + - type: Bill + id: '7' + amount: -120 + currencyRate: 1 + modifiedDate: '2023-01-30T14:48:40Z' + sourceModifiedDate: '2021-03-26T10:31:06' + reference: 'Bill Payment #1' + QuickBooks Desktop: + value: + id: 3A09-1071529982 + supplierRef: + id: 720000-1071512482 + supplierName: Bayshore Auto Mall + accountRef: + id: 20000-933270541 + name: Checking + totalAmount: 532.97 + currency: GBP + currencyRate: 1 + date: '2023-01-11T00:00:00' + note: Monthly Truck Payment + lines: + - amount: 532.97 + links: + - type: Bill + id: 38AA-1071513625 + amount: -532.97 + currencyRate: 1 + modifiedDate: '2023-04-26T09:09:20Z' + sourceModifiedDate: '2023-12-16T05:04:58' + reference: '101' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '20' + supplierRef: + id: '4' + supplierName: BILLy elliot + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2019-05-13T00:00:00' + lines: + - amount: 0 + links: + - type: Bill + id: '18' + amount: -5 + currencyRate: 1 + - type: CreditNote + id: '19' + amount: 5 + currencyRate: 1 + modifiedDate: '2023-01-18T11:02:47Z' + sourceModifiedDate: '2019-05-13T13:14:26Z' + QuickBooks Online Sandbox: + value: + id: '158' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + accountRef: + id: '81' + name: Current + totalAmount: 7940.6 + currency: HKD + currencyRate: 0.078807 + date: '2016-01-23T00:00:00' + lines: + - amount: 7940.6 + links: + - type: Bill + id: '157' + amount: -7940.6 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-13T21:19:36Z' + reference: '1067' + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '45462' + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + totalAmount: 27 + currency: GBP + currencyRate: 1 + date: '2020-01-05T00:00:00Z' + note: '' + lines: + - amount: 27 + links: + - type: PaymentOnAccount + id: CON001 + amount: -27 + currencyRate: 1 + modifiedDate: '2022-10-14T09:35:54Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: Payment invoice 1 + Sage 50 (UK): + value: + id: '255' + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + totalAmount: 370.71 + currency: GBP + currencyRate: 1 + date: '2022-01-29T00:00:00' + note: 'Purchase payment 255 linked to, purchase invoice 86, purchase invoice 87, purchase invoice 250, purchase invoice 251, purchase invoice 252.' + lines: + - amount: 117.5 + links: + - type: Bill + id: '86' + amount: -117.5 + currencyRate: 1 + - amount: 64.63 + links: + - type: Bill + id: '87' + amount: -64.63 + currencyRate: 1 + - amount: 50.57 + links: + - type: Bill + id: '250' + amount: -50.57 + currencyRate: 1 + - amount: 36.87 + links: + - type: Bill + id: '251' + amount: -36.87 + currencyRate: 1 + - amount: 101.14 + links: + - type: Bill + id: '252' + amount: -101.14 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: d953b45e156011e8b45c025132dab352 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + totalAmount: 52.02 + currency: GBP + currencyRate: 1 + date: '2018-02-15T00:00:00' + note: Supplier payment using credit/debit card - Cool stuff + lines: + - amount: 52.02 + links: + - type: PaymentOnAccount + id: ca430e0d156011e8b45c025132dab352 + amount: -52.02 + currencyRate: 1 + modifiedDate: '2022-10-24T14:54:04Z' + sourceModifiedDate: '2019-11-20T09:30:03Z' + Sage Intacct: + value: + id: '4471' + supplierRef: + id: '3' + supplierName: ADP + accountRef: + id: '353' + name: Current Account + totalAmount: 20 + currency: GBP + date: '2022-01-06T00:00:00' + note: '' + paymentMethodRef: + id: '6' + name: Cash + lines: + - amount: 20 + links: + - type: Bill + id: '4470' + amount: -20 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:13Z' + sourceModifiedDate: '2022-02-23T12:03:30' + metadata: + isDeleted: false + Xero: + value: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 7267.2 + currency: GBP + currencyRate: 1 + date: '2021-12-20T00:00:00' + lines: + - amount: 7267.2 + links: + - type: Bill + id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + amount: -7267.2 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:10Z' + sourceModifiedDate: '2021-01-02T22:51:40' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get bill payment + description: | + The *Get bill payment* endpoint returns a single bill payment for a given billPaymentId. + + [Bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-bill-payment + x-speakeasy-group: accounts-payable.bill-payments + '/companies/{companyId}/data/bills': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + summary: List bills + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBills' + examples: + Clear Books: + value: + results: + - id: 81539597-e681-40c9-a4dd-ec2fffcde572 + reference: b465a2c9-3212-4620-889b-6328ba148215 + supplierRef: + id: 8GeHBdBZiZ + supplierName: 'DuBuque, Goyette and Franecki' + purchaseOrderRefs: [] + issueDate: '2022-04-29T00:00:00' + dueDate: '2022-05-06T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Grease Trap + unitAmount: 2781.94 + quantity: 5 + discountAmount: 0 + subTotal: 13909.7 + taxAmount: 1390.97 + totalAmount: 15300.67 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 5 + discountAmount: 0 + subTotal: 6856.95 + taxAmount: 685.7 + totalAmount: 7542.65 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 6 + discountAmount: 0 + subTotal: 8228.34 + taxAmount: 822.83 + totalAmount: 9051.17 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 2781.94 + quantity: 3 + discountAmount: 0 + subTotal: 8345.82 + taxAmount: 834.58 + totalAmount: 9180.4 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Trapped Road Gully 450mm x 450mm + unitAmount: 402.89 + quantity: 8 + discountAmount: 0 + subTotal: 3223.12 + taxAmount: 322.31 + totalAmount: 3545.43 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + name: Heavy Duty Hinged Gully Grating + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 7 + discountAmount: 0 + subTotal: 665.56 + taxAmount: 66.56 + totalAmount: 732.12 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 1 + discountAmount: 0 + subTotal: 95.08 + taxAmount: 9.51 + totalAmount: 104.59 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 2 + discountAmount: 0 + subTotal: 2742.78 + taxAmount: 274.28 + totalAmount: 3017.06 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 2781.94 + quantity: 1 + discountAmount: 0 + subTotal: 2781.94 + taxAmount: 278.19 + totalAmount: 3060.13 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 7 + discountAmount: 0 + subTotal: 665.56 + taxAmount: 66.56 + totalAmount: 732.12 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1251.89 + quantity: 4 + discountAmount: 0 + subTotal: 5007.56 + taxAmount: 500.76 + totalAmount: 5508.32 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 51077072-d5c3-463b-9cb4-7da2e11886f9 + name: 150 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 9 + discountAmount: 0 + subTotal: 12342.51 + taxAmount: 1234.25 + totalAmount: 13576.76 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 64864.92 + taxAmount: 6486.5 + totalAmount: 71351.42 + amountDue: 0 + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2023-02-14T17:09:02' + note: 'Bill with 12 line items, totaling 71351.42' + paymentAllocations: + - payment: + id: dcb18480-8b69-44d8-aa26-268b6a80d170 + note: Bill Payment against bill 81539597-e681-40c9-a4dd-ec2fffcde572 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-06T00:00:00' + totalAmount: 71351.42 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-06T00:00:00' + totalAmount: -71351.42 + metadata: + isDeleted: false + - id: acc1dc9d-a21a-41b8-953e-73da4afab6e6 + reference: d88e83b8-a5cc-4578-815d-afa263df4beb + supplierRef: + id: 7GObELDcsE + supplierName: 'Lakin, Schmeler and Kihn' + purchaseOrderRefs: + - id: 7f07b584-bebe-450f-aa9e-1d7aed630b66 + purchaseOrderNumber: ee9b8e00-49a2-4d83-bc33-e2eee59a1c36 + issueDate: '2022-04-30T00:00:00' + dueDate: '2022-05-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 4 + discountAmount: 0 + subTotal: 380.32 + taxAmount: 38.03 + totalAmount: 418.35 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 380.32 + taxAmount: 38.03 + totalAmount: 418.35 + amountDue: 0 + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2023-04-14T01:56:02' + note: Bill for purchase order ee9b8e00-49a2-4d83-bc33-e2eee59a1c36 + paymentAllocations: + - payment: + id: a4fa017a-3911-4eb0-aaf9-b002c446c8c3 + note: Bill Payment against bill acc1dc9d-a21a-41b8-953e-73da4afab6e6 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-15T00:00:00' + totalAmount: 418.35 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-15T00:00:00' + totalAmount: -418.35 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 183 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/bills?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/bills + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/bills?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 4019ee2b-d05a-ed11-8c34-000d3a0d28a2-108276 + reference: '108276' + supplierRef: + id: c01217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: First Up Consultants + purchaseOrderRefs: [] + issueDate: '2019-01-01T00:00:00' + dueDate: '2019-01-01T00:00:00' + currency: GBP + lineItems: + - description: ATHENS Desk + unitAmount: 506.6 + quantity: 4 + discountAmount: 202.64 + subTotal: 1823.76 + taxAmount: 364.75 + totalAmount: 2188.51 + discountPercentage: 10 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-c81217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'ATHENS Desk / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 1823.76 + taxAmount: 364.75 + totalAmount: 2188.51 + amountDue: 2188.51 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-11-02T17:02:48Z' + note: '129148' + paymentAllocations: [] + metadata: + isDeleted: false + - id: b9cb06bf-89d1-ea11-bbaa-000d3a2b9185-108001 + reference: '108001' + supplierRef: + id: c01217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: First Up Consultants + purchaseOrderRefs: [] + issueDate: '2019-01-01T00:00:00' + dueDate: '2019-01-01T00:00:00' + currency: GBP + lineItems: + - description: ATHENS Desk + unitAmount: 506.6 + quantity: 4 + discountAmount: 0 + subTotal: 2026.4 + taxAmount: 405.28 + totalAmount: 2431.68 + discountPercentage: 0 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-c81217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'ATHENS Desk / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 2026.4 + taxAmount: 405.28 + totalAmount: 2431.68 + amountDue: 0 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-17T16:29:02Z' + note: '107001' + paymentAllocations: + - payment: + id: 57377f05-8ad1-ea11-bbaa-000d3a2b9185 + note: Invoice 107001 + reference: '108001' + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + currency: GBP + currencyRate: 1 + paidOnDate: '2019-01-01T00:00:00' + totalAmount: 2431.68 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-01-01T00:00:00' + totalAmount: -2431.68 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 294 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/bills?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/bills + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/bills?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 1c55118b-793e-4437-9c13-4f554b9ca989 + reference: '19600006' + supplierRef: + id: 5e6f49b9-6489-4b82-83e7-291d308919bb + supplierName: Mickey Mouse + purchaseOrderRefs: [] + issueDate: '2019-12-16T00:00:00Z' + dueDate: '2019-11-09T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Cheesecake + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + accountRef: + id: 5f139759-b554-4314-862e-b9d88e5b2e1b + name: Af te dragen loonheffing + taxRateRef: + id: 84277189-ad16-456c-b501-ca31f0a483cc + name: BTW prive gebruik + effectiveTaxRate: 21 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + amountDue: 0 + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-03T15:06:02Z' + paymentAllocations: + - payment: + id: d9a2980b-2a43-46f2-9c7f-413d925b3cdd + reference: '20200032' + accountRef: + id: d79d65bd-1d7d-4f55-95d3-76b3a7b7b823 + name: Bank 1 + currency: EUR + currencyRate: 1 + paidOnDate: '2021-03-22T00:00:00' + totalAmount: 12.1 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -12.1 + - id: ec0c61a1-deb6-4496-b9ee-feb29b16019c + reference: '19600008' + supplierRef: + id: fc189bfa-f083-438c-bf09-379a0631d4a1 + supplierName: Mickey Mouse + purchaseOrderRefs: [] + issueDate: '2019-12-16T00:00:00Z' + dueDate: '2019-11-09T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Cheesecake + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + accountRef: + id: 5f139759-b554-4314-862e-b9d88e5b2e1b + name: Af te dragen loonheffing + taxRateRef: + id: 84277189-ad16-456c-b501-ca31f0a483cc + name: BTW prive gebruik + effectiveTaxRate: 21 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + amountDue: 12.1 + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-03T15:06:39Z' + paymentAllocations: + - payment: + id: ef5d140b-16da-4fd2-a0c8-d5bfb89a13ee + reference: '19900056' + accountRef: + id: a2d51b6f-677d-4bbf-ad0c-b45fd6231546 + name: Activa herwaarderingen + currency: EUR + currencyRate: 1 + paidOnDate: '2019-11-07T00:00:00' + totalAmount: 0.21 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -0.21 + - payment: + id: b69e7ad4-2b90-4a5f-a8a0-67418ac95531 + reference: '19900053' + accountRef: + id: a2d51b6f-677d-4bbf-ad0c-b45fd6231546 + name: Activa herwaarderingen + currency: EUR + currencyRate: 1 + paidOnDate: '2019-11-07T00:00:00' + totalAmount: 0.2 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -0.2 + - payment: + id: 6ccd1256-6073-4bfc-8d88-700417685e72 + reference: '21200028' + accountRef: + id: d79d65bd-1d7d-4f55-95d3-76b3a7b7b823 + name: Bank 1 + currency: EUR + currencyRate: 1 + paidOnDate: '2021-10-05T00:00:00' + totalAmount: 12.1 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -12.1 + - payment: + id: 69a8533b-3e59-4d2d-9bca-bc37bc0f7984 + reference: '19900055' + accountRef: + id: a2d51b6f-677d-4bbf-ad0c-b45fd6231546 + name: Activa herwaarderingen + currency: EUR + currencyRate: 1 + paidOnDate: '2019-11-07T00:00:00' + totalAmount: 0.21 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -0.21 + - payment: + id: 2dae3548-ff11-4ad8-886c-eb5cb7965024 + reference: '19900054' + accountRef: + id: a2d51b6f-677d-4bbf-ad0c-b45fd6231546 + name: Activa herwaarderingen + currency: EUR + currencyRate: 1 + paidOnDate: '2019-11-07T00:00:00' + totalAmount: 0.21 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -0.21 + pageNumber: 1 + pageSize: 2 + totalResults: 80 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/bills?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/bills + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/bills?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: e7a45898-2db3-424c-acb9-a51647740f26 + reference: '17600002' + supplierRef: + id: a7cad20d-44db-442b-ac1f-90475802d6fb + supplierName: Pencils Pencils Pencils + purchaseOrderRefs: [] + issueDate: '2017-09-26T00:00:00Z' + dueDate: '2017-10-26T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Stationery + unitAmount: 400 + quantity: 2 + discountAmount: 0 + subTotal: 800 + taxAmount: 160 + totalAmount: 960 + accountRef: + id: e5e9e994-0f14-4614-b162-7b5593b21276 + name: Finished Goods Stock + taxRateRef: + id: 63cd143a-66ab-4320-8a6d-ab6be85ed048 + name: UK purchases standard rate � Excluding + effectiveTaxRate: 20 + itemRef: + id: '001' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 800 + taxAmount: 160 + totalAmount: 960 + amountDue: 0 + modifiedDate: '2022-10-26T13:33:20Z' + sourceModifiedDate: '2019-01-11T14:18:17Z' + paymentAllocations: + - payment: + id: 7a5f621b-739f-4ed8-b738-2aae3ef886ac + reference: '17200006' + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2017-10-11T00:00:00' + totalAmount: 123 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -123 + - id: 064fbab9-9b4d-4e83-b2df-0f4ce12bc2bf + reference: '19600001' + supplierRef: + id: a4d5d739-c979-4819-b0ce-666db1ec3a7d + supplierName: Exact Software (UK) Ltd � Exact Online + purchaseOrderRefs: [] + issueDate: '2019-01-11T00:00:00Z' + dueDate: '2019-02-10T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Basket balls + unitAmount: 20 + quantity: 1 + discountAmount: 0 + subTotal: 20 + taxAmount: 0 + totalAmount: 20 + accountRef: + id: 885ff551-664d-451b-995b-cb114c9877d0 + name: Unallocated Cash + itemRef: + id: '23' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 20 + taxAmount: 0 + totalAmount: 20 + amountDue: 0 + modifiedDate: '2022-10-26T13:33:20Z' + sourceModifiedDate: '2019-01-11T12:03:31Z' + paymentAllocations: + - payment: + id: d871f677-c2df-4069-bda0-c6804a46b71b + reference: '19200001' + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2019-02-10T00:00:00' + totalAmount: 20 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -20 + pageNumber: 1 + pageSize: 2 + totalResults: 83 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/bills?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/bills + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/bills?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '16609552' + reference: MATT - U + supplierRef: + id: '7169654' + supplierName: The Eagle + purchaseOrderRefs: [] + issueDate: '2014-08-21T00:00:00' + dueDate: '2018-09-20T00:00:00' + currency: GBP + lineItems: + - unitAmount: 125 + quantity: 1 + taxAmount: 25 + totalAmount: 150 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 125 + taxAmount: 25 + totalAmount: 150 + amountDue: 150 + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2020-11-11T12:48:55Z' + paymentAllocations: [] + metadata: + isDeleted: false + - id: '16609589' + reference: MATT - U + supplierRef: + id: '7169654' + supplierName: The Eagle + purchaseOrderRefs: [] + issueDate: '2014-08-21T00:00:00' + dueDate: '2018-09-20T00:00:00' + currency: GBP + lineItems: + - unitAmount: 125 + quantity: 1 + taxAmount: 25 + totalAmount: 150 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 125 + taxAmount: 25 + totalAmount: 150 + amountDue: 150 + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2020-11-11T12:50:41Z' + paymentAllocations: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 137 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/bills?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/bills + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/bills?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '27' + supplierRef: + id: '87' + purchaseOrderRefs: [] + issueDate: '2021-04-26T00:00:00' + dueDate: '2021-05-26T00:00:00' + currency: USD + lineItems: + - description: Grocery + unitAmount: 50 + quantity: 1 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + accountRef: + id: '3384197' + name: Advertising + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + amountDue: 50 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-04-26T19:34:22' + paymentAllocations: [] + metadata: + isDeleted: false + - id: '29' + supplierRef: + id: '89' + purchaseOrderRefs: [] + issueDate: '2021-04-28T00:00:00' + dueDate: '2021-05-28T00:00:00' + currency: GBP + lineItems: + - description: Advertising refund + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: '3384197' + name: Advertising + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + amountDue: 0 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-08-18T13:52:33' + paymentAllocations: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 16 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/bills?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/bills + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/bills?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '97615244' + reference: '25' + supplierRef: + id: '9272052' + supplierName: Supplier man + purchaseOrderRefs: [] + issueDate: '2000-01-01T00:00:00' + dueDate: '2000-01-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 8.33 + quantity: 1 + subTotal: 8.33 + taxAmount: 1.67 + totalAmount: 10 + accountRef: + id: '21481884' + name: Computer equipment cost + itemRef: + id: '122990246' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 8.33 + taxAmount: 1.67 + totalAmount: 10 + amountDue: 0 + modifiedDate: '2022-09-30T10:29:15Z' + paymentAllocations: [] + - id: '76144089' + reference: '1' + supplierRef: + id: '6202387' + supplierName: Dell + purchaseOrderRefs: [] + issueDate: '2019-01-28T00:00:00' + dueDate: '2019-02-27T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 120 + quantity: 5 + subTotal: 600 + taxAmount: 0 + totalAmount: 600 + accountRef: + id: '21481820' + name: Materials purchased + itemRef: + id: '95293985' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 600 + taxAmount: 0 + totalAmount: 600 + amountDue: 0 + modifiedDate: '2022-09-30T10:29:15Z' + paymentAllocations: [] + pageNumber: 1 + pageSize: 2 + totalResults: 19 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/bills?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/bills + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/bills?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '7' + supplierRef: + id: '724' + supplierName: Vendor A.A.A + purchaseOrderRefs: [] + issueDate: '2021-03-26T00:00:00' + dueDate: '2021-03-26T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 120 + quantity: 1 + unitOfMeasurement: litre + subTotal: 120 + totalAmount: 120 + accountRef: + id: '716' + name: Inventory In Transit + trackingCategoryRefs: + - id: location-4 + name: Europe + tracking: + categoryRefs: + - id: location-4 + name: Europe + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 120 + taxAmount: 24 + totalAmount: 144 + amountDue: 24 + modifiedDate: '2023-01-30T14:47:34Z' + sourceModifiedDate: '2022-07-05T13:38:10' + paymentAllocations: + - payment: + id: '112' + reference: 'Bill Payment #1' + accountRef: + id: '825' + name: Codat Europe Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2021-03-26T00:00:00' + totalAmount: 120 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -120 + - id: '165372' + supplierRef: + id: '724' + supplierName: Vendor A.A.A + purchaseOrderRefs: [] + issueDate: '2022-07-15T00:00:00' + dueDate: '2022-07-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 555.78 + quantity: 1 + subTotal: 555.78 + totalAmount: 555.78 + accountRef: + id: '844' + name: Asset account test 2 + trackingCategoryRefs: + - id: location-4 + name: Europe + tracking: + categoryRefs: + - id: location-4 + name: Europe + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 555.78 + taxAmount: 0 + totalAmount: 555.78 + amountDue: 500 + modifiedDate: '2023-01-30T14:47:34Z' + sourceModifiedDate: '2022-07-15T11:35:47' + paymentAllocations: + - payment: + id: '165373' + reference: 'Bill Payment #2' + accountRef: + id: '825' + name: Codat Europe Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2022-07-15T00:00:00' + totalAmount: 555.78 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -55.78 + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/bills?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/bills + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/bills?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 3691-1071520776 + reference: '3847498' + supplierRef: + id: B0000-933272656 + supplierName: Patton Hardware Supplies + purchaseOrderRefs: + - id: 3684-1071520443 + purchaseOrderNumber: '6225' + issueDate: '2022-12-02T00:00:00' + dueDate: '2024-01-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: "Cabinets:Light Pine - Light pine kitchen cabinet wall unit \n#CLD- 1235-p" + unitAmount: 1500 + quantity: 5 + discountAmount: 0 + subTotal: 7500 + taxAmount: 0 + totalAmount: 7500 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 110000-933272656 + name: 'Cabinets:Light Pine' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + - description: 'Hardware:Doorknobs Std - Doorknobs Part # DK 3704' + unitAmount: 27 + quantity: 100 + discountAmount: 0 + subTotal: 2700 + taxAmount: 0 + totalAmount: 2700 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 130000-933272656 + name: 'Hardware:Doorknobs Std' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + - description: 'Hardware:Lk Doorknobs - Locking interior doorknobs Part # DK415' + unitAmount: 34.95 + quantity: 100 + discountAmount: 0 + subTotal: 3495 + taxAmount: 0 + totalAmount: 3495 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 140000-933272656 + name: 'Hardware:Lk Doorknobs' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 13695 + taxAmount: 0 + totalAmount: 13695 + amountDue: 0 + modifiedDate: '2023-04-26T09:06:42Z' + sourceModifiedDate: '2023-12-16T05:06:30' + paymentAllocations: + - payment: + id: 9E4C-1182131999 + reference: '115' + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-31T00:00:00' + totalAmount: 13759 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8695 + - payment: + id: 36AD-1071520917 + note: RC 93 + reference: '484' + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2024-12-05T00:00:00' + totalAmount: 5325 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5000 + metadata: + isDeleted: false + - id: 5CAB-1197713763 + reference: '8374892' + supplierRef: + id: 30000-933272656 + supplierName: C. U. Electric + purchaseOrderRefs: [] + issueDate: '2022-12-15T00:00:00' + dueDate: '2024-01-14T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 532 + quantity: 1 + discountAmount: 0 + subTotal: 532 + taxAmount: 0 + totalAmount: 532 + discountPercentage: 0 + accountRef: + id: 490000-933270542 + name: Gas and Electric + trackingCategoryRefs: + - id: 80000007-1197713802 + name: Overhead + tracking: + categoryRefs: + - id: 80000007-1197713802 + name: Overhead + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 532 + taxAmount: 0 + totalAmount: 532 + amountDue: 0 + modifiedDate: '2023-04-26T09:06:42Z' + sourceModifiedDate: '2023-12-16T05:06:30' + paymentAllocations: + - payment: + id: 9E42-1182131999 + reference: '113' + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-31T00:00:00' + totalAmount: 532 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -532 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 239 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/bills?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/bills + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/bills?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '18' + reference: '12' + supplierRef: + id: '4' + supplierName: BILLy elliot + purchaseOrderRefs: [] + issueDate: '2019-05-13T00:00:00' + dueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 5 + quantity: 1 + discountAmount: 0 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + amountDue: 0 + modifiedDate: '2023-01-18T11:02:41Z' + sourceModifiedDate: '2022-05-26T10:34:10Z' + paymentAllocations: + - payment: + id: '20' + currency: GBP + currencyRate: 1 + paidOnDate: '2019-05-13T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - id: '22' + reference: '12' + supplierRef: + id: '4' + supplierName: BILLy elliot + purchaseOrderRefs: [] + issueDate: '2019-05-13T00:00:00' + dueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 5 + quantity: 1 + discountAmount: 0 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + amountDue: 0 + modifiedDate: '2023-01-18T11:02:41Z' + sourceModifiedDate: '2020-03-23T10:44:06Z' + paymentAllocations: + - payment: + id: '678' + note: payment note test + currency: GBP + currencyRate: 1 + paidOnDate: '2020-03-23T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + pageNumber: 1 + pageSize: 2 + totalResults: 147 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/bills?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/bills + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/bills?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '157' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + purchaseOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-01-16T00:00:00' + currency: HKD + currencyRate: 0.081142 + lineItems: + - description: Water bottles -- generic + unitAmount: 66.1717023 + quantity: 100 + discountAmount: 0 + subTotal: 6617.17 + taxAmount: 1323.43 + totalAmount: 7940.6 + taxRateRef: + id: 3_Bills + name: 20.0% S Bills + effectiveTaxRate: 20 + itemRef: + id: '19' + name: Water Bottles + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + customerRef: + id: '55' + companyName: Oxon Insurance - Holiday Party + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 6617.17 + taxAmount: 1323.43 + totalAmount: 7940.6 + amountDue: 0 + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2023-01-26T11:20:45Z' + paymentAllocations: + - payment: + id: '158' + reference: '1067' + accountRef: + id: '81' + name: Current + currency: HKD + currencyRate: 0.078807 + paidOnDate: '2016-01-23T00:00:00' + totalAmount: 7940.6 + allocation: + currency: HKD + currencyRate: 1 + totalAmount: -7940.6 + metadata: + isDeleted: false + - id: '28' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + purchaseOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-01-06T00:00:00' + currency: HKD + currencyRate: 0.081142 + lineItems: + - description: promotional items -- misc engraved items + unitAmount: 8.25 + quantity: 75 + discountAmount: 0 + subTotal: 618.75 + taxAmount: 123.75 + totalAmount: 742.5 + taxRateRef: + id: 3_Bills + name: 20.0% S Bills + effectiveTaxRate: 20 + itemRef: + id: '12' + name: Misc + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + customerRef: + id: '59' + companyName: Ecker Holiday event + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 618.75 + taxAmount: 123.75 + totalAmount: 742.5 + amountDue: 0 + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2016-09-13T21:19:49Z' + paymentAllocations: + - payment: + id: '159' + reference: '1068' + accountRef: + id: '81' + name: Current + currency: HKD + currencyRate: 0.078807 + paidOnDate: '2016-01-23T00:00:00' + totalAmount: 742.5 + allocation: + currency: HKD + currencyRate: 1 + totalAmount: -742.5 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 711 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/bills?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/bills + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/bills?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '45121' + reference: Order no 1 + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + purchaseOrderRefs: [] + issueDate: '2020-07-22T00:00:00Z' + dueDate: '2020-02-15T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0.5 + subTotal: 0 + taxAmount: 20 + totalAmount: 20 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 2.5 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 100 + taxAmount: 20 + totalAmount: 120 + amountDue: 120 + modifiedDate: '2022-10-14T09:36:01Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: No1 + paymentAllocations: [] + - id: '45131' + reference: Order 2 + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + purchaseOrderRefs: [] + issueDate: '2020-07-22T00:00:00Z' + dueDate: '2020-03-01T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0 + subTotal: 0 + taxAmount: 31.6 + totalAmount: 31.6 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 0 + subTotal: 158 + taxAmount: 0 + totalAmount: 158 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 158 + taxAmount: 31.6 + totalAmount: 189.6 + amountDue: 179.1 + modifiedDate: '2022-10-14T09:36:01Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: No2 + paymentAllocations: + - payment: + id: '45391' + note: ret1 + reference: Return 1 + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 10.5 + pageNumber: 1 + pageSize: 2 + totalResults: 162 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/bills?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/bills + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/bills?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '92' + reference: '2569' + supplierRef: + id: THO001 + supplierName: Thompsons Electricals + purchaseOrderRefs: [] + issueDate: '2021-01-01T00:00:00' + dueDate: '2022-01-31T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Goods + unitAmount: 5875 + quantity: 1 + subTotal: 5000 + taxAmount: 875 + totalAmount: 5875 + accountRef: + id: '5000' + name: Materials Purchased + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_7 + name: Workshop + tracking: + categoryRefs: + - id: department_7 + name: Workshop + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 5000 + taxAmount: 875 + totalAmount: 5875 + amountDue: 0 + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: Goods + paymentAllocations: + - payment: + id: '260' + note: 'Purchase payment 260 linked to, purchase invoice 11, purchase invoice 18, purchase invoice 92, purchase invoice 93.' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 7141.98 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5875 + metadata: + isDeleted: false + - id: '93' + reference: '2570' + supplierRef: + id: THO001 + supplierName: Thompsons Electricals + purchaseOrderRefs: [] + issueDate: '2021-01-15T00:00:00' + dueDate: '2022-02-14T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Goods + unitAmount: 1175 + quantity: 1 + subTotal: 1000 + taxAmount: 175 + totalAmount: 1175 + accountRef: + id: '5000' + name: Materials Purchased + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_7 + name: Workshop + tracking: + categoryRefs: + - id: department_7 + name: Workshop + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 1000 + taxAmount: 175 + totalAmount: 1175 + amountDue: 0 + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: Goods + paymentAllocations: + - payment: + id: '260' + note: 'Purchase payment 260 linked to, purchase invoice 11, purchase invoice 18, purchase invoice 92, purchase invoice 93.' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 7141.98 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1175 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 95 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/bills?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/bills + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/bills?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 15a7a15773b011e8aaa5027d54329956 + reference: 19/06/2018 - 435.60 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + purchaseOrderRefs: [] + issueDate: '2018-06-19T00:00:00' + dueDate: '2018-07-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 11 + quantity: 33 + subTotal: 363 + taxAmount: 72.6 + totalAmount: 435.6 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 363 + taxAmount: 72.6 + totalAmount: 435.6 + amountDue: 405.6 + modifiedDate: '2022-10-24T14:56:08Z' + sourceModifiedDate: '2020-02-05T15:19:28Z' + paymentAllocations: + - payment: + id: f11134e299cb4456be096265136a7770 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: e3e35dcda09642ca8880fc603b0a98e9 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: d9b643b9d6e149f4b443cbc6f22fe1dd + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: cbff2fed2f1641b7bee59f5dd68d29a1 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: 3c3ed62353cf4d148352a14027738dbe + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: 332e402b9d4b4614af82594d186f5f29 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - id: 09034445789211e8aaa5027d54329956 + reference: '25/06/2018 - 1,000.00' + supplierRef: + id: ec716559789111e8aaa5027d54329956 + supplierName: Bagels Limited + purchaseOrderRefs: [] + issueDate: '2018-06-25T00:00:00' + dueDate: '2018-07-25T00:00:00' + currency: USD + currencyRate: 0.752601305 + lineItems: + - description: Bagels + unitAmount: 1000 + quantity: 1 + subTotal: 1000 + taxAmount: 0 + totalAmount: 1000 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + taxRateRef: + id: GB_ZERO + name: Zero Rated 0.00% + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 1000 + taxAmount: 0 + totalAmount: 1000 + amountDue: 0 + modifiedDate: '2022-10-24T14:56:08Z' + sourceModifiedDate: '2022-02-22T13:48:56Z' + paymentAllocations: + - payment: + id: 66d010243e3441ba89a793446eb9c74b + note: Supplier payment using credit/debit card - Test note + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: USD + currencyRate: 0.734679838 + paidOnDate: '2022-02-16T00:00:00' + totalAmount: 1000 + allocation: + currency: USD + currencyRate: 1 + totalAmount: -1000 + pageNumber: 1 + pageSize: 2 + totalResults: 4658 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/bills?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/bills + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/bills?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '4470' + reference: test + supplierRef: + id: '3' + supplierName: ADP + purchaseOrderRefs: [] + issueDate: '2021-10-19T00:00:00' + dueDate: '2021-10-29T00:00:00' + currency: GBP + lineItems: + - unitAmount: 25 + quantity: 1 + subTotal: 25 + taxAmount: 0 + totalAmount: 25 + accountRef: + id: '3' + name: Accounts Payable + taxRateRef: + id: '82' + name: UK Purchase Goods Zero Rate + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + tracking: + categoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 25 + taxAmount: 0 + totalAmount: 25 + amountDue: 0 + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2022-02-23T12:06:58' + note: '' + paymentAllocations: + - payment: + id: '4471' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2022-01-06T00:00:00' + totalAmount: 20 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -20 + - payment: + id: '4472' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2022-01-06T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + metadata: + isDeleted: false + - id: '4705' + reference: JohnAndRob + supplierRef: + id: '8' + supplierName: Worldwide Commercial + purchaseOrderRefs: [] + issueDate: '2022-02-04T00:00:00' + dueDate: '2022-02-19T00:00:00' + currency: USD + currencyRate: 14 + lineItems: + - description: Some text for a description + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + accountRef: + id: '3' + name: Accounts Payable + taxRateRef: + id: '49' + name: EC Purchase Goods Zero Rate + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + tracking: + categoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + amountDue: 10 + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2022-04-22T12:24:59' + note: Some note on my bill + paymentAllocations: [] + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 17 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/bills?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/bills + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/bills?page=2&pageSize=2 + Xero: + value: + results: + - id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + reference: '' + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + purchaseOrderRefs: [] + issueDate: '2021-11-19T00:00:00' + dueDate: '2021-12-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Half day training - Microsoft Office + unitAmount: 1800 + quantity: 1 + discountAmount: 0 + subTotal: 1800 + taxAmount: 360 + totalAmount: 2160 + discountPercentage: 0 + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + name: Consulting + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: 489558f5-27b7-4f37-ad9f-d84611c2e2ab + name: Half day training - Microsoft Office + trackingCategoryRefs: [] + isDirectCost: false + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 4000 + quantity: 1 + discountAmount: 0 + subTotal: 4000 + taxAmount: 800 + totalAmount: 4800 + discountPercentage: 0 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: f8fb7e00-5e5d-466c-aef0-15861f73d04f + name: Desktop/network support via email & phone + trackingCategoryRefs: [] + isDirectCost: false + - description: Stationery charges + unitAmount: 32 + quantity: 8 + discountAmount: 0 + subTotal: 256 + taxAmount: 51.2 + totalAmount: 307.2 + discountPercentage: 0 + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 6056 + taxAmount: 1211.2 + totalAmount: 7267.2 + amountDue: 0 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-02T21:07:23' + paymentAllocations: + - payment: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2021-12-20T00:00:00' + totalAmount: 7267.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7267.2 + metadata: + isDeleted: false + - id: 09aa506f-cb81-4cd3-a1ea-6a0b91804d5a + reference: '' + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + purchaseOrderRefs: [] + issueDate: '2022-01-17T00:00:00' + dueDate: '2022-02-17T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Half day training - Microsoft Office + unitAmount: 1800 + quantity: 1 + discountAmount: 0 + subTotal: 1800 + taxAmount: 360 + totalAmount: 2160 + discountPercentage: 0 + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + name: Consulting + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: 489558f5-27b7-4f37-ad9f-d84611c2e2ab + name: Half day training - Microsoft Office + trackingCategoryRefs: [] + isDirectCost: false + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 4000 + quantity: 1 + discountAmount: 0 + subTotal: 4000 + taxAmount: 800 + totalAmount: 4800 + discountPercentage: 0 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: f8fb7e00-5e5d-466c-aef0-15861f73d04f + name: Desktop/network support via email & phone + trackingCategoryRefs: [] + isDirectCost: false + - description: Stationery charges + unitAmount: 32 + quantity: 8 + discountAmount: 0 + subTotal: 256 + taxAmount: 51.2 + totalAmount: 307.2 + discountPercentage: 0 + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 6056 + taxAmount: 1211.2 + totalAmount: 7267.2 + amountDue: 0 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-02T21:06:22' + paymentAllocations: + - payment: + id: f2062172-b444-4c8b-b797-9f4c7a4244c7 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-17T00:00:00' + totalAmount: 7267.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7267.2 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 44 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/bills?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/bills + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/bills?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000152027' + reference: '1' + supplierRef: + id: '104957000000152001' + supplierName: Mr. P N + purchaseOrderRefs: [] + issueDate: '2020-06-23T00:00:00' + dueDate: '2020-06-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + withholdingTax: [] + status: Paid + subTotal: 0 + taxAmount: 0 + totalAmount: 10 + amountDue: 0 + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-06-23T13:47:17' + paymentAllocations: [] + - id: '104957000000152067' + reference: '2' + supplierRef: + id: '104957000000152001' + supplierName: Mr. P N + purchaseOrderRefs: [] + issueDate: '2020-06-23T00:00:00' + dueDate: '2020-06-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + withholdingTax: [] + status: Paid + subTotal: 0 + taxAmount: 0 + totalAmount: 12 + amountDue: 0 + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-11-04T13:07:23' + paymentAllocations: [] + pageNumber: 1 + pageSize: 2 + totalResults: 36 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/bills?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/bills + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/bills?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *List bills* endpoint returns a list of [bills](https://docs.codat.io/lending-api#/schemas/Bill) for a given company's connection. + + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + ### Tips and traps + + To access the `paymentAllocations` property, ensure that the `billPayments` data type is queued and cached in Codat before retrieving `bills` from Codat's cache. + operationId: list-accounting-bills + x-speakeasy-group: accounts-payable.bills + '/companies/{companyId}/data/bills/{billId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/accountingBillId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBill' + examples: + Clear Books: + value: + id: 81539597-e681-40c9-a4dd-ec2fffcde572 + reference: b465a2c9-3212-4620-889b-6328ba148215 + supplierRef: + id: 8GeHBdBZiZ + supplierName: 'DuBuque, Goyette and Franecki' + purchaseOrderRefs: [] + issueDate: '2022-04-29T00:00:00' + dueDate: '2022-05-06T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Grease Trap + unitAmount: 2781.94 + quantity: 5 + discountAmount: 0 + subTotal: 13909.7 + taxAmount: 1390.97 + totalAmount: 15300.67 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 5 + discountAmount: 0 + subTotal: 6856.95 + taxAmount: 685.7 + totalAmount: 7542.65 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 6 + discountAmount: 0 + subTotal: 8228.34 + taxAmount: 822.83 + totalAmount: 9051.17 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 2781.94 + quantity: 3 + discountAmount: 0 + subTotal: 8345.82 + taxAmount: 834.58 + totalAmount: 9180.4 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Trapped Road Gully 450mm x 450mm + unitAmount: 402.89 + quantity: 8 + discountAmount: 0 + subTotal: 3223.12 + taxAmount: 322.31 + totalAmount: 3545.43 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + name: Heavy Duty Hinged Gully Grating + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 7 + discountAmount: 0 + subTotal: 665.56 + taxAmount: 66.56 + totalAmount: 732.12 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 1 + discountAmount: 0 + subTotal: 95.08 + taxAmount: 9.51 + totalAmount: 104.59 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 2 + discountAmount: 0 + subTotal: 2742.78 + taxAmount: 274.28 + totalAmount: 3017.06 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 2781.94 + quantity: 1 + discountAmount: 0 + subTotal: 2781.94 + taxAmount: 278.19 + totalAmount: 3060.13 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + unitAmount: 95.08 + quantity: 7 + discountAmount: 0 + subTotal: 665.56 + taxAmount: 66.56 + totalAmount: 732.12 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1251.89 + quantity: 4 + discountAmount: 0 + subTotal: 5007.56 + taxAmount: 500.76 + totalAmount: 5508.32 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 51077072-d5c3-463b-9cb4-7da2e11886f9 + name: 150 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + - description: Grease Trap + unitAmount: 1371.39 + quantity: 9 + discountAmount: 0 + subTotal: 12342.51 + taxAmount: 1234.25 + totalAmount: 13576.76 + discountPercentage: 0 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 64864.92 + taxAmount: 6486.5 + totalAmount: 71351.42 + amountDue: 0 + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2023-02-14T17:09:02' + note: 'Bill with 12 line items, totaling 71351.42' + paymentAllocations: + - payment: + id: dcb18480-8b69-44d8-aa26-268b6a80d170 + note: Bill Payment against bill 81539597-e681-40c9-a4dd-ec2fffcde572 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-06T00:00:00' + totalAmount: 71351.42 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-06T00:00:00' + totalAmount: -71351.42 + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 4019ee2b-d05a-ed11-8c34-000d3a0d28a2-108276 + reference: '108276' + supplierRef: + id: c01217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: First Up Consultants + purchaseOrderRefs: [] + issueDate: '2019-01-01T00:00:00' + dueDate: '2019-01-01T00:00:00' + currency: GBP + lineItems: + - description: ATHENS Desk + unitAmount: 506.6 + quantity: 4 + discountAmount: 202.64 + subTotal: 1823.76 + taxAmount: 364.75 + totalAmount: 2188.51 + discountPercentage: 10 + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-c81217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'ATHENS Desk / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 1823.76 + taxAmount: 364.75 + totalAmount: 2188.51 + amountDue: 2188.51 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-11-02T17:02:48Z' + note: '129148' + paymentAllocations: [] + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 1c55118b-793e-4437-9c13-4f554b9ca989 + reference: '19600006' + supplierRef: + id: 5e6f49b9-6489-4b82-83e7-291d308919bb + supplierName: Mickey Mouse + purchaseOrderRefs: [] + issueDate: '2019-12-16T00:00:00Z' + dueDate: '2019-11-09T00:00:00Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Cheesecake + unitAmount: 10 + quantity: 1 + discountAmount: 0 + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + accountRef: + id: 5f139759-b554-4314-862e-b9d88e5b2e1b + name: Af te dragen loonheffing + taxRateRef: + id: 84277189-ad16-456c-b501-ca31f0a483cc + name: BTW prive gebruik + effectiveTaxRate: 21 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 10 + taxAmount: 2.1 + totalAmount: 12.1 + amountDue: 0 + modifiedDate: '2022-10-26T13:32:18Z' + sourceModifiedDate: '2020-01-03T15:06:02Z' + paymentAllocations: + - payment: + id: d9a2980b-2a43-46f2-9c7f-413d925b3cdd + reference: '20200032' + accountRef: + id: d79d65bd-1d7d-4f55-95d3-76b3a7b7b823 + name: Bank 1 + currency: EUR + currencyRate: 1 + paidOnDate: '2021-03-22T00:00:00' + totalAmount: 12.1 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: -12.1 + Exact (UK): + value: + id: e7a45898-2db3-424c-acb9-a51647740f26 + reference: '17600002' + supplierRef: + id: a7cad20d-44db-442b-ac1f-90475802d6fb + supplierName: Pencils Pencils Pencils + purchaseOrderRefs: [] + issueDate: '2017-09-26T00:00:00Z' + dueDate: '2017-10-26T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Stationery + unitAmount: 400 + quantity: 2 + discountAmount: 0 + subTotal: 800 + taxAmount: 160 + totalAmount: 960 + accountRef: + id: e5e9e994-0f14-4614-b162-7b5593b21276 + name: Finished Goods Stock + taxRateRef: + id: 63cd143a-66ab-4320-8a6d-ab6be85ed048 + name: UK purchases standard rate � Excluding + effectiveTaxRate: 20 + itemRef: + id: '001' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 800 + taxAmount: 160 + totalAmount: 960 + amountDue: 0 + modifiedDate: '2022-10-26T13:33:20Z' + sourceModifiedDate: '2019-01-11T14:18:17Z' + paymentAllocations: + - payment: + id: 7a5f621b-739f-4ed8-b738-2aae3ef886ac + reference: '17200006' + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2017-10-11T00:00:00' + totalAmount: 123 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -123 + FreeAgent: + value: + id: '16609552' + reference: MATT - U + supplierRef: + id: '7169654' + supplierName: The Eagle + purchaseOrderRefs: [] + issueDate: '2014-08-21T00:00:00' + dueDate: '2018-09-20T00:00:00' + currency: GBP + lineItems: + - unitAmount: 125 + quantity: 1 + taxAmount: 25 + totalAmount: 150 + accountRef: + id: '285' + name: Accommodation and Meals + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 125 + taxAmount: 25 + totalAmount: 150 + amountDue: 150 + modifiedDate: '2023-04-25T14:19:10Z' + sourceModifiedDate: '2020-11-11T12:48:55Z' + paymentAllocations: [] + metadata: + isDeleted: false + FreshBooks: + value: + id: '27' + supplierRef: + id: '87' + purchaseOrderRefs: [] + issueDate: '2021-04-26T00:00:00' + dueDate: '2021-05-26T00:00:00' + currency: USD + lineItems: + - description: Grocery + unitAmount: 50 + quantity: 1 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + accountRef: + id: '3384197' + name: Advertising + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + amountDue: 50 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-04-26T19:34:22' + paymentAllocations: [] + metadata: + isDeleted: false + KashFlow: + value: + id: '97615244' + reference: '25' + supplierRef: + id: '9272052' + supplierName: Supplier man + purchaseOrderRefs: [] + issueDate: '2000-01-01T00:00:00' + dueDate: '2000-01-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '' + unitAmount: 8.33 + quantity: 1 + subTotal: 8.33 + taxAmount: 1.67 + totalAmount: 10 + accountRef: + id: '21481884' + name: Computer equipment cost + itemRef: + id: '122990246' + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 8.33 + taxAmount: 1.67 + totalAmount: 10 + amountDue: 0 + modifiedDate: '2022-09-30T10:29:15Z' + paymentAllocations: [] + Oracle NetSuite: + value: + id: '7' + supplierRef: + id: '724' + supplierName: Vendor A.A.A + purchaseOrderRefs: [] + issueDate: '2021-03-26T00:00:00' + dueDate: '2021-03-26T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 120 + quantity: 1 + unitOfMeasurement: litre + subTotal: 120 + totalAmount: 120 + accountRef: + id: '716' + name: Inventory In Transit + trackingCategoryRefs: + - id: location-4 + name: Europe + tracking: + categoryRefs: + - id: location-4 + name: Europe + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 120 + taxAmount: 24 + totalAmount: 144 + amountDue: 24 + modifiedDate: '2023-01-30T14:47:34Z' + sourceModifiedDate: '2022-07-05T13:38:10' + paymentAllocations: + - payment: + id: '112' + reference: 'Bill Payment #1' + accountRef: + id: '825' + name: Codat Europe Bank + currency: GBP + currencyRate: 1 + paidOnDate: '2021-03-26T00:00:00' + totalAmount: 120 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -120 + QuickBooks Desktop: + value: + id: 3691-1071520776 + reference: '3847498' + supplierRef: + id: B0000-933272656 + supplierName: Patton Hardware Supplies + purchaseOrderRefs: + - id: 3684-1071520443 + purchaseOrderNumber: '6225' + issueDate: '2022-12-02T00:00:00' + dueDate: '2024-01-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: "Cabinets:Light Pine - Light pine kitchen cabinet wall unit \n#CLD- 1235-p" + unitAmount: 1500 + quantity: 5 + discountAmount: 0 + subTotal: 7500 + taxAmount: 0 + totalAmount: 7500 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 110000-933272656 + name: 'Cabinets:Light Pine' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + - description: 'Hardware:Doorknobs Std - Doorknobs Part # DK 3704' + unitAmount: 27 + quantity: 100 + discountAmount: 0 + subTotal: 2700 + taxAmount: 0 + totalAmount: 2700 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 130000-933272656 + name: 'Hardware:Doorknobs Std' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + - description: 'Hardware:Lk Doorknobs - Locking interior doorknobs Part # DK415' + unitAmount: 34.95 + quantity: 100 + discountAmount: 0 + subTotal: 3495 + taxAmount: 0 + totalAmount: 3495 + discountPercentage: 0 + accountRef: + id: C0000-933270541 + name: Accounts Payable + itemRef: + id: 140000-933272656 + name: 'Hardware:Lk Doorknobs' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + tracking: + categoryRefs: + - id: 10000-933272658 + name: New Construction + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 13695 + taxAmount: 0 + totalAmount: 13695 + amountDue: 0 + modifiedDate: '2023-04-26T09:06:42Z' + sourceModifiedDate: '2023-12-16T05:06:30' + paymentAllocations: + - payment: + id: 36AD-1071520917 + note: RC 93 + reference: '484' + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2024-12-05T00:00:00' + totalAmount: 5325 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5000 + - payment: + id: 9E4C-1182131999 + reference: '115' + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-31T00:00:00' + totalAmount: 13759 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8695 + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '18' + reference: '12' + supplierRef: + id: '4' + supplierName: BILLy elliot + purchaseOrderRefs: [] + issueDate: '2019-05-13T00:00:00' + dueDate: '2019-05-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 5 + quantity: 1 + discountAmount: 0 + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + accountRef: + id: '16' + name: Advertising + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 5 + taxAmount: 0 + totalAmount: 5 + amountDue: 0 + modifiedDate: '2023-01-18T11:02:41Z' + sourceModifiedDate: '2022-05-26T10:34:10Z' + paymentAllocations: + - payment: + id: '20' + currency: GBP + currencyRate: 1 + paidOnDate: '2019-05-13T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + QuickBooks Online Sandbox: + value: + id: '157' + supplierRef: + id: '57' + supplierName: Hall's Promo Items + purchaseOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-01-16T00:00:00' + currency: HKD + currencyRate: 0.081142 + lineItems: + - description: Water bottles -- generic + unitAmount: 66.1717023 + quantity: 100 + discountAmount: 0 + subTotal: 6617.17 + taxAmount: 1323.43 + totalAmount: 7940.6 + taxRateRef: + id: 3_Bills + name: 20.0% S Bills + effectiveTaxRate: 20 + itemRef: + id: '19' + name: Water Bottles + trackingCategoryRefs: [] + tracking: + categoryRefs: [] + customerRef: + id: '55' + companyName: Oxon Insurance - Holiday Party + isBilledTo: Unknown + isRebilledTo: NotApplicable + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 6617.17 + taxAmount: 1323.43 + totalAmount: 7940.6 + amountDue: 0 + modifiedDate: '2023-04-26T09:35:58Z' + sourceModifiedDate: '2023-01-26T11:20:45Z' + paymentAllocations: + - payment: + id: '158' + reference: '1067' + accountRef: + id: '81' + name: Current + currency: HKD + currencyRate: 0.078807 + paidOnDate: '2016-01-23T00:00:00' + totalAmount: 7940.6 + allocation: + currency: HKD + currencyRate: 1 + totalAmount: -7940.6 + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '45121' + reference: Order no 1 + supplierRef: + id: CON001 + supplierName: Concept Stationery Supplies + purchaseOrderRefs: [] + issueDate: '2020-07-22T00:00:00Z' + dueDate: '2020-02-15T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Tax Rate 1 + unitAmount: 0 + quantity: 0 + discountAmount: 0.5 + subTotal: 0 + taxAmount: 20 + totalAmount: 20 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 2.5 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Open + subTotal: 100 + taxAmount: 20 + totalAmount: 120 + amountDue: 120 + modifiedDate: '2022-10-14T09:36:01Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: No1 + paymentAllocations: [] + Sage 50 (UK): + value: + id: '92' + reference: '2569' + supplierRef: + id: THO001 + supplierName: Thompsons Electricals + purchaseOrderRefs: [] + issueDate: '2021-01-01T00:00:00' + dueDate: '2022-01-31T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Goods + unitAmount: 5875 + quantity: 1 + subTotal: 5000 + taxAmount: 875 + totalAmount: 5875 + accountRef: + id: '5000' + name: Materials Purchased + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_7 + name: Workshop + tracking: + categoryRefs: + - id: department_7 + name: Workshop + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 5000 + taxAmount: 875 + totalAmount: 5875 + amountDue: 0 + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: Goods + paymentAllocations: + - payment: + id: '260' + note: 'Purchase payment 260 linked to, purchase invoice 11, purchase invoice 18, purchase invoice 92, purchase invoice 93.' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 7141.98 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5875 + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: 15a7a15773b011e8aaa5027d54329956 + reference: 19/06/2018 - 435.60 + supplierRef: + id: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + purchaseOrderRefs: [] + issueDate: '2018-06-19T00:00:00' + dueDate: '2018-07-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 11 + quantity: 33 + subTotal: 363 + taxAmount: 72.6 + totalAmount: 435.6 + accountRef: + id: 9a995955267a11e797950a57719b2edb + name: Cost of sales - goods + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: PartiallyPaid + subTotal: 363 + taxAmount: 72.6 + totalAmount: 435.6 + amountDue: 405.6 + modifiedDate: '2022-10-24T14:56:08Z' + sourceModifiedDate: '2020-02-05T15:19:28Z' + paymentAllocations: + - payment: + id: 332e402b9d4b4614af82594d186f5f29 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: 3c3ed62353cf4d148352a14027738dbe + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: cbff2fed2f1641b7bee59f5dd68d29a1 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: d9b643b9d6e149f4b443cbc6f22fe1dd + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: e3e35dcda09642ca8880fc603b0a98e9 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: f11134e299cb4456be096265136a7770 + note: Supplier payment using credit/debit card - string + accountRef: + id: 92b80ba619d34cafbedd0eb2e69a82f7 + name: ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + Sage Intacct: + value: + id: '4470' + reference: test + supplierRef: + id: '3' + supplierName: ADP + purchaseOrderRefs: [] + issueDate: '2021-10-19T00:00:00' + dueDate: '2021-10-29T00:00:00' + currency: GBP + lineItems: + - unitAmount: 25 + quantity: 1 + subTotal: 25 + taxAmount: 0 + totalAmount: 25 + accountRef: + id: '3' + name: Accounts Payable + taxRateRef: + id: '82' + name: UK Purchase Goods Zero Rate + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + tracking: + categoryRefs: + - id: DEPARTMENT-3 + name: Admin + - id: LOCATION-11 + name: Codat Test Entity + isBilledTo: Unknown + isRebilledTo: Unknown + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 25 + taxAmount: 0 + totalAmount: 25 + amountDue: 0 + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2022-02-23T12:06:58' + note: '' + paymentAllocations: + - payment: + id: '4472' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2022-01-06T00:00:00' + totalAmount: 5 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: '4471' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2022-01-06T00:00:00' + totalAmount: 20 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -20 + metadata: + isDeleted: false + Xero: + value: + id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + reference: '' + supplierRef: + id: 1262c350-fe0f-40ec-aeff-41c95b4a45af + supplierName: DIISR - Small Business Services + purchaseOrderRefs: [] + issueDate: '2021-11-19T00:00:00' + dueDate: '2021-12-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Half day training - Microsoft Office + unitAmount: 1800 + quantity: 1 + discountAmount: 0 + subTotal: 1800 + taxAmount: 360 + totalAmount: 2160 + discountPercentage: 0 + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + name: Consulting + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: 489558f5-27b7-4f37-ad9f-d84611c2e2ab + name: Half day training - Microsoft Office + trackingCategoryRefs: [] + isDirectCost: false + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 4000 + quantity: 1 + discountAmount: 0 + subTotal: 4000 + taxAmount: 800 + totalAmount: 4800 + discountPercentage: 0 + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + itemRef: + id: f8fb7e00-5e5d-466c-aef0-15861f73d04f + name: Desktop/network support via email & phone + trackingCategoryRefs: [] + isDirectCost: false + - description: Stationery charges + unitAmount: 32 + quantity: 8 + discountAmount: 0 + subTotal: 256 + taxAmount: 51.2 + totalAmount: 307.2 + discountPercentage: 0 + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectCost: false + withholdingTax: [] + status: Paid + subTotal: 6056 + taxAmount: 1211.2 + totalAmount: 7267.2 + amountDue: 0 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-02T21:07:23' + paymentAllocations: + - payment: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2021-12-20T00:00:00' + totalAmount: 7267.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7267.2 + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000152027' + reference: '1' + supplierRef: + id: '104957000000152001' + supplierName: Mr. P N + purchaseOrderRefs: [] + issueDate: '2020-06-23T00:00:00' + dueDate: '2020-06-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + withholdingTax: [] + status: Paid + subTotal: 0 + taxAmount: 0 + totalAmount: 10 + amountDue: 0 + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-06-23T13:47:17' + paymentAllocations: [] + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get bill + description: | + The *Get bill* endpoint returns a single bill for a given billId. + + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + ### Tips and traps + + To access the `paymentAllocations` property, ensure that the `billPayments` data type is queued and cached in Codat before retrieving `bills` from Codat's cache. + operationId: get-accounting-bill + x-speakeasy-group: accounts-payable.bills + '/companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingBillId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: list-accounting-bill-attachments + x-speakeasy-group: accounts-payable.bills + summary: List bill attachments + description: | + The *List bill attachments* endpoint returns a list of attachments available to download for a given `billId`. + + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + '/companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingBillId' + get: + tags: + - Accounts payable + parameters: + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get bill attachment + description: |- + The *Get bill attachment* endpoint returns a specific attachment for a given `billId` and `attachmentId`. + + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + operationId: get-accounting-bill-attachment + x-speakeasy-group: accounts-payable.bills + '/companies/{companyId}/connections/{connectionId}/data/bills/{billId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingBillId' + get: + tags: + - Accounts payable + parameters: + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Download bill attachment + description: |- + The *Download bill attachment* endpoint downloads a specific attachment for a given `billId` and `attachmentId`. + + [Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + operationId: download-accounting-bill-attachment + x-speakeasy-group: accounts-payable.bills + '/companies/{companyId}/data/creditNotes': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + summary: List credit notes + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreditNotes' + examples: + Dynamics 365 Business Central: + value: + results: + - id: e6e5ec0f-1c60-eb11-89fa-00224800a9c7 + creditNoteNumber: '104001' + customerRef: + id: 8ddfa6bf-0c60-eb11-89fa-00224800af18 + companyName: Abdi Company + withholdingTax: [] + totalAmount: 105 + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 5 + discountPercentage: 0 + remainingCredit: 80 + status: PartiallyPaid + issueDate: '2021-01-25T00:00:00' + currency: GBP + lineItems: + - description: 'Invoice No. 103221:' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Linda Martin + unitAmount: 100 + quantity: 1 + discountAmount: 0 + subTotal: 100 + taxAmount: 5 + totalAmount: 105 + accountRef: + id: 161217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 'Income, Services' + discountPercentage: 0 + taxRateRef: + id: 61bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / REDUCED + effectiveTaxRate: 5 + itemRef: + id: RESC-331317b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'Linda Martin / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectIncome: false + - description: Credit memo for partially paid inv + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 62e5046d-1c60-eb11-89fa-00224800a9c7 + note: Credit Memo 1001 + reference: 'Document No: 104001' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-25T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-25T00:00:00' + totalAmount: 25 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2021-01-26T21:21:18Z' + metadata: + isDeleted: false + - id: d0d9b378-1d60-eb11-89fa-00224800a9c7 + creditNoteNumber: '104002' + customerRef: + id: 8ddfa6bf-0c60-eb11-89fa-00224800af18 + companyName: Abdi Company + withholdingTax: [] + totalAmount: 779.28 + totalDiscount: 0 + subTotal: 649.4 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 129.88 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2021-01-26T00:00:00' + currency: GBP + lineItems: + - description: 'Invoice No. 103222:' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: 'Inv. No. 103222 - Shpt. No. 102222:' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: ATHENS Desk -pay with CR + unitAmount: 649.4 + quantity: 1 + discountAmount: 0 + subTotal: 649.4 + taxAmount: 129.88 + totalAmount: 779.28 + accountRef: + id: 181217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 'Income, Product Sales' + discountPercentage: 0 + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-c81217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'ATHENS Desk / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectIncome: false + - description: '' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: c2942210-1e60-eb11-89fa-00224800a9c7 + note: Credit Memo 1002 + reference: 'Document No: 104002' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-26T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-26T00:00:00' + totalAmount: 779.28 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2021-01-26T21:33:01Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 13 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/creditNotes + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/creditNotes?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '21952211' + creditNoteNumber: '004' + customerRef: + id: '6162023' + companyName: Alderley plc + withholdingTax: [] + totalAmount: 165 + totalDiscount: 0 + subTotal: 165 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-10-18T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Reverse 6546 + unitAmount: 110 + quantity: 1.5 + subTotal: 165 + taxAmount: 0 + totalAmount: 165 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '270764400' + note: �165.00 - Credit Note refund against 004 + currency: GBP + paidOnDate: '2020-12-23T00:00:00' + totalAmount: -165 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 165 + modifiedDate: '2023-04-25T14:19:09Z' + sourceModifiedDate: '2020-12-23T16:39:23Z' + metadata: + isDeleted: false + - id: '53604300' + creditNoteNumber: '2367' + customerRef: + id: '6162023' + companyName: Alderley plc + withholdingTax: [] + totalAmount: 165 + totalDiscount: 0 + subTotal: 165 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 165 + status: Draft + issueDate: '2017-10-18T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Reverse 6546 + unitAmount: 110 + quantity: 1.5 + subTotal: 165 + taxAmount: 0 + totalAmount: 165 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2023-04-25T14:19:09Z' + sourceModifiedDate: '2022-09-29T13:00:09Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 281 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/creditNotes + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/creditNotes?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '33407' + creditNoteNumber: '0000065' + customerRef: + id: '511657' + companyName: Bob's Stationary + withholdingTax: [] + totalAmount: 150 + totalDiscount: 0 + subTotal: 150 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Submitted + issueDate: '2020-07-31T00:00:00' + currency: GBP + lineItems: + - description: Test Di + unitAmount: 150 + quantity: 1 + subTotal: 150 + taxAmount: 0 + totalAmount: 150 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '2054019' + note: Free $150 voucher + currency: GBP + paidOnDate: '2020-07-31T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 150 + modifiedDate: '2023-03-24T16:07:23Z' + note: Free $150 voucher + metadata: + isDeleted: false + - id: '33409' + creditNoteNumber: '0000066' + customerRef: + id: '511657' + companyName: Bob's Stationary + withholdingTax: [] + totalAmount: 300 + totalDiscount: 0 + subTotal: 300 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Draft + issueDate: '2020-07-31T00:00:00' + currency: GBP + lineItems: + - description: Test Di + unitAmount: 150 + quantity: 2 + subTotal: 300 + taxAmount: 0 + totalAmount: 300 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '2054021' + note: Free $150 voucher + currency: GBP + paidOnDate: '2020-07-31T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 300 + modifiedDate: '2023-03-24T16:07:23Z' + note: Free $150 voucher + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 53 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/creditNotes + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/creditNotes?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '85322315' + creditNoteNumber: '4' + customerRef: + id: '69946501' + companyName: Peter Lord + withholdingTax: [] + totalAmount: 100 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-05-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: youm + unitAmount: 100 + quantity: -1 + subTotal: -100 + taxAmount: 0 + totalAmount: 100 + accountRef: + id: '21481817' + name: Sale of goods + itemRef: + id: '158667064' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '86870120' + note: Applying Credit Note + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -100 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 100 + modifiedDate: '2022-09-30T10:29:16Z' + - id: '85326016' + creditNoteNumber: '5' + customerRef: + id: '69952389' + companyName: Things Limited + withholdingTax: [] + totalAmount: 1000 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-05-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: '158675173' + unitAmount: 1 + quantity: -1000 + subTotal: -1000 + taxAmount: 0 + totalAmount: 1000 + accountRef: + id: '21481817' + name: Sale of goods + itemRef: + id: '158675173' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '86873915' + note: Applying Credit Note + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -400 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 400 + - payment: + id: '86874181' + note: '' + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -100 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 100 + - payment: + id: '86874199' + note: '' + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -50 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 50 + - payment: + id: '86875655' + note: Credit Note + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -750 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 750 + modifiedDate: '2022-09-30T10:29:16Z' + pageNumber: 1 + pageSize: 2 + totalResults: 17 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/creditNotes + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/creditNotes?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '8827' + creditNoteNumber: CM27 + customerRef: + id: '417' + companyName: 10 Breww Ltd + withholdingTax: [] + totalAmount: 26 + totalDiscount: 0 + subTotal: 26 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 26 + status: Submitted + issueDate: '2021-04-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Andy Test Item + unitAmount: 2 + quantity: 3 + subTotal: 6 + totalAmount: 6 + accountRef: + id: '54' + name: Sales + itemRef: + id: '143' + name: Andy Test Item + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + - description: Non-Recurring Services - EC + unitAmount: 4 + quantity: 5 + subTotal: 20 + totalAmount: 20 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2022-09-20T08:15:31Z' + sourceModifiedDate: '2022-02-25T10:58:10' + - id: '8828' + creditNoteNumber: CM28 + customerRef: + id: '417' + companyName: 10 Breww Ltd + withholdingTax: [] + totalAmount: 26 + totalDiscount: 0 + subTotal: 26 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 10 + status: PartiallyPaid + issueDate: '2021-04-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Andy Test Item + unitAmount: 2 + quantity: 3 + subTotal: 6 + totalAmount: 6 + accountRef: + id: '54' + name: Sales + itemRef: + id: '143' + name: Andy Test Item + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + - description: Non-Recurring Services - EC + unitAmount: 4 + quantity: 5 + subTotal: 20 + totalAmount: 20 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + paymentAllocations: + - payment: + id: '8828' + reference: 'Credit Memo #CM28' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-04-09T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 16 + modifiedDate: '2022-09-20T08:15:31Z' + sourceModifiedDate: '2022-02-25T10:58:37' + pageNumber: 1 + pageSize: 2 + totalResults: 36 + _links: + current: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/creditNotes + next: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/creditNotes?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 96C-933372931 + creditNoteNumber: '4002' + customerRef: + id: 150000-933272658 + companyName: 'Abercrombie, Kristy' + withholdingTax: [] + totalAmount: 711.15 + totalDiscount: 0 + subTotal: 660 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 51.15 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2024-12-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: |- + Whirlpool tub + Billed and paid for 2 tubs, should have been for only 1 tub + unitAmount: 660 + quantity: 1 + subTotal: 660 + taxAmount: 0 + totalAmount: 660 + accountRef: + id: 40000-933270541 + name: Accounts Receivable + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1E0000-933272656 + name: Plumb Fixtrs + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + paymentAllocations: + - payment: + id: 969-933372844 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2024-12-01T00:00:00' + totalAmount: -711.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 711.15 + modifiedDate: '2023-04-26T09:07:38Z' + sourceModifiedDate: '2023-12-16T05:04:05' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/creditNotes + QuickBooks Online: + value: + results: + - id: '85' + creditNoteNumber: '3122019_6' + customerRef: + id: '3' + companyName: Information Sharing Technology + withholdingTax: [] + totalAmount: 13.53 + totalDiscount: 0 + subTotal: 13.53 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-12-03T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refunds with payment type of Cash + unitAmount: 13.53 + quantity: 1 + subTotal: 13.53 + taxAmount: 0 + totalAmount: 13.53 + accountRef: + id: '1' + name: Sales + taxRateRef: + id: 8_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + itemRef: + id: '1' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: true + paymentAllocations: + - payment: + id: '85' + note: '' + accountRef: + id: '63' + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2019-12-03T00:00:00' + totalAmount: -13.53 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-12-03T00:00:00' + totalAmount: 13.53 + modifiedDate: '2023-01-18T11:02:55Z' + sourceModifiedDate: '2019-12-10T19:00:36Z' + - id: '86' + creditNoteNumber: '3122019_66' + customerRef: + id: '3' + companyName: Information Sharing Technology + withholdingTax: [] + totalAmount: 1 + totalDiscount: 0 + subTotal: 1 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-12-03T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refunds with payment type of Card + unitAmount: 1 + quantity: 1 + subTotal: 1 + taxAmount: 0 + totalAmount: 1 + accountRef: + id: '1' + name: Sales + taxRateRef: + id: 8_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + itemRef: + id: '1' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: true + paymentAllocations: + - payment: + id: '86' + note: '' + accountRef: + id: '63' + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2019-12-03T00:00:00' + totalAmount: -1 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-12-03T00:00:00' + totalAmount: 1 + modifiedDate: '2023-01-18T11:02:55Z' + sourceModifiedDate: '2019-12-10T19:00:37Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1253 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/creditNotes + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/creditNotes?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '185' + creditNoteNumber: '1015' + customerRef: + id: '16' + companyName: Jordan Burgess + withholdingTax: [] + totalAmount: 1800 + totalDiscount: 0 + subTotal: 1500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 300 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-02-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Employee training off site + unitAmount: 1500 + quantity: 1 + subTotal: 1500 + taxAmount: 300 + totalAmount: 1800 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '5' + name: Employee Training + trackingCategoryRefs: + - id: DEPARTMENT_1 + name: London + isDirectIncome: false + paymentAllocations: + - payment: + id: '192' + note: Created by QB Online to link credits to charges. + currency: GBP + currencyRate: 1 + paidOnDate: '2017-09-08T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 1800 + modifiedDate: '2023-04-26T09:36:03Z' + sourceModifiedDate: '2017-09-08T12:52:27Z' + metadata: + isDeleted: false + - id: '213' + creditNoteNumber: '1030' + customerRef: + id: '5' + companyName: Whitehead and Sons + withholdingTax: [] + totalAmount: 600 + totalDiscount: 0 + subTotal: 500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 100 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2018-12-18T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Employee celebration -- Anniversary / Retirement + unitAmount: 500 + quantity: 1 + subTotal: 500 + taxAmount: 100 + totalAmount: 600 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '4' + name: Employee Celebration + trackingCategoryRefs: + - id: DEPARTMENT_3 + name: Birmingham + isDirectIncome: false + paymentAllocations: + - payment: + id: '215' + note: Created by QB Online to link credits to charges. + currency: GBP + currencyRate: 1 + paidOnDate: '2018-12-18T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 600 + modifiedDate: '2023-04-26T09:36:03Z' + sourceModifiedDate: '2018-12-18T10:08:45Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 141 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/creditNotes + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/creditNotes?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '45891' + creditNoteNumber: return 1a + customerRef: + id: A1D001 + companyName: A1 Design Services + withholdingTax: [] + totalAmount: 378 + totalDiscount: 9.46 + subTotal: 315 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 63 + discountPercentage: 2.5 + remainingCredit: 378 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Standard rate + unitAmount: 0 + quantity: 0 + discountAmount: 1.58 + subTotal: 0 + taxAmount: 63 + totalAmount: 63 + taxRateRef: + id: '1' + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 9.46 + subTotal: 315 + taxAmount: 0 + totalAmount: 315 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2022-10-14T09:35:55Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: black + - id: '45901' + creditNoteNumber: return 003 + customerRef: + id: ABS001 + companyName: ABS Garages Ltd + withholdingTax: [] + totalAmount: 177.14 + totalDiscount: 4.42 + subTotal: 147.62 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 29.52 + discountPercentage: 2.5 + remainingCredit: 177.14 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Standard rate + unitAmount: 0 + quantity: 0 + discountAmount: 0.73 + subTotal: 0 + taxAmount: 29.52 + totalAmount: 29.52 + taxRateRef: + id: '1' + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 4.42 + subTotal: 147.62 + taxAmount: 0 + totalAmount: 147.62 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2022-10-14T09:35:55Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: cred 003 + pageNumber: 1 + pageSize: 2 + totalResults: 26 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/creditNotes + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/creditNotes?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: INV-17 + creditNoteNumber: '17' + customerRef: + id: KIN001 + companyName: Kinghorn & French + withholdingTax: [] + totalAmount: 832.84 + totalDiscount: 0 + subTotal: 711.45 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 121.39 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2021-02-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: PC Combo Pack 4 + unitAmount: 832.84 + quantity: 1 + subTotal: 711.45 + taxAmount: 121.39 + totalAmount: 832.84 + accountRef: + id: '4000' + name: Sales North + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 63.69 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 73.49 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 157.25 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 158.25 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 344.89 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 35.27 + modifiedDate: '2023-03-30T14:42:43Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: PC Combo Pack 4 + metadata: + isDeleted: false + - id: INV-34 + creditNoteNumber: '34' + customerRef: + id: MIL001 + companyName: Mile Road Health Centre + withholdingTax: [] + totalAmount: 1668.14 + totalDiscount: 0 + subTotal: 1425 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 243.14 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2021-02-28T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: PC Combo Pack 6 + unitAmount: 1668.14 + quantity: 1 + subTotal: 1425 + taxAmount: 243.14 + totalAmount: 1668.14 + accountRef: + id: '4000' + name: Sales North + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '530' + note: Sales credit inv-34 linked to sales invoice inv-26. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-28T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 1668.14 + modifiedDate: '2023-03-30T14:42:43Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: PC Combo Pack 6 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/creditNotes + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/creditNotes?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: c1a0176c33de11e797950a57719b2edb + creditNoteNumber: SCN-1 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + withholdingTax: [] + totalAmount: 1080 + totalDiscount: 0 + subTotal: 900 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 180 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-05-08T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 1 + discountAmount: 0 + subTotal: 900 + taxAmount: 180 + totalAmount: 1080 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: d39f7a5733de11e797950a57719b2edb + note: Customer refund using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2017-05-08T00:00:00' + totalAmount: -1080 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 1080 + modifiedDate: '2022-10-24T14:55:35Z' + sourceModifiedDate: '2017-05-08T11:09:38Z' + note: '' + - id: 28a459069a6211e8bad90617b3da4b8a + creditNoteNumber: SCN-3 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + withholdingTax: [] + totalAmount: 5400 + totalDiscount: 0 + subTotal: 4500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 900 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2018-08-07T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 5 + discountAmount: 0 + subTotal: 4500 + taxAmount: 900 + totalAmount: 5400 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 28a459069a6211e8bad90617b3da4b8a + note: Sales credit note + currency: GBP + currencyRate: 1 + paidOnDate: '2018-08-07T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 5400 + modifiedDate: '2022-10-24T14:55:35Z' + sourceModifiedDate: '2018-08-07T16:51:41Z' + note: '' + pageNumber: 1 + pageSize: 2 + totalResults: 2972 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/creditNotes + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/creditNotes?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '5018' + creditNoteNumber: IN0545 + customerRef: + id: '53' + companyName: Pacificorp + withholdingTax: [] + totalAmount: 575 + totalDiscount: 0 + subTotal: 500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 75 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-03-16T00:00:00' + allocatedOnDate: '2022-03-16T00:00:00' + currency: ZAR + lineItems: + - description: No Description Provided + unitAmount: 500 + quantity: 1 + subTotal: 500 + taxAmount: 75 + totalAmount: 575 + accountRef: + id: '2' + name: Accounts Receivable + taxRateRef: + id: '27' + name: Standard Rate Output + effectiveTaxRate: 15 + trackingCategoryRefs: + - id: LOCATION-10 + name: South Africa + - id: DEPARTMENT-2 + name: Services + - id: CUSTOMER-53 + name: Pacificorp + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2023-02-23T14:21:40Z' + sourceModifiedDate: '2022-03-16T12:27:43Z' + note: '' + metadata: + isDeleted: false + - id: '5020' + creditNoteNumber: ARADJ0034 + customerRef: + id: '53' + companyName: Pacificorp + withholdingTax: [] + totalAmount: 115 + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 15 + discountPercentage: 0 + remainingCredit: 115 + status: Submitted + issueDate: '2022-03-16T00:00:00' + currency: ZAR + currencyRate: 1 + lineItems: + - description: No Description Provided + unitAmount: 100 + quantity: 1 + subTotal: 100 + taxAmount: 15 + totalAmount: 115 + accountRef: + id: '2' + name: Accounts Receivable + taxRateRef: + id: '28' + name: Standard Rate (Capital Goods) Output + effectiveTaxRate: 15 + trackingCategoryRefs: + - id: LOCATION-10 + name: South Africa + - id: CUSTOMER-53 + name: Pacificorp + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2023-02-23T14:21:40Z' + sourceModifiedDate: '2022-03-16T12:30:19' + note: '' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/data/creditNotes + Xero: + value: + results: + - id: 47fb825b-3c43-4284-905f-c6d97acc6b37 + creditNoteNumber: CN-0025 + customerRef: + id: af0091a9-82ef-4cac-9fd6-22c095ac6a58 + companyName: Hamilton Smith Ltd + withholdingTax: [] + totalAmount: 541.25 + totalDiscount: 0 + subTotal: 451.04 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 90.21 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-11-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: FULL CREDIT of INV-0016 due to duplication of invoice INV-0012. Please accept our apologies. + unitAmount: 0 + quantity: 0 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + discountPercentage: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 451.04 + quantity: 1 + discountAmount: 0 + subTotal: 451.04 + taxAmount: 90.21 + totalAmount: 541.25 + accountRef: + id: c563b607-fb0e-4d06-9ddb-76fdeef20ae3 + name: Sales + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + itemRef: + id: f8fb7e00-5e5d-466c-aef0-15861f73d04f + name: Desktop/network support via email & phone + trackingCategoryRefs: + - id: 34b9b859-07a9-451a-b4d3-effc9946634a + name: North + isDirectIncome: false + paymentAllocations: + - payment: + id: 47fb825b-3c43-4284-905f-c6d97acc6b37 + reference: Monthly Support + currency: GBP + currencyRate: 1 + paidOnDate: '2022-11-20T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-11-20T00:00:00' + totalAmount: 541.25 + modifiedDate: '2023-03-15T20:35:09Z' + sourceModifiedDate: '2011-04-07T00:34:38' + metadata: + isDeleted: false + - id: caba470e-962f-4168-9c57-35caa289204d + creditNoteNumber: CN-0026 + customerRef: + id: 9ce626d2-14ea-463c-9fff-6785ab5f9bfb + companyName: Boom FM + withholdingTax: [] + totalAmount: 500 + totalDiscount: 0 + subTotal: 416.67 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 83.33 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2023-01-13T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: "CREDIT Half day training - Microsoft Office and include in suite of training\r\nINV-0024" + unitAmount: 416.67 + quantity: 1 + discountAmount: 0 + subTotal: 416.67 + taxAmount: 83.33 + totalAmount: 500 + accountRef: + id: c563b607-fb0e-4d06-9ddb-76fdeef20ae3 + name: Sales + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + itemRef: + id: 489558f5-27b7-4f37-ad9f-d84611c2e2ab + name: Half day training - Microsoft Office + trackingCategoryRefs: + - id: b3900cc6-3745-40ea-955f-9ef7b1c8cf7e + name: South + isDirectIncome: false + paymentAllocations: + - payment: + id: caba470e-962f-4168-9c57-35caa289204d + reference: Training + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-13T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-01-13T00:00:00' + totalAmount: 500 + modifiedDate: '2023-03-15T20:35:09Z' + sourceModifiedDate: '2011-04-07T02:47:04' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/creditNotes + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/creditNotes?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000129002' + creditNoteNumber: CN-00001 + customerRef: + id: '104957000000037097' + companyName: Test Company + withholdingTax: [] + totalAmount: 9001 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 9001 + status: Draft + issueDate: '2020-04-28T18:16:22' + currency: GBP + lineItems: [] + paymentAllocations: [] + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-04-28T18:16:22' + - id: '104957000000134023' + creditNoteNumber: CN-00002 + customerRef: + id: '104957000000054050' + companyName: 'Doe, John' + withholdingTax: [] + totalAmount: 125 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2020-05-06T13:04:20' + currency: GBP + lineItems: [] + paymentAllocations: + - payment: + id: '104957000000134039' + currency: GBP + paidOnDate: '2020-05-06T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 125 + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-05-06T13:05:27' + pageNumber: 1 + pageSize: 2 + totalResults: 12 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/creditNotes?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/creditNotes + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/creditNotes?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List credit notes* endpoint returns a list of [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote) for a given company's connection.\n\n[Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-credit-notes + x-speakeasy-group: accounts-receivable.credit-notes + '/companies/{companyId}/data/creditNotes/{creditNoteId}': + parameters: + - $ref: '#/components/parameters/companyId' + - name: creditNoteId + in: path + required: true + schema: + type: string + description: Unique identifier for a credit note. + get: + tags: + - Accounts receivable + summary: Get credit note + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreditNote' + examples: + Dynamics 365 Business Central: + value: + id: e6e5ec0f-1c60-eb11-89fa-00224800a9c7 + creditNoteNumber: '104001' + customerRef: + id: 8ddfa6bf-0c60-eb11-89fa-00224800af18 + companyName: Abdi Company + withholdingTax: [] + totalAmount: 105 + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 5 + discountPercentage: 0 + remainingCredit: 80 + status: PartiallyPaid + issueDate: '2021-01-25T00:00:00' + currency: GBP + lineItems: + - description: 'Invoice No. 103221:' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Linda Martin + unitAmount: 100 + quantity: 1 + discountAmount: 0 + subTotal: 100 + taxAmount: 5 + totalAmount: 105 + accountRef: + id: 161217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 'Income, Services' + discountPercentage: 0 + taxRateRef: + id: 61bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / REDUCED + effectiveTaxRate: 5 + itemRef: + id: RESC-331317b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'Linda Martin / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectIncome: false + - description: Credit memo for partially paid inv + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: NullId + discountPercentage: 0 + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 62e5046d-1c60-eb11-89fa-00224800a9c7 + note: Credit Memo 1001 + reference: 'Document No: 104001' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-25T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-25T00:00:00' + totalAmount: 25 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2021-01-26T21:21:18Z' + metadata: + isDeleted: false + FreeAgent: + value: + id: '21952211' + creditNoteNumber: '004' + customerRef: + id: '6162023' + companyName: Alderley plc + withholdingTax: [] + totalAmount: 165 + totalDiscount: 0 + subTotal: 165 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-10-18T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Reverse 6546 + unitAmount: 110 + quantity: 1.5 + subTotal: 165 + taxAmount: 0 + totalAmount: 165 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '270764400' + note: �165.00 - Credit Note refund against 004 + currency: GBP + paidOnDate: '2020-12-23T00:00:00' + totalAmount: -165 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 165 + modifiedDate: '2023-04-25T14:19:09Z' + sourceModifiedDate: '2020-12-23T16:39:23Z' + metadata: + isDeleted: false + FreshBooks: + value: + id: '33407' + creditNoteNumber: '0000065' + customerRef: + id: '511657' + companyName: Bob's Stationary + withholdingTax: [] + totalAmount: 150 + totalDiscount: 0 + subTotal: 150 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Submitted + issueDate: '2020-07-31T00:00:00' + currency: GBP + lineItems: + - description: Test Di + unitAmount: 150 + quantity: 1 + subTotal: 150 + taxAmount: 0 + totalAmount: 150 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '2054019' + note: Free $150 voucher + currency: GBP + paidOnDate: '2020-07-31T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 150 + modifiedDate: '2023-03-24T16:07:23Z' + note: Free $150 voucher + metadata: + isDeleted: false + KashFlow: + value: + id: '85322315' + creditNoteNumber: '4' + customerRef: + id: '69946501' + companyName: Peter Lord + withholdingTax: [] + totalAmount: 100 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-05-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: youm + unitAmount: 100 + quantity: -1 + subTotal: -100 + taxAmount: 0 + totalAmount: 100 + accountRef: + id: '21481817' + name: Sale of goods + itemRef: + id: '158667064' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '86870120' + note: Applying Credit Note + currency: GBP + paidOnDate: '2017-05-09T00:00:00' + totalAmount: -100 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 100 + modifiedDate: '2022-09-30T10:29:16Z' + Oracle NetSuite: + value: + id: '8827' + creditNoteNumber: CM27 + customerRef: + id: '417' + companyName: 10 Breww Ltd + withholdingTax: [] + totalAmount: 26 + totalDiscount: 0 + subTotal: 26 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 26 + status: Submitted + issueDate: '2021-04-09T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Andy Test Item + unitAmount: 2 + quantity: 3 + subTotal: 6 + totalAmount: 6 + accountRef: + id: '54' + name: Sales + itemRef: + id: '143' + name: Andy Test Item + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + - description: Non-Recurring Services - EC + unitAmount: 4 + quantity: 5 + subTotal: 20 + totalAmount: 20 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2022-09-20T08:15:31Z' + sourceModifiedDate: '2022-02-25T10:58:10' + QuickBooks Desktop: + value: + id: 96C-933372931 + creditNoteNumber: '4002' + customerRef: + id: 150000-933272658 + companyName: 'Abercrombie, Kristy' + withholdingTax: [] + totalAmount: 711.15 + totalDiscount: 0 + subTotal: 660 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 51.15 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2024-12-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: |- + Whirlpool tub + Billed and paid for 2 tubs, should have been for only 1 tub + unitAmount: 660 + quantity: 1 + subTotal: 660 + taxAmount: 0 + totalAmount: 660 + accountRef: + id: 40000-933270541 + name: Accounts Receivable + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1E0000-933272656 + name: Plumb Fixtrs + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + paymentAllocations: + - payment: + id: 969-933372844 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2024-12-01T00:00:00' + totalAmount: -711.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 711.15 + modifiedDate: '2023-04-26T09:07:38Z' + sourceModifiedDate: '2023-12-16T05:04:05' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '85' + creditNoteNumber: '3122019_6' + customerRef: + id: '3' + companyName: Information Sharing Technology + withholdingTax: [] + totalAmount: 13.53 + totalDiscount: 0 + subTotal: 13.53 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2019-12-03T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Refunds with payment type of Cash + unitAmount: 13.53 + quantity: 1 + subTotal: 13.53 + taxAmount: 0 + totalAmount: 13.53 + accountRef: + id: '1' + name: Sales + taxRateRef: + id: 8_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + itemRef: + id: '1' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: true + paymentAllocations: + - payment: + id: '85' + note: '' + accountRef: + id: '63' + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2019-12-03T00:00:00' + totalAmount: -13.53 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-12-03T00:00:00' + totalAmount: 13.53 + modifiedDate: '2023-01-18T11:02:55Z' + sourceModifiedDate: '2019-12-10T19:00:36Z' + QuickBooks Online Sandbox: + value: + id: '185' + creditNoteNumber: '1015' + customerRef: + id: '16' + companyName: Jordan Burgess + withholdingTax: [] + totalAmount: 1800 + totalDiscount: 0 + subTotal: 1500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 300 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-02-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Employee training off site + unitAmount: 1500 + quantity: 1 + subTotal: 1500 + taxAmount: 300 + totalAmount: 1800 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '5' + name: Employee Training + trackingCategoryRefs: + - id: DEPARTMENT_1 + name: London + isDirectIncome: false + paymentAllocations: + - payment: + id: '192' + note: Created by QB Online to link credits to charges. + currency: GBP + currencyRate: 1 + paidOnDate: '2017-09-08T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 1800 + modifiedDate: '2023-04-26T09:36:03Z' + sourceModifiedDate: '2017-09-08T12:52:27Z' + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '45891' + creditNoteNumber: return 1a + customerRef: + id: A1D001 + companyName: A1 Design Services + withholdingTax: [] + totalAmount: 378 + totalDiscount: 9.46 + subTotal: 315 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 63 + discountPercentage: 2.5 + remainingCredit: 378 + status: Submitted + issueDate: '2020-07-22T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Standard rate + unitAmount: 0 + quantity: 0 + discountAmount: 1.58 + subTotal: 0 + taxAmount: 63 + totalAmount: 63 + taxRateRef: + id: '1' + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 9.46 + subTotal: 315 + taxAmount: 0 + totalAmount: 315 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2022-10-14T09:35:55Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + note: black + Sage 50 (UK): + value: + id: INV-17 + creditNoteNumber: '17' + customerRef: + id: KIN001 + companyName: Kinghorn & French + withholdingTax: [] + totalAmount: 832.84 + totalDiscount: 0 + subTotal: 711.45 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 121.39 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2021-02-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: PC Combo Pack 4 + unitAmount: 832.84 + quantity: 1 + subTotal: 711.45 + taxAmount: 121.39 + totalAmount: 832.84 + accountRef: + id: '4000' + name: Sales North + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 35.27 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 344.89 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 158.25 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 157.25 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 73.49 + - payment: + id: '336' + note: Sales credit inv-17 linked to sales invoice inv-45. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-02T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 63.69 + modifiedDate: '2023-03-30T14:42:43Z' + sourceModifiedDate: '2022-11-25T09:43:54' + note: PC Combo Pack 4 + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: c1a0176c33de11e797950a57719b2edb + creditNoteNumber: SCN-1 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + withholdingTax: [] + totalAmount: 1080 + totalDiscount: 0 + subTotal: 900 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 180 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2017-05-08T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 1 + discountAmount: 0 + subTotal: 900 + taxAmount: 180 + totalAmount: 1080 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: d39f7a5733de11e797950a57719b2edb + note: Customer refund using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2017-05-08T00:00:00' + totalAmount: -1080 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: 1080 + modifiedDate: '2022-10-24T14:55:35Z' + sourceModifiedDate: '2017-05-08T11:09:38Z' + note: '' + Sage Intacct: + value: + id: '5018' + creditNoteNumber: IN0545 + customerRef: + id: '53' + companyName: Pacificorp + withholdingTax: [] + totalAmount: 575 + totalDiscount: 0 + subTotal: 500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 75 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-03-16T00:00:00' + allocatedOnDate: '2022-03-16T00:00:00' + currency: ZAR + lineItems: + - description: No Description Provided + unitAmount: 500 + quantity: 1 + subTotal: 500 + taxAmount: 75 + totalAmount: 575 + accountRef: + id: '2' + name: Accounts Receivable + taxRateRef: + id: '27' + name: Standard Rate Output + effectiveTaxRate: 15 + trackingCategoryRefs: + - id: DEPARTMENT-2 + name: Services + - id: CUSTOMER-53 + name: Pacificorp + - id: LOCATION-10 + name: South Africa + isDirectIncome: false + paymentAllocations: [] + modifiedDate: '2023-02-23T14:21:40Z' + sourceModifiedDate: '2022-03-16T12:27:43Z' + note: '' + metadata: + isDeleted: false + Xero: + value: + id: 47fb825b-3c43-4284-905f-c6d97acc6b37 + creditNoteNumber: CN-0025 + customerRef: + id: af0091a9-82ef-4cac-9fd6-22c095ac6a58 + companyName: Hamilton Smith Ltd + withholdingTax: [] + totalAmount: 541.25 + totalDiscount: 0 + subTotal: 451.04 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 90.21 + discountPercentage: 0 + remainingCredit: 0 + status: Paid + issueDate: '2022-11-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: FULL CREDIT of INV-0016 due to duplication of invoice INV-0012. Please accept our apologies. + unitAmount: 0 + quantity: 0 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + discountPercentage: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + unitAmount: 451.04 + quantity: 1 + discountAmount: 0 + subTotal: 451.04 + taxAmount: 90.21 + totalAmount: 541.25 + accountRef: + id: c563b607-fb0e-4d06-9ddb-76fdeef20ae3 + name: Sales + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + itemRef: + id: f8fb7e00-5e5d-466c-aef0-15861f73d04f + name: Desktop/network support via email & phone + trackingCategoryRefs: + - id: 34b9b859-07a9-451a-b4d3-effc9946634a + name: North + isDirectIncome: false + paymentAllocations: + - payment: + id: 47fb825b-3c43-4284-905f-c6d97acc6b37 + reference: Monthly Support + currency: GBP + currencyRate: 1 + paidOnDate: '2022-11-20T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-11-20T00:00:00' + totalAmount: 541.25 + modifiedDate: '2023-03-15T20:35:09Z' + sourceModifiedDate: '2011-04-07T00:34:38' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000129002' + creditNoteNumber: CN-00001 + customerRef: + id: '104957000000037097' + companyName: Test Company + withholdingTax: [] + totalAmount: 9001 + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 9001 + status: Draft + issueDate: '2020-04-28T18:16:22' + currency: GBP + lineItems: [] + paymentAllocations: [] + modifiedDate: '2022-10-03T08:40:43Z' + sourceModifiedDate: '2020-04-28T18:16:22' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get credit note* endpoint returns a single credit note for a given creditNoteId. + + [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote) are issued to a customer to indicate debt, typically with reference to a previously issued invoice and/or purchase. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-credit-note + x-speakeasy-group: accounts-receivable.credit-notes + '/companies/{companyId}/data/customers': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + summary: List customers + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCustomers' + examples: + Clear Books: + value: + results: + - id: c8180244-74ac-40cf-a5df-6d83661c44d7 + customerName: Arjun Kuvalis + contactName: Werner Langworth + emailAddress: Arjun34@hotmail.com + defaultCurrency: GBP + phone: 014605 64820 + addresses: + - type: Delivery + line1: Suite 214 + line2: 8439 Lueilwitz Passage + city: Fernandohaven + region: Northern Ireland + country: United Kingdom + postalCode: JG04 7PV + - type: Delivery + line1: Suite 096 + line2: 864 Halie Course + city: Juliochester + region: England + country: United Kingdom + postalCode: DZ8 4BF + - type: Delivery + line1: Suite 001 + line2: 416 Stokes Fords + city: Naderborough + region: Wales + country: United Kingdom + postalCode: XG25 0XX + contacts: + - name: Werner Langworth + email: Werner_Langworth@hotmail.com + phone: [] + address: + type: Delivery + line1: Apt. 145 + line2: 317 Williamson Freeway + city: Hortenseville + region: Scotland + country: United Kingdom + postalCode: CV4 2HR + status: Active + - name: Belle Glover + email: Belle51@yahoo.com + phone: [] + address: + type: Delivery + line1: Suite 075 + line2: 9921 Dickens Walk + city: South Ali + region: Scotland + country: United Kingdom + postalCode: TI04 4OO + status: Active + registrationNumber: NI7JEJVM + taxNumber: '7505220209.583549' + status: Active + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2022-07-03T01:27:00' + metadata: + isDeleted: false + - id: 6d162ee4-47b4-46c6-a2e6-aa9edd0fe6b0 + customerName: 'Breitenberg, Emard and Schiller' + contactName: Miguel Hahn + emailAddress: contact@BreitenbergEmardandSchiller.biz + defaultCurrency: GBP + phone: 0800 445 6957 + addresses: + - type: Billing + line1: Apt. 184 + line2: 60578 Louie Springs + city: East Khalid + region: Wales + country: United Kingdom + postalCode: XW89 7NT + contacts: + - name: Miguel Hahn + email: Miguel.Hahn@gmail.com + phone: + - number: 018555 09614 + type: Landline + address: + type: Delivery + line1: Suite 400 + line2: 21930 Milan Lane + city: Reingerton + region: Wales + country: United Kingdom + postalCode: QG10 2DL + status: Active + registrationNumber: KME0AMIL + taxNumber: '8560920952.553111' + status: Archived + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2022-12-03T11:05:01' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 20 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/customers?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 0e2f7751-7696-ed11-bff5-6045bd0d2ad6 + customerName: '' + contactName: '' + emailAddress: '' + defaultCurrency: GBP + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + contacts: + - name: '' + email: '' + phone: [] + address: + type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2023-01-17T14:50:54Z' + metadata: + isDeleted: false + - id: 0ef95175-48c4-eb11-9f0a-0022481b4343 + customerName: '' + contactName: '' + emailAddress: '' + defaultCurrency: GBP + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + contacts: + - name: '' + email: '' + phone: [] + address: + type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2021-06-03T08:48:36Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 42 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/customers?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 555f8251-c65a-433a-a813-5dbe04321d1e + customerName: Ab Netherlands + defaultCurrency: EUR + addresses: + - type: Billing + country: NL + contacts: [] + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2021-06-14T15:26:37Z' + - id: 9fd1f78e-67aa-4af7-8a10-df1fc5fb5841 + customerName: anna test 2 + defaultCurrency: EUR + addresses: + - type: Billing + country: NL + contacts: [] + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2022-05-24T11:53:21Z' + pageNumber: 1 + pageSize: 2 + totalResults: 71 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/customers?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 5f20075a-a28e-434d-81a6-2db0dc170e87 + customerName: Abdi 99 + emailAddress: email@codat.io + defaultCurrency: GBP + addresses: + - type: Billing + line1: Ink Rooms + city: London + country: GB + postalCode: WC1X 0BE + contacts: [] + registrationNumber: '123456789' + taxNumber: GB339 0727 47 + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2020-02-26T11:23:50Z' + - id: 1d9dc1a7-92d6-441b-93fd-42c9fb321b1c + customerName: Abdulbasit Al-haj + contactName: abeee + emailAddress: a.alhaj@codat.io + defaultCurrency: GBP + addresses: + - type: Billing + country: GB + contacts: + - name: abeee + phone: [] + address: + type: Unknown + line1: '' + country: 'GB ' + status: Active + modifiedDate: '2020-02-24T12:00:51.027Z' + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2020-02-24T12:00:50Z' + pageNumber: 1 + pageSize: 2 + totalResults: 53 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/customers?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '11526230' + customerName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + contacts: + - name: Test 1 + phone: [] + address: + type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Unknown + status: Active + modifiedDate: '2023-04-25T14:19:12Z' + sourceModifiedDate: '2023-04-17T06:02:46Z' + metadata: + isDeleted: false + - id: '9677150' + customerName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + contacts: + - name: Test 1 + phone: [] + address: + type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Unknown + status: Active + modifiedDate: '2023-04-25T14:19:12Z' + sourceModifiedDate: '2023-04-24T06:19:23Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 159 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/customers?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '634509' + customerName: A test customer 14 (updated) + contactName: test person name + emailAddress: test14@example.com + defaultCurrency: GBP + phone: 01876 541245 + addresses: + - type: Billing + line1: Line 1 + line2: Line 2 + city: Some city + region: A region + country: Country 1 + postalCode: SW1 2JQ + contacts: + - name: test person1 + email: test14A@example.com + phone: + - number: '24681012' + type: Primary + - number: '121086420' + type: Unknown + status: Active + - name: test person2 + email: test14B@example.com + phone: + - number: 1234 56789 + type: Primary + - number: 9876 54321 + type: Unknown + status: Active + - name: test person name + email: test14@example.com + phone: + - number: 01876 541245 + type: Unknown + status: Active + status: Active + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2022-05-18T09:23:56' + metadata: + isDeleted: false + - id: '634486' + customerName: A test customer name 2 + contactName: test person name + emailAddress: test8@example.com + defaultCurrency: GBP + phone: 01876 541245 + addresses: + - type: Billing + line1: Line 1 + line2: Line 2 + city: Some city + region: A region + country: Country 1 + postalCode: SW1 2JQ + contacts: + - name: test person1 + email: test9@example.com + phone: + - number: '24681012' + type: Primary + - number: '121086420' + type: Unknown + status: Active + - name: test person2 + email: test10@example.com + phone: + - number: '123456789' + type: Primary + - number: '987654321' + type: Unknown + status: Active + - name: test person name + email: test8@example.com + phone: + - number: 01876 541245 + type: Unknown + status: Active + status: Active + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2022-05-11T11:39:58' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 39 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/customers?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '92227673' + customerName: Chekko Customer Test 01 + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + contacts: + - name: '' + email: '' + phone: [] + status: Active + taxNumber: '' + status: Active + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '0001-01-01T00:00:00' + - id: '88459410' + customerName: Diogo Sousa + contactName: Mr Diogo Sousa + emailAddress: diogomail@mail.com + phone: '123123123' + addresses: + - type: Billing + line1: Billing Address + line2: Billing line 2 Billing line 3 + city: Billing line 4 + country: United Kingdom + postalCode: '123321' + - type: Delivery + line1: Delivery Address + line2: Delivery line2 Delivery line3 + city: Delivery line4 + country: United Kingdom + postalCode: '123321' + contacts: + - name: Mr Diogo Sousa + email: diogomail@mail.com + phone: + - number: '123123123' + type: Landline + - number: '321321321' + type: Mobile + address: + type: Billing + line1: Billing Address + line2: Billing line 2 Billing line 3 + city: Billing line 4 + country: United Kingdom + postalCode: '123321' + status: Active + - name: Mr Diogo Sousa + phone: [] + address: + type: Delivery + line1: Delivery Address + line2: Delivery line2 Delivery line3 + city: Delivery line4 + country: United Kingdom + postalCode: '123321' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '2021-05-04T13:22:19' + pageNumber: 1 + pageSize: 2 + totalResults: 10 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/customers?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '773' + customerName: 119 Test Customer + contactName: Mr Test Customer + defaultCurrency: GBP + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-01-30T14:48:02Z' + sourceModifiedDate: '2022-01-11T12:28:49' + - id: '172722' + customerName: 1248 European Company + contactName: European Company + defaultCurrency: GBP + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-01-30T14:48:02Z' + sourceModifiedDate: '2022-07-27T14:29:16' + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/customers?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 150000-933272658 + customerName: 'Abercrombie, Kristy' + contactName: Kristy Abercrombie + emailAddress: kristy@samplename.com + defaultCurrency: GBP + phone: 415-555-6579 + addresses: + - type: Delivery + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + - type: Billing + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + contacts: + - name: 'Abercrombie, Kristy' + email: kristy@samplename.com + phone: + - number: 415-555-6579 + type: Primary + status: Active + - name: Kristy Abercrombie + phone: [] + status: Active + - name: Steve Darcangelo + phone: [] + status: Active + status: Active + modifiedDate: '2023-04-26T09:07:55Z' + sourceModifiedDate: '2023-12-16T05:06:42' + metadata: + isDeleted: false + - id: 800000D0-1182061376 + customerName: 'Allard, Robert' + contactName: Amanda Roberts + emailAddress: rallard@myemail.com + defaultCurrency: GBP + phone: 650-555-3422 + addresses: + - type: Delivery + line1: Robert Allard + line2: 92834 Chandler St. + city: Millbrae + region: CA + postalCode: '94030' + - type: Billing + line1: Robert Allard + line2: 92834 Chandler St. + city: Millbrae + region: CA + postalCode: '94030' + contacts: + - name: 'Allard, Robert' + email: rallard@myemail.com + phone: + - number: 650-555-3422 + type: Primary + - number: 650-555-9804 + type: Fax + - number: 650-555-8349 + type: Unknown + status: Active + - name: Robert Allard + phone: [] + status: Active + - name: Rachel Fisher + phone: [] + status: Active + status: Active + modifiedDate: '2023-04-26T09:07:55Z' + sourceModifiedDate: '2023-12-16T05:06:42' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/customers?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '9' + customerName: Abe + contactName: Abraham's Company + emailAddress: ab@email.com + defaultCurrency: GBP + addresses: [] + contacts: + - name: Abe + email: ab@email.com + phone: + - number: '01111111111' + type: Mobile + status: Active + registrationNumber: XXXX9900001 + taxNumber: XXXX9900001 + status: Active + modifiedDate: '2023-01-18T11:02:35Z' + sourceModifiedDate: '2022-12-08T15:42:59Z' + - id: '49' + customerName: adeel qbo child test + contactName: Adeel test + emailAddress: adeel@adeel.com + defaultCurrency: GBP + phone: '123456789' + addresses: + - type: Billing + line1: 4 Privet Drive + city: London + country: United Kingdom + postalCode: WD25 7LR + - type: Delivery + line1: 4 Privet Drive + city: London + country: United Kingdom + postalCode: WD25 7LR + contacts: + - name: Adeel test + email: adeel@adeel.com + phone: + - number: '123456789' + type: Primary + - number: '07546543216' + type: Mobile + address: + type: Billing + line1: 4 Privet Drive + city: London + country: United Kingdom + postalCode: WD25 7LR + status: Active + status: Active + modifiedDate: '2023-01-18T11:02:35Z' + sourceModifiedDate: '2022-08-22T09:21:09Z' + pageNumber: 1 + pageSize: 2 + totalResults: 40 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/customers?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '66' + customerName: Abercrombie International Group + contactName: Kristy Abercrombie + defaultCurrency: GBP + addresses: + - type: Billing + line1: 123 Main St + city: 'New York, NY' + contacts: + - name: Abercrombie International Group (deleted) + phone: [] + address: + type: Billing + line1: 123 Main St + city: 'New York, NY' + status: Archived + status: Archived + modifiedDate: '2023-04-26T09:35:56Z' + sourceModifiedDate: '2016-09-12T18:53:19Z' + metadata: + isDeleted: false + - id: '67' + customerName: Abercrombie International Group + contactName: Natalie Watts + emailAddress: n.watts@google.com + defaultCurrency: USD + addresses: + - type: Billing + - type: Delivery + contacts: + - name: Abercrombie International Group + email: n.watts@google.com + phone: [] + address: + type: Billing + status: Active + registrationNumber: XXXXVat123456 + taxNumber: XXXXVat123456 + status: Active + modifiedDate: '2023-04-26T09:35:56Z' + sourceModifiedDate: '2023-03-29T01:12:55Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 243 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/customers?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: A1D001 + customerName: A1 Design Services + contactName: Lee Dalkin + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: '' + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: '' + postalCode: M2 6JK + - type: Billing + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: Great Britain + postalCode: BP12 7HT + contacts: + - name: Lee Dalkin + email: newbusinessadvice@sage.com + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Landline + - number: 01742 876 236 + type: Fax + status: Active + - name: Malcolm Leverret + email: '' + phone: [] + status: Active + - name: Jim Thomas + email: Jim@a1designservices.co.uk + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Fax + status: Active + - name: Jullian Plawsworth + email: Jullian@a1designservices.co.uk + phone: + - number: 0151 349 3939 + type: Landline + - number: 0151 349 3940 + type: Fax + status: Active + registrationNumber: '' + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2022-10-14T09:35:53Z' + sourceModifiedDate: '2022-04-27T15:17:36Z' + - id: A1D002 + customerName: A2 Design Services + contactName: Lee Dalkin + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Billing + line1: 77a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: Great Britain + postalCode: BP12 7HT + contacts: + - name: Lee Dalkin + email: newbusinessadvice@sage.com + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Landline + - number: 01742 876 236 + type: Fax + status: Active + - name: Malcolm Leverret + email: '' + phone: [] + status: Active + - name: Jim Thomas + email: Jim@a1designservices.co.uk + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Fax + status: Active + - name: Jullian Plawsworth + email: Jullian@a1designservices.co.uk + phone: + - number: 0151 349 3939 + type: Landline + - number: 0151 349 3940 + type: Fax + status: Active + registrationNumber: '' + taxNumber: GB238 3839 40 + status: Active + modifiedDate: '2022-10-14T09:35:53Z' + sourceModifiedDate: '2020-09-23T10:28:58Z' + pageNumber: 1 + pageSize: 2 + totalResults: 43 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/customers?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: A1D001 + customerName: A1 Design Services + contactName: Ian Cairns + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: GB + postalCode: M2 6JK + - type: Unknown + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + contacts: [] + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2023-03-30T14:42:41Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + metadata: + isDeleted: false + - id: ABS001 + customerName: ABS Garages Ltd + contactName: Mike Hall + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 0191 254 5909 + addresses: + - type: Delivery + line1: Swanson Industries + line2: Dukes Industrial Estate + city: Whitley Bay + region: North Tyneside + country: GB + postalCode: NE56 4ER + - type: Delivery + line1: Unit 34 + line2: Holystone Ind Estate + city: Hebburn + region: Tyne & Wear + country: GB + postalCode: NE31 1VB + - type: Unknown + line1: Unit 34 + line2: Holystone Ind Estate + city: Hebburn + region: Tyne & Wear + country: GB + postalCode: NE31 1VB + contacts: [] + taxNumber: GB745 4584 68 + status: Active + modifiedDate: '2023-03-30T14:42:41Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 30 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/customers?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 260f6a3f94a243738f2d5e08496a41a8 + customerName: 100 test name + contactName: Main Contact + emailAddress: email@codat.io + defaultCurrency: GBP + phone: contact phone number + addresses: + - type: Billing + line1: Aruba Address line 1 + line2: Aruba Address line 2 + city: Aruba City + region: Aruba Province + country: Aruba (AW) + postalCode: Aruba Post + contacts: + - phone: + - number: contact mobile number + type: Mobile + - number: contact fax number + type: Fax + status: Unknown + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2021-05-10T16:31:51Z' + - id: 44a5d9461d9e4f6d90a5ace251c5cf35 + customerName: 100 test name DS + contactName: Main Contact + emailAddress: DCemail@codat.io + defaultCurrency: GBP + phone: contact phone number + addresses: + - type: Billing + line1: POST - Aruba Address line 1 + line2: POST - Aruba Address line 2 + city: POST - Aruba City + region: Aruba Province + country: Aruba (AW) + postalCode: Aruba Post + contacts: [] + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2021-06-10T14:22:46Z' + pageNumber: 1 + pageSize: 2 + totalResults: 168 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/customers?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '188' + customerName: 33Across + contactName: Yuna Conn + defaultCurrency: USD + phone: 520-393-4468 + addresses: + - type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + contacts: + - name: 'Conn, Yuna' + phone: + - number: 520-393-4468 + type: Primary + address: + type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + status: Unknown + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:21Z' + sourceModifiedDate: '2022-09-06T12:58:27' + metadata: + isDeleted: false + - id: '324' + customerName: 3Way International Logistics + contactName: Lauri O'Heagertie + defaultCurrency: CAD + phone: 410-309-3976 + addresses: + - type: Unknown + line1: 7 Lerdahl Junction + line2: '' + city: Sparwood + region: British Columbia + country: Canada + postalCode: L4R + contacts: + - name: 'O''Heagertie, Lauri' + phone: + - number: 410-309-3976 + type: Primary + address: + type: Unknown + line1: 7 Lerdahl Junction + line2: '' + city: Sparwood + region: British Columbia + country: Canada + postalCode: L4R + status: Unknown + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:21Z' + sourceModifiedDate: '2020-10-20T05:01:49' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 530 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/customers?page=2&pageSize=2 + Wave: + value: + results: + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 + customerName: ABC Textiles + contactName: '' + emailAddress: c.taylor@codat.io + defaultCurrency: USD + addresses: [] + contacts: [] + status: Active + modifiedDate: '2022-11-16T18:15:30Z' + sourceModifiedDate: '2019-10-17T07:59:04Z' + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjM3MTUzNDI2 + customerName: Coffee Cart + contactName: Coffee Carl + emailAddress: coffee.cart@example.com + defaultCurrency: GBP + phone: '0201111' + addresses: + - type: Billing + line1: 11 Coffee Lane + line2: Coffee Town + city: Coffee City + region: Hampshire + country: United Kingdom + postalCode: CC1 1CC + contacts: + - name: Coffee Carl + phone: + - number: '07733' + type: Mobile + status: Active + status: Active + modifiedDate: '2022-11-16T18:15:30Z' + sourceModifiedDate: '2020-03-17T19:12:39Z' + pageNumber: 1 + pageSize: 2 + totalResults: 10 + _links: + current: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers?page=1&pageSize=2 + self: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers + next: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/customers?page=2&pageSize=2 + Xero: + value: + results: + - id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + customerName: 24 Locks + emailAddress: '' + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-03-15T20:35:10Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + - id: bab779bc-c5fb-42cb-a888-953e8309711c + customerName: 7-Eleven + emailAddress: '' + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-03-15T20:35:10Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 48 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/customers?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000032105' + customerName: A B + contactName: Contact (First Name) Contact (Last Name) + emailAddress: contactperson@whateveryouwantidontcare12345.com + defaultCurrency: GBP + phone: Work Phone + addresses: [] + contacts: + - name: Contact (First Name) Contact (Last Name) + email: contactperson@whateveryouwantidontcare12345.com + phone: + - number: Work Phone + type: Landline + - number: Mobile + type: Mobile + status: Active + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-06-09T14:36:47' + - id: '104957000000054050' + customerName: 'Doe, John' + contactName: John Doe + emailAddress: '' + defaultCurrency: GBP + addresses: [] + contacts: + - name: John Doe + email: '' + phone: [] + status: Active + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-09-28T15:09:22' + pageNumber: 1 + pageSize: 2 + totalResults: 14 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/customers?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List customers* endpoint returns a list of [customers](https://docs.codat.io/lending-api#/schemas/Customer) for a given company's connection.\n\n[Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-customers + x-speakeasy-group: accounts-receivable.customers + '/companies/{companyId}/data/customers/{customerId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/customerId' + get: + tags: + - Accounts receivable + summary: Get customer + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCustomer' + examples: + Clear Books: + value: + id: c8180244-74ac-40cf-a5df-6d83661c44d7 + customerName: Arjun Kuvalis + contactName: Werner Langworth + emailAddress: Arjun34@hotmail.com + defaultCurrency: GBP + phone: 014605 64820 + addresses: + - type: Delivery + line1: Suite 214 + line2: 8439 Lueilwitz Passage + city: Fernandohaven + region: Northern Ireland + country: United Kingdom + postalCode: JG04 7PV + - type: Delivery + line1: Suite 096 + line2: 864 Halie Course + city: Juliochester + region: England + country: United Kingdom + postalCode: DZ8 4BF + - type: Delivery + line1: Suite 001 + line2: 416 Stokes Fords + city: Naderborough + region: Wales + country: United Kingdom + postalCode: XG25 0XX + contacts: + - name: Werner Langworth + email: Werner_Langworth@hotmail.com + phone: [] + address: + type: Delivery + line1: Apt. 145 + line2: 317 Williamson Freeway + city: Hortenseville + region: Scotland + country: United Kingdom + postalCode: CV4 2HR + status: Active + - name: Belle Glover + email: Belle51@yahoo.com + phone: [] + address: + type: Delivery + line1: Suite 075 + line2: 9921 Dickens Walk + city: South Ali + region: Scotland + country: United Kingdom + postalCode: TI04 4OO + status: Active + registrationNumber: NI7JEJVM + taxNumber: '7505220209.583549' + status: Active + modifiedDate: '2023-04-26T12:38:16Z' + sourceModifiedDate: '2022-07-03T01:27:00' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 0e2f7751-7696-ed11-bff5-6045bd0d2ad6 + customerName: '' + contactName: '' + emailAddress: '' + defaultCurrency: GBP + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + contacts: + - name: '' + email: '' + phone: [] + address: + type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + status: Active + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2023-01-17T14:50:54Z' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 555f8251-c65a-433a-a813-5dbe04321d1e + customerName: Ab Netherlands + defaultCurrency: EUR + addresses: + - type: Billing + country: NL + contacts: [] + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2021-06-14T15:26:37Z' + Exact (UK): + value: + id: 5f20075a-a28e-434d-81a6-2db0dc170e87 + customerName: Abdi 99 + emailAddress: email@codat.io + defaultCurrency: GBP + addresses: + - type: Billing + line1: Ink Rooms + city: London + country: GB + postalCode: WC1X 0BE + contacts: [] + registrationNumber: '123456789' + taxNumber: GB339 0727 47 + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2020-02-26T11:23:50Z' + FreeAgent: + value: + id: '11526230' + customerName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + contacts: + - name: Test 1 + phone: [] + address: + type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Unknown + status: Active + modifiedDate: '2023-04-25T14:19:12Z' + sourceModifiedDate: '2023-04-17T06:02:46Z' + metadata: + isDeleted: false + FreshBooks: + value: + id: '634509' + customerName: A test customer 14 (updated) + contactName: test person name + emailAddress: test14@example.com + defaultCurrency: GBP + phone: 01876 541245 + addresses: + - type: Billing + line1: Line 1 + line2: Line 2 + city: Some city + region: A region + country: Country 1 + postalCode: SW1 2JQ + contacts: + - name: test person1 + email: test14A@example.com + phone: + - number: '24681012' + type: Primary + - number: '121086420' + type: Unknown + status: Active + - name: test person2 + email: test14B@example.com + phone: + - number: '123456789' + type: Primary + - number: '987654321' + type: Unknown + status: Active + - name: test person name + email: test14@example.com + phone: + - number: 01876 541245 + type: Unknown + status: Active + status: Active + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2022-05-18T09:23:56' + metadata: + isDeleted: false + KashFlow: + value: + id: '92227673' + customerName: Chekko Customer Test 01 + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + contacts: + - name: '' + email: '' + phone: [] + status: Active + taxNumber: '' + status: Active + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '0001-01-01T00:00:00' + Oracle NetSuite: + value: + id: '773' + customerName: 119 Test Customer + contactName: Mr Test Customer + defaultCurrency: GBP + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-01-30T14:48:02Z' + sourceModifiedDate: '2022-01-11T12:28:49' + QuickBooks Desktop: + value: + id: 150000-933272658 + customerName: 'Abercrombie, Kristy' + contactName: Kristy Abercrombie + emailAddress: kristy@samplename.com + defaultCurrency: GBP + phone: 415-555-6579 + addresses: + - type: Delivery + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + - type: Billing + line1: Kristy Abercrombie + line2: 5647 Cypress Hill Rd + city: Bayshore + region: CA + postalCode: '94326' + contacts: + - name: 'Abercrombie, Kristy' + email: kristy@samplename.com + phone: + - number: 415-555-6579 + type: Primary + status: Active + - name: Kristy Abercrombie + phone: [] + status: Active + - name: Steve Darcangelo + phone: [] + status: Active + status: Active + modifiedDate: '2023-04-26T09:07:55Z' + sourceModifiedDate: '2023-12-16T05:06:42' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '9' + customerName: Abe + contactName: Abraham's Company + emailAddress: ab@email.com + defaultCurrency: GBP + addresses: [] + contacts: + - name: Abe + email: ab@email.com + phone: + - number: '01111111111' + type: Mobile + status: Active + registrationNumber: XXXX9900001 + taxNumber: XXXX9900001 + status: Active + modifiedDate: '2023-01-18T11:02:35Z' + sourceModifiedDate: '2022-12-08T15:42:59Z' + QuickBooks Online Sandbox: + value: + id: '66' + customerName: Abercrombie International Group + contactName: Kristy Abercrombie + defaultCurrency: GBP + addresses: + - type: Billing + line1: 123 Main St + city: 'New York, NY' + contacts: + - name: Abercrombie International Group (deleted) + phone: [] + address: + type: Billing + line1: 123 Main St + city: 'New York, NY' + status: Archived + status: Archived + modifiedDate: '2023-04-26T09:35:56Z' + sourceModifiedDate: '2016-09-12T18:53:19Z' + metadata: + isDeleted: false + Sage 200cloud: + value: + id: A1D001 + customerName: A1 Design Services + contactName: Lee Dalkin + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: '' + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: '' + postalCode: M2 6JK + - type: Billing + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: Great Britain + postalCode: BP12 7HT + contacts: + - name: Lee Dalkin + email: newbusinessadvice@sage.com + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Landline + - number: 01742 876 236 + type: Fax + status: Active + - name: Malcolm Leverret + email: '' + phone: [] + status: Active + - name: Jim Thomas + email: Jim@a1designservices.co.uk + phone: + - number: 01742 876 234 + type: Landline + - number: 01742 876 235 + type: Fax + status: Active + - name: Jullian Plawsworth + email: Jullian@a1designservices.co.uk + phone: + - number: 0151 349 3939 + type: Landline + - number: 0151 349 3940 + type: Fax + status: Active + registrationNumber: '' + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2022-10-14T09:35:53Z' + sourceModifiedDate: '2022-04-27T15:17:36Z' + Sage 50 (UK): + value: + id: A1D001 + customerName: A1 Design Services + contactName: Ian Cairns + emailAddress: newbusinessadvice@sage.com + defaultCurrency: GBP + phone: 01742 876 234 + addresses: + - type: Delivery + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + - type: Delivery + line1: 23a Union Street + line2: '' + city: Manchester + region: '' + country: GB + postalCode: M2 6JK + - type: Unknown + line1: 67a Station Road + line2: '' + city: Blackpool + region: Lancashire + country: GB + postalCode: BP12 7HT + contacts: [] + taxNumber: GB238 3839 38 + status: Active + modifiedDate: '2023-03-30T14:42:41Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: 260f6a3f94a243738f2d5e08496a41a8 + customerName: 100 test name + contactName: Main Contact + emailAddress: email@codat.io + defaultCurrency: GBP + phone: contact phone number + addresses: + - type: Billing + line1: Aruba Address line 1 + line2: Aruba Address line 2 + city: Aruba City + region: Aruba Province + country: Aruba (AW) + postalCode: Aruba Post + contacts: + - phone: + - number: contact mobile number + type: Mobile + - number: contact fax number + type: Fax + status: Unknown + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2021-05-10T16:31:51Z' + Sage Intacct: + value: + id: '188' + customerName: 33Across + contactName: Yuna Conn + defaultCurrency: USD + phone: 520-393-4468 + addresses: + - type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + contacts: + - name: 'Conn, Yuna' + phone: + - number: 520-393-4468 + type: Primary + address: + type: Unknown + line1: 155 Westend Point + line2: '' + city: Albuquerque + region: NM + country: United States + postalCode: '87140' + status: Unknown + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:21Z' + sourceModifiedDate: '2022-09-06T12:58:27' + metadata: + isDeleted: false + Wave: + value: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 + customerName: ABC Textiles + contactName: '' + emailAddress: c.taylor@codat.io + defaultCurrency: USD + addresses: [] + contacts: [] + status: Active + modifiedDate: '2022-11-16T18:15:30Z' + sourceModifiedDate: '2019-10-17T07:59:04Z' + Xero: + value: + id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + customerName: 24 Locks + emailAddress: '' + addresses: [] + contacts: [] + status: Active + modifiedDate: '2023-03-15T20:35:10Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000032105' + customerName: A B + contactName: Contact (First Name) Contact (Last Name) + emailAddress: contactperson@whateveryouwantidontcare12345.com + defaultCurrency: GBP + phone: Work Phone + addresses: [] + contacts: + - name: Contact (First Name) Contact (Last Name) + email: contactperson@whateveryouwantidontcare12345.com + phone: + - number: Work Phone + type: Landline + - number: Mobile + type: Mobile + status: Active + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-06-09T14:36:47' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get customer* endpoint returns a single customer for a given customerId. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-customer + x-speakeasy-group: accounts-receivable.customers + '/companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/customerId' + get: + tags: + - Accounts receivable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: List customer attachments + description: |- + The *List customer attachments* endpoint returns a list of attachments avialable to download for given `customerId`. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + operationId: list-accounting-customer-attachments + x-speakeasy-group: accounts-receivable.customers + '/companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/customerId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts receivable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get customer attachment + description: | + The *Get customer attachment* endpoint returns a specific attachment for a given `customerId` and `attachmentId`. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + operationId: get-accounting-customer-attachment + x-speakeasy-group: accounts-receivable.customers + '/companies/{companyId}/connections/{connectionId}/data/customers/{customerId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/customerId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts receivable + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Download customer attachment + description: |- + The *Download customer attachment* endpoint downloads a specific attachment for a given `customerId` and `attachmentId`. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + operationId: download-accounting-customer-attachment + x-speakeasy-group: accounts-receivable.customers + '/companies/{companyId}/connections/{connectionId}/data/directCosts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Transactions + summary: List direct costs + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingDirectCosts' + examples: + Clear Books: + value: + results: + - id: 994ad234-ca05-466e-8e6a-117783b38cf6 + reference: 005b7b62-dc9f-42d2-85a2-4a2cefc6bab2 + note: 'Direct Cost with 1 line items, totaling 242.20' + contactRef: + id: D4Q4iYwHou + dataType: suppliers + issueDate: '2022-04-27T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Saddle Branches 160mm x 110mm x 87 � + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 220.18 + quantity: 1 + discountAmount: 0 + discountPercentage: 0 + subTotal: 220.18 + taxAmount: 22.02 + totalAmount: 242.2 + itemRef: + id: '2' + name: Solvent Weld Branch 160mm x 110mm x 87 � + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 994ad234-ca05-466e-8e6a-117783b38cf6 + note: Payment for direct cost 994ad234-ca05-466e-8e6a-117783b38cf6 + reference: Direct Cost 994ad234-ca05-466e-8e6a-117783b38cf6 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-27T00:00:00' + totalAmount: 242.2 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-27T00:00:00' + totalAmount: -242.2 + subTotal: 220.18 + taxAmount: 22.02 + totalAmount: 242.2 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-09-18T20:59:02' + metadata: + isDeleted: false + - id: 735b5f9b-9e58-4f8f-8a9d-083de599986c + reference: 7d011ce8-89ae-43e7-a2ed-cf028534ccdc + note: 'Direct Cost with 4 line items, totaling 13684.57' + contactRef: + id: d3tf43eghS + dataType: suppliers + issueDate: '2022-05-02T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Yard Gully + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 148.88 + quantity: 5 + discountAmount: 73.62 + discountPercentage: 9.89 + subTotal: 670.78 + taxAmount: 67.08 + totalAmount: 737.86 + itemRef: + id: 00491160-6ee5-4d76-9f34-998f00687481 + name: Aluminium Silt Bucket + trackingCategoryRefs: [] + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 82.68 + quantity: 3 + discountAmount: 0 + discountPercentage: 0 + subTotal: 248.04 + taxAmount: 24.8 + totalAmount: 272.84 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: [] + - description: Grease Trap + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 1192.51 + quantity: 8 + discountAmount: 0 + discountPercentage: 0 + subTotal: 9540.08 + taxAmount: 954.01 + totalAmount: 10494.09 + itemRef: + id: 9409d23d-1011-432e-98a4-591fcd8d5404 + name: 300 Litre Grease Trap + trackingCategoryRefs: [] + - description: Underground - Drain Saddle Branches 160mm x 110mm x 87 � + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 220.18 + quantity: 9 + discountAmount: 0 + discountPercentage: 0 + subTotal: 1981.62 + taxAmount: 198.16 + totalAmount: 2179.78 + itemRef: + id: '2' + name: Solvent Weld Branch 160mm x 110mm x 87 � + trackingCategoryRefs: + - id: costcode_1 + name: Green Concrete + paymentAllocations: + - payment: + id: 735b5f9b-9e58-4f8f-8a9d-083de599986c + note: Payment for direct cost 735b5f9b-9e58-4f8f-8a9d-083de599986c + reference: Direct Cost 735b5f9b-9e58-4f8f-8a9d-083de599986c + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-02T00:00:00' + totalAmount: 13684.57 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-02T00:00:00' + totalAmount: -13684.57 + subTotal: 12440.52 + taxAmount: 1244.05 + totalAmount: 13684.57 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-10-13T07:15:02' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 90 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directCosts?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directCosts + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directCosts?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 6ab3e391-97d7-ec11-8e7e-000d3a0cfe40 + reference: INS000090 + note: '3931' + issueDate: '2022-05-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: test expenses 2 + accountRef: + id: '30' + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + unitAmount: 17.89 + quantity: -1 + subTotal: -17.89 + taxAmount: 0 + totalAmount: -17.89 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 6ab3e391-97d7-ec11-8e7e-000d3a0cfe40 + accountRef: + id: TEST + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-21T00:00:00' + totalAmount: -17.89 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-21T00:00:00' + totalAmount: -17.89 + subTotal: -17.89 + taxAmount: 0 + totalAmount: -17.89 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-19T17:17:33Z' + metadata: + isDeleted: false + - id: b832f518-88d7-ec11-8e7e-000d3a0cfe40 + reference: INS000050 + note: '3915' + issueDate: '2022-05-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Utilities Expense + accountRef: + id: '31300' + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + unitAmount: 14.76 + quantity: 1 + subTotal: 14.76 + taxAmount: 0 + totalAmount: 14.76 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: b832f518-88d7-ec11-8e7e-000d3a0cfe40 + accountRef: + id: TEST + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-23T00:00:00' + totalAmount: 14.76 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-23T00:00:00' + totalAmount: 14.76 + subTotal: 14.76 + taxAmount: 0 + totalAmount: 14.76 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-19T15:26:48Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 67 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directCosts?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directCosts + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directCosts?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '190325254' + note: 'Atomic Software Limite Wellington,Nzl' + issueDate: '2017-11-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: '285' + name: Accommodation and Meals + unitAmount: 11.92 + quantity: 1 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '190325254' + note: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + allocation: + currency: GBP + allocatedOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2019-11-22T14:31:14Z' + metadata: + isDeleted: false + - id: '348108455' + note: 'Atomic Software Limite Wellington,Nzl' + issueDate: '2017-11-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: '285' + name: Accommodation and Meals + unitAmount: 11.92 + quantity: 1 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '348108455' + note: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + allocation: + currency: GBP + allocatedOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2022-10-24T12:35:29Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 456 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directCosts?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directCosts + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directCosts?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '29870062' + reference: Food to keep me working + note: Food to keep me working + contactRef: + id: Sainsburys + dataType: suppliers + issueDate: '2019-02-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Food to keep me working + accountRef: + id: '3361426' + name: Meals & Entertainment + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + trackingCategoryRefs: + - id: '4370503' + name: Meals & Entertainment + paymentAllocations: [] + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-10-28T15:21:46' + metadata: + isDeleted: false + - id: '107509561' + reference: Buying pencils + note: Buying pencils + contactRef: + id: Pencils Wholesale + dataType: suppliers + issueDate: '2020-01-27T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Buying pencils + accountRef: + id: '3380551' + name: Supplies + unitAmount: 43.48 + quantity: 1 + subTotal: 43.48 + taxAmount: 6.52 + totalAmount: 50 + trackingCategoryRefs: + - id: '5397997' + name: Supplies + paymentAllocations: [] + subTotal: 43.48 + taxAmount: 6.52 + totalAmount: 50 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-10-28T15:21:47' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 73 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/connections/100d8da9-91b1-495c-ae2e-2219c244acae/data/directCosts?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/connections/100d8da9-91b1-495c-ae2e-2219c244acae/data/directCosts + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/connections/100d8da9-91b1-495c-ae2e-2219c244acae/data/directCosts?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: D7B-933784104 + reference: '93' + contactRef: + id: 360000-933272659 + dataType: suppliers + issueDate: '2022-12-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 3C0000-933270542 + name: Rent + unitAmount: 1200 + quantity: 1 + subTotal: 1200 + totalAmount: 1200 + trackingCategoryRefs: + - id: 80000007-1197713802 + name: Overhead + tracking: + recordRefs: + - id: 80000007-1197713802 + dataType: trackingCategories + - id: 800000B0-1197755238 + dataType: customers + paymentAllocations: + - payment: + id: D7B-933784104 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-01T00:00:00' + totalAmount: 1200 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-01T00:00:00' + totalAmount: 1200 + subTotal: 1200 + taxAmount: 0 + totalAmount: 1200 + modifiedDate: '2023-04-26T09:13:57Z' + sourceModifiedDate: '2023-12-16T05:04:10' + metadata: + isDeleted: false + - id: DFA-933785132 + reference: '95' + contactRef: + id: 320000-933272659 + dataType: suppliers + issueDate: '2022-12-05T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 280000-933270542 + name: Freight & Delivery + unitAmount: 35 + quantity: 1 + subTotal: 35 + totalAmount: 35 + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + tracking: + recordRefs: + - id: 40000-933272658 + dataType: trackingCategories + - id: 1E0000-933272658 + dataType: customers + paymentAllocations: + - payment: + id: DFA-933785132 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-05T00:00:00' + totalAmount: 35 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-05T00:00:00' + totalAmount: 35 + subTotal: 35 + taxAmount: 0 + totalAmount: 35 + modifiedDate: '2023-04-26T09:13:57Z' + sourceModifiedDate: '2023-12-16T05:04:11' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 250 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directCosts?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directCosts + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directCosts?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: PUR-85 + note: Opening Balance from Bank + issueDate: '2015-08-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '55' + name: Opening Balance Equity + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + unitAmount: 3831.8 + quantity: 1 + subTotal: 3831.8 + taxAmount: 0 + totalAmount: 3831.8 + trackingCategoryRefs: [] + tracking: + recordRefs: [] + paymentAllocations: + - payment: + id: '85' + reference: Opening Balance from Bank + accountRef: + id: '57' + name: Visa Credit Card + currency: GBP + currencyRate: 1 + paidOnDate: '2015-08-12T00:00:00' + totalAmount: 3831.8 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-08-12T00:00:00' + totalAmount: -3831.8 + subTotal: 3831.8 + taxAmount: 0 + totalAmount: 3831.8 + modifiedDate: '2023-04-26T09:36:40Z' + sourceModifiedDate: '2016-09-12T18:13:07Z' + metadata: + isDeleted: false + - id: PUR-3617 + reference: '2001' + contactRef: + id: '27' + dataType: suppliers + issueDate: '2015-11-27T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Insurance - general liability + accountRef: + id: '22' + name: Insurance Expense-General Liability Insurance + taxRateRef: + id: 3_Bills + name: 20.0% S Bills + effectiveTaxRate: 20 + unitAmount: 750 + quantity: 1 + subTotal: 750 + taxAmount: 150 + totalAmount: 900 + trackingCategoryRefs: [] + tracking: + recordRefs: [] + paymentAllocations: + - payment: + id: '3617' + note: '2001' + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2015-11-27T00:00:00' + totalAmount: 900 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-11-27T00:00:00' + totalAmount: -900 + subTotal: 750 + taxAmount: 150 + totalAmount: 900 + modifiedDate: '2023-04-26T09:36:40Z' + sourceModifiedDate: '2022-08-19T10:19:56Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 4460 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directCosts?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directCosts + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directCosts?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: PUR-15 + note: Payment to Google + issueDate: '2018-09-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Payment to Google + accountRef: + id: '37' + name: Computer equipment accumulated depreciation brought forward + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + unitAmount: 1.59 + quantity: 1 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '15' + reference: Payment to Google + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-09-21T00:00:00' + totalAmount: 1.59 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-09-21T00:00:00' + totalAmount: -1.59 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + modifiedDate: '2023-01-18T11:02:59Z' + sourceModifiedDate: '2018-12-17T14:56:44Z' + - id: PUR-9303 + note: Payment to Google + contactRef: + id: '4' + dataType: suppliers + issueDate: '2018-09-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Payment to Google + accountRef: + id: '37' + name: Computer equipment accumulated depreciation brought forward + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + unitAmount: 1.59 + quantity: 1 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '9303' + reference: Payment to Google + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-09-21T00:00:00' + totalAmount: 1.59 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-09-21T00:00:00' + totalAmount: -1.59 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + modifiedDate: '2023-01-18T11:02:59Z' + sourceModifiedDate: '2022-07-11T10:32:16Z' + pageNumber: 1 + pageSize: 2 + totalResults: 2176 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directCosts?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directCosts + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directCosts?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '73' + reference: DD/STO + issueDate: '2021-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Electrcity Direct Debit + accountRef: + id: '7200' + name: Electricity + taxRateRef: + id: '3' + unitAmount: 150 + quantity: 1 + subTotal: 150 + taxAmount: 12 + totalAmount: 162 + trackingCategoryRefs: + - id: department_0 + name: Default + paymentAllocations: + - payment: + id: '73' + reference: DD/STO + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-29T00:00:00' + totalAmount: 162 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-29T00:00:00' + totalAmount: 162 + subTotal: 150 + taxAmount: 12 + totalAmount: 162 + modifiedDate: '2023-03-30T14:42:35Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + - id: '52' + reference: '568953' + issueDate: '2021-01-30T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Vat Payment Quater End 3112.96 + accountRef: + id: '2202' + name: VAT Liability + taxRateRef: + id: '9' + name: Non-Vatable Tax Code + effectiveTaxRate: 0 + unitAmount: 1497.58 + quantity: 1 + subTotal: 1497.58 + taxAmount: 0 + totalAmount: 1497.58 + trackingCategoryRefs: + - id: department_0 + name: Default + paymentAllocations: + - payment: + id: '52' + reference: '568953' + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-30T00:00:00' + totalAmount: 1497.58 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-30T00:00:00' + totalAmount: 1497.58 + subTotal: 1497.58 + taxAmount: 0 + totalAmount: 1497.58 + modifiedDate: '2023-03-30T14:42:35Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 106 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/directCosts?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/directCosts + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/directCosts?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: 'CCTRANSACTION:4355' + reference: '' + note: Test 1 + issueDate: '2020-01-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '195' + name: Insurance + taxRateRef: + id: '62018' + unitAmount: 9.99 + quantity: 1 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '4355' + note: '' + reference: '' + accountRef: + id: '348' + name: CMRR Renewal + currency: GBP + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + allocation: + currency: GBP + allocatedOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + modifiedDate: '2022-10-28T11:10:28Z' + sourceModifiedDate: '2022-08-22T09:26:42' + - id: 'CCTRANSACTION:4356' + reference: '' + note: Test 1 + issueDate: '2020-01-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '195' + name: Insurance + taxRateRef: + id: '62022' + unitAmount: 9.99 + quantity: 1 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '4356' + note: '' + reference: '' + accountRef: + id: '348' + name: CMRR Renewal + currency: GBP + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + allocation: + currency: GBP + allocatedOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + modifiedDate: '2022-10-28T11:10:28Z' + sourceModifiedDate: '2022-02-17T23:26:16' + pageNumber: 1 + pageSize: 2 + totalResults: 57 + _links: + current: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directCosts?page=1&pageSize=2 + self: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directCosts + next: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directCosts?page=2&pageSize=2 + Xero: + value: + results: + - id: dc1bb034-7bbf-4e84-b418-b7f4aee59d72 + reference: '' + contactRef: + id: 737982b0-2811-44c9-bdb3-3b26a3a6ef8c + dataType: suppliers + issueDate: '2022-11-22T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Bank fee + accountRef: + id: 2c410b86-de57-49d1-b540-4e8ce824979c + name: Bank Fees + unitAmount: 15 + quantity: 1 + subTotal: 15 + taxAmount: 0 + totalAmount: 15 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: dc1bb034-7bbf-4e84-b418-b7f4aee59d72 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-11-22T00:00:00' + totalAmount: 15 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-11-22T00:00:00' + totalAmount: 15 + subTotal: 15 + taxAmount: 0 + totalAmount: 15 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-03T21:43:46' + metadata: + isDeleted: false + - id: 521c2396-7f74-404c-9cca-31115296b808 + reference: Eft + contactRef: + id: 74ea95ea-6e1e-435d-9c30-0dff8ae1bd80 + dataType: suppliers + issueDate: '2022-11-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Misc stationery + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + taxRateRef: + id: INPUT2 + name: 20% (VAT on Expenses) + effectiveTaxRate: 20 + unitAmount: 18.09 + quantity: 1 + subTotal: 18.09 + taxAmount: 3.62 + totalAmount: 21.71 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 521c2396-7f74-404c-9cca-31115296b808 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-11-23T00:00:00' + totalAmount: 21.71 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-11-23T00:00:00' + totalAmount: 21.71 + subTotal: 18.09 + taxAmount: 3.62 + totalAmount: 21.71 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-03T21:43:51' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 15 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directCosts?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directCosts + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directCosts?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List direct costs* endpoint returns a list of [direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) for a given company's connection.\n\n[Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-direct-costs + x-speakeasy-group: transactions.direct-costs + '/companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectCostId' + get: + tags: + - Transactions + summary: Get direct cost + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingDirectCost' + examples: + Clear Books: + value: + id: 994ad234-ca05-466e-8e6a-117783b38cf6 + reference: 005b7b62-dc9f-42d2-85a2-4a2cefc6bab2 + note: 'Direct Cost with 1 line items, totaling 242.20' + contactRef: + id: D4Q4iYwHou + dataType: suppliers + issueDate: '2022-04-27T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Saddle Branches 160mm x 110mm x 87 � + accountRef: + id: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 220.18 + quantity: 1 + discountAmount: 0 + discountPercentage: 0 + subTotal: 220.18 + taxAmount: 22.02 + totalAmount: 242.2 + itemRef: + id: '2' + name: Solvent Weld Branch 160mm x 110mm x 87 � + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 994ad234-ca05-466e-8e6a-117783b38cf6 + note: Payment for direct cost 994ad234-ca05-466e-8e6a-117783b38cf6 + reference: Direct Cost 994ad234-ca05-466e-8e6a-117783b38cf6 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-27T00:00:00' + totalAmount: 242.2 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-27T00:00:00' + totalAmount: -242.2 + subTotal: 220.18 + taxAmount: 22.02 + totalAmount: 242.2 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-09-18T20:59:02' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 6ab3e391-97d7-ec11-8e7e-000d3a0cfe40 + reference: INS000090 + note: '3931' + issueDate: '2022-05-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: test expenses 2 + accountRef: + id: '30' + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + unitAmount: 17.89 + quantity: -1 + subTotal: -17.89 + taxAmount: 0 + totalAmount: -17.89 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 6ab3e391-97d7-ec11-8e7e-000d3a0cfe40 + accountRef: + id: TEST + currency: GBP + currencyRate: 1 + paidOnDate: '2022-05-21T00:00:00' + totalAmount: -17.89 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-05-21T00:00:00' + totalAmount: -17.89 + subTotal: -17.89 + taxAmount: 0 + totalAmount: -17.89 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-19T17:17:33Z' + metadata: + isDeleted: false + FreeAgent: + value: + id: '190325254' + note: 'Atomic Software Limite Wellington,Nzl' + issueDate: '2017-11-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: '285' + name: Accommodation and Meals + unitAmount: 11.92 + quantity: 1 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '190325254' + note: 'Atomic Software Limite Wellington,Nzl' + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + allocation: + currency: GBP + allocatedOnDate: '2017-11-23T00:00:00' + totalAmount: 14.3 + subTotal: 11.92 + taxAmount: 2.38 + totalAmount: 14.3 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2019-11-22T14:31:14Z' + metadata: + isDeleted: false + FreshBooks: + value: + id: '29870062' + reference: Food to keep me working + note: Food to keep me working + contactRef: + id: Sainsburys + dataType: suppliers + issueDate: '2019-02-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Food to keep me working + accountRef: + id: '3361426' + name: Meals & Entertainment + unitAmount: 10 + quantity: 1 + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + trackingCategoryRefs: + - id: '4370503' + name: Meals & Entertainment + paymentAllocations: [] + subTotal: 10 + taxAmount: 0 + totalAmount: 10 + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-10-28T15:21:46' + metadata: + isDeleted: false + QuickBooks Desktop: + value: + id: D7B-933784104 + reference: '93' + contactRef: + id: 360000-933272659 + dataType: suppliers + issueDate: '2022-12-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 3C0000-933270542 + name: Rent + unitAmount: 1200 + quantity: 1 + subTotal: 1200 + totalAmount: 1200 + trackingCategoryRefs: + - id: 80000007-1197713802 + name: Overhead + tracking: + recordRefs: + - id: 80000007-1197713802 + dataType: trackingCategories + - id: 800000B0-1197755238 + dataType: customers + paymentAllocations: + - payment: + id: D7B-933784104 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2022-12-01T00:00:00' + totalAmount: 1200 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-12-01T00:00:00' + totalAmount: 1200 + subTotal: 1200 + taxAmount: 0 + totalAmount: 1200 + modifiedDate: '2023-04-26T09:13:57Z' + sourceModifiedDate: '2023-12-16T05:04:10' + metadata: + isDeleted: false + QuickBooks Online Sandbox: + value: + id: PUR-85 + note: Opening Balance from Bank + issueDate: '2015-08-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '55' + name: Opening Balance Equity + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + unitAmount: 3831.8 + quantity: 1 + subTotal: 3831.8 + taxAmount: 0 + totalAmount: 3831.8 + trackingCategoryRefs: [] + tracking: + recordRefs: [] + paymentAllocations: + - payment: + id: '85' + reference: Opening Balance from Bank + accountRef: + id: '57' + name: Visa Credit Card + currency: GBP + currencyRate: 1 + paidOnDate: '2015-08-12T00:00:00' + totalAmount: 3831.8 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-08-12T00:00:00' + totalAmount: -3831.8 + subTotal: 3831.8 + taxAmount: 0 + totalAmount: 3831.8 + modifiedDate: '2023-04-26T09:36:40Z' + sourceModifiedDate: '2016-09-12T18:13:07Z' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: PUR-15 + note: Payment to Google + issueDate: '2018-09-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Payment to Google + accountRef: + id: '37' + name: Computer equipment accumulated depreciation brought forward + taxRateRef: + id: NON + name: NON + effectiveTaxRate: 0 + unitAmount: 1.59 + quantity: 1 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '15' + reference: Payment to Google + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-09-21T00:00:00' + totalAmount: 1.59 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-09-21T00:00:00' + totalAmount: -1.59 + subTotal: 1.59 + taxAmount: 0 + totalAmount: 1.59 + modifiedDate: '2023-01-18T11:02:59Z' + sourceModifiedDate: '2018-12-17T14:56:44Z' + Sage 50 (UK): + value: + id: '73' + reference: DD/STO + issueDate: '2021-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Electrcity Direct Debit + accountRef: + id: '7200' + name: Electricity + taxRateRef: + id: '3' + unitAmount: 150 + quantity: 1 + subTotal: 150 + taxAmount: 12 + totalAmount: 162 + trackingCategoryRefs: + - id: department_0 + name: Default + paymentAllocations: + - payment: + id: '73' + reference: DD/STO + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2021-01-29T00:00:00' + totalAmount: 162 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2021-01-29T00:00:00' + totalAmount: 162 + subTotal: 150 + taxAmount: 12 + totalAmount: 162 + modifiedDate: '2023-03-30T14:42:35Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + Sage Intacct: + value: + id: 'CCTRANSACTION:4355' + reference: '' + note: Test 1 + issueDate: '2020-01-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '195' + name: Insurance + taxRateRef: + id: '62018' + unitAmount: 9.99 + quantity: 1 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + trackingCategoryRefs: + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '4355' + note: '' + reference: '' + accountRef: + id: '348' + name: CMRR Renewal + currency: GBP + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + allocation: + currency: GBP + allocatedOnDate: '2020-01-20T00:00:00' + totalAmount: 11.99 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + modifiedDate: '2022-10-28T11:10:28Z' + sourceModifiedDate: '2022-08-22T09:26:42' + Xero: + value: + id: dc1bb034-7bbf-4e84-b418-b7f4aee59d72 + reference: '' + contactRef: + id: 737982b0-2811-44c9-bdb3-3b26a3a6ef8c + dataType: suppliers + issueDate: '2022-11-22T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Bank fee + accountRef: + id: 2c410b86-de57-49d1-b540-4e8ce824979c + name: Bank Fees + unitAmount: 15 + quantity: 1 + subTotal: 15 + taxAmount: 0 + totalAmount: 15 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: dc1bb034-7bbf-4e84-b418-b7f4aee59d72 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-11-22T00:00:00' + totalAmount: 15 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-11-22T00:00:00' + totalAmount: 15 + subTotal: 15 + taxAmount: 0 + totalAmount: 15 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2021-01-03T21:43:46' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get direct cost* endpoint returns a single direct cost for a given directCostId. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-direct-cost + x-speakeasy-group: transactions.direct-costs + '/companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectCostId' + get: + tags: + - Transactions + summary: Get direct cost attachment + parameters: + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Get direct cost attachment* endpoint returns a specific attachment for a given `directCostId` and `attachmentId`. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + operationId: get-accounting-direct-cost-attachment + x-speakeasy-group: transactions.direct-costs + '/companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectCostId' + get: + tags: + - Transactions + summary: Download direct cost attachment + parameters: + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Download direct cost attachment* endpoint downloads a specific attachment for a given `directCostId` and `attachmentId`. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + operationId: download-accounting-direct-cost-attachment + x-speakeasy-group: transactions.direct-costs + '/companies/{companyId}/connections/{connectionId}/data/directCosts/{directCostId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectCostId' + get: + tags: + - Transactions + summary: List direct cost attachments + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *List direct cost attachments* endpoint returns a list of attachments available to download for given `directCostId`. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + operationId: list-accounting-direct-cost-attachments + x-speakeasy-group: transactions.direct-costs + '/companies/{companyId}/connections/{connectionId}/data/directIncomes': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Accounts receivable + summary: List direct incomes + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingDirectIncomes' + examples: + Clear Books: + value: + results: + - id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + reference: 3cb8ced3-3ecb-4974-ada5-8290b0ec3355 + note: 'Direct Income with 1 line items, totaling 188.33' + contactRef: + id: 51f03576-f6b0-40d5-9fba-81a490411c03 + dataType: customers + issueDate: '2022-04-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Yard Gully + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 171.21 + quantity: 1 + discountAmount: 0 + discountPercentage: 0 + subTotal: 171.21 + taxAmount: 17.12 + totalAmount: 188.33 + itemRef: + id: 00491160-6ee5-4d76-9f34-998f00687481 + name: Aluminium Silt Bucket + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + note: Payment for direct income 38e8c917-0afc-4583-8ffe-1b53ad601197 + reference: Direct Income 38e8c917-0afc-4583-8ffe-1b53ad601197 + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-19T00:00:00' + totalAmount: 188.33 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-19T00:00:00' + totalAmount: -188.33 + subTotal: 171.21 + taxAmount: 17.12 + totalAmount: 188.33 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-05-13T01:06:00' + metadata: + isDeleted: false + - id: c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + reference: ee4ea56f-8806-494d-9c69-7ec22e68dc5e + note: 'Direct Income with 4 line items, totaling 32095.91' + contactRef: + id: 453ddfc0-49ce-4f66-a815-dae734be885c + dataType: customers + issueDate: '2022-04-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Bottle Gullies 90 degree Rectangular + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 95.08 + quantity: 2 + discountAmount: 0 + discountPercentage: 0 + subTotal: 190.16 + taxAmount: 19.02 + totalAmount: 209.18 + itemRef: + id: '6' + name: Back Inlet Roddable Gully 90� Outlet Rectangular Grid + trackingCategoryRefs: + - id: costcode_9 + name: PandaConstruction + - id: department_3 + name: MarshallBrotherContracting + - description: Grease Trap + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 1251.89 + quantity: 6 + discountAmount: 778.93 + discountPercentage: 10.37 + subTotal: 6732.41 + taxAmount: 673.24 + totalAmount: 7405.66 + itemRef: + id: 51077072-d5c3-463b-9cb4-7da2e11886f9 + name: 150 Litre Grease Trap + trackingCategoryRefs: [] + - description: Grease Trap + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 2781.94 + quantity: 2 + discountAmount: 0 + discountPercentage: 0 + subTotal: 5563.88 + taxAmount: 556.39 + totalAmount: 6120.27 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + - description: Grease Trap + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 2781.94 + quantity: 6 + discountAmount: 0 + discountPercentage: 0 + subTotal: 16691.64 + taxAmount: 1669.16 + totalAmount: 18360.8 + itemRef: + id: 22aee6bd-4767-48c4-8a13-fdf85b91fc80 + name: 600 Litre Grease Trap + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + note: Payment for direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + reference: Direct Income c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-19T00:00:00' + totalAmount: 32095.91 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-19T00:00:00' + totalAmount: -32095.91 + subTotal: 29178.09 + taxAmount: 2917.81 + totalAmount: 32095.91 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2023-02-13T00:34:00' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 518 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directIncomes + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/directIncomes?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 8be30162-feec-ec11-82f9-000d3a8746a9 + reference: B1234 + note: '4006' + issueDate: '2022-06-18T00:00:00' + currency: USD + currencyRate: 0.648364486 + lineItems: + - description: Interest Income + accountRef: + id: 221217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Interest Income + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + unitAmount: 7.13 + quantity: 1 + subTotal: 7.13 + taxAmount: 1.43 + totalAmount: 8.56 + trackingCategoryRefs: + - id: adbc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: ADM-Administration + paymentAllocations: + - payment: + id: 8be30162-feec-ec11-82f9-000d3a8746a9 + accountRef: + id: 8277672c-b8e6-ec11-82f8-0022481a77f0 + name: B020-BoA + currency: USD + currencyRate: 0.6483644859813084 + paidOnDate: '2022-06-18T00:00:00' + totalAmount: 8.56 + allocation: + currency: USD + currencyRate: 0.6483644859813084 + allocatedOnDate: '2022-06-18T00:00:00' + totalAmount: 8.56 + subTotal: 7.13 + taxAmount: 1.43 + totalAmount: 8.56 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-06-15T22:56:26Z' + metadata: + isDeleted: false + - id: f68e56e0-b8bd-ed11-9a88-6045bd0f9361 + reference: B110 + note: '4990' + issueDate: '2023-03-07T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Accounts Receivable + accountRef: + id: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Receivable + taxRateRef: + id: cc81fea8-2917-ed11-90eb-002248009df3 + name: '' + effectiveTaxRate: 0 + unitAmount: 649.4 + quantity: -1 + subTotal: -649.4 + taxAmount: 0 + totalAmount: -649.4 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: f68e56e0-b8bd-ed11-9a88-6045bd0f9361 + accountRef: + id: b6545a08-a9bd-ed11-9a88-0022484358c7 + name: HOLDING_LENDING + currency: GBP + currencyRate: 1 + paidOnDate: '2023-03-07T00:00:00' + totalAmount: -649.4 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-03-07T00:00:00' + totalAmount: -649.4 + subTotal: -649.4 + taxAmount: 0 + totalAmount: -649.4 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2023-03-08T13:55:34Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/directIncomes + FreeAgent: + value: + results: + - id: '344673327' + note: Test Transaction 2 + issueDate: '2017-11-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Test Transaction 2 + accountRef: + id: '001' + name: Sales + unitAmount: 10.5 + quantity: 1 + subTotal: 10.5 + taxAmount: 0 + totalAmount: 10.5 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '344673327' + note: Test Transaction 2 + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-01T00:00:00' + totalAmount: 10.5 + allocation: + currency: GBP + allocatedOnDate: '2017-11-01T00:00:00' + totalAmount: 10.5 + subTotal: 10.5 + taxAmount: 0 + totalAmount: 10.5 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2022-10-06T10:38:24Z' + metadata: + isDeleted: false + - id: '348104863' + note: 'Codat Ltd Ref: Nov Topup' + issueDate: '2017-11-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Codat Ltd Ref: Nov Topup' + accountRef: + id: '001' + name: Sales + unitAmount: 100 + quantity: 1 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '348104863' + note: 'Codat Ltd Ref: Nov Topup' + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-23T00:00:00' + totalAmount: 100 + allocation: + currency: GBP + allocatedOnDate: '2017-11-23T00:00:00' + totalAmount: 100 + subTotal: 100 + taxAmount: 0 + totalAmount: 100 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2022-10-24T12:13:27Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 211 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directIncomes + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/directIncomes?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 9B87-1181931723 + reference: 9C08-1181931827 + contactRef: + id: 280000-933272658 + dataType: customers + issueDate: '2023-01-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 80000-933270541 + name: Undeposited Funds + unitAmount: 1228.18 + quantity: 1 + subTotal: 1228.18 + taxAmount: 0 + totalAmount: 1228.18 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 9B87-1181931723 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-15T00:00:00' + totalAmount: 1228.18 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-01-15T00:00:00' + totalAmount: 1228.18 + subTotal: 1228.18 + taxAmount: 0 + totalAmount: 1228.18 + modifiedDate: '2023-04-26T09:14:12Z' + sourceModifiedDate: '2023-12-16T05:06:23' + metadata: + isDeleted: false + - id: 68E0-1197775239 + reference: 96F3-1197775718 + contactRef: + id: 800000B5-1197701259 + dataType: customers + issueDate: '2023-01-17T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 80000-933270541 + name: Undeposited Funds + unitAmount: 361.08 + quantity: 1 + subTotal: 361.08 + taxAmount: 0 + totalAmount: 361.08 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 68E0-1197775239 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-17T00:00:00' + totalAmount: 15281.67 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-01-17T00:00:00' + totalAmount: 361.08 + subTotal: 361.08 + taxAmount: 0 + totalAmount: 361.08 + modifiedDate: '2023-04-26T09:14:12Z' + sourceModifiedDate: '2023-12-16T05:06:11' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 104 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directIncomes + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/directIncomes?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: 5-1 + contactRef: + id: '52' + dataType: suppliers + issueDate: '2015-11-24T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: contribution to start business + accountRef: + id: '61' + name: Owner's Equity - Contributions + taxRateRef: + id: 2_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + unitAmount: 10000 + quantity: 1 + discountAmount: 0 + subTotal: 10000 + taxAmount: 0 + totalAmount: 10000 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 5-1 + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2015-11-24T00:00:00' + totalAmount: 10000 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-11-24T00:00:00' + totalAmount: -10000 + subTotal: 10000 + taxAmount: 0 + totalAmount: 10000 + modifiedDate: '2023-04-26T09:36:04Z' + sourceModifiedDate: '2016-09-12T15:26:26Z' + metadata: + isDeleted: false + - id: 5-2 + contactRef: + id: '53' + dataType: suppliers + issueDate: '2015-11-24T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: funds borrowed to start business + accountRef: + id: '63' + name: Note Payable + taxRateRef: + id: 2_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + unitAmount: 25000 + quantity: 1 + discountAmount: 0 + subTotal: 25000 + taxAmount: 0 + totalAmount: 25000 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 5-2 + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2015-11-24T00:00:00' + totalAmount: 25000 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-11-24T00:00:00' + totalAmount: -25000 + subTotal: 25000 + taxAmount: 0 + totalAmount: 25000 + modifiedDate: '2023-04-26T09:36:04Z' + sourceModifiedDate: '2016-09-12T15:26:26Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 741 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directIncomes + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/directIncomes?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '1' + note: Opening Balance from Bank + issueDate: '2018-09-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '53' + name: Retained profit balance forward account + unitAmount: 170.23 + quantity: 1 + discountAmount: 0 + subTotal: 170.23 + taxAmount: 0 + totalAmount: 170.23 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '1' + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-09-21T00:00:00' + totalAmount: 170.23 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-09-21T00:00:00' + totalAmount: -170.23 + subTotal: 170.23 + taxAmount: 0 + totalAmount: 170.23 + modifiedDate: '2023-01-18T11:02:50Z' + sourceModifiedDate: '2018-12-17T14:56:20Z' + - id: '11' + note: 'Payment from CD Baby, a division of Audio and Video Labs Inc' + issueDate: '2018-10-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 'Payment from CD Baby, a division of Audio and Video Labs Inc' + accountRef: + id: '57' + name: Sales of Product Income + unitAmount: 8.12 + quantity: 1 + discountAmount: 0 + subTotal: 8.12 + taxAmount: 0 + totalAmount: 8.12 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '11' + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-10-15T00:00:00' + totalAmount: 8.12 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-10-15T00:00:00' + totalAmount: -8.12 + subTotal: 8.12 + taxAmount: 0 + totalAmount: 8.12 + modifiedDate: '2023-01-18T11:02:50Z' + sourceModifiedDate: '2018-12-17T14:56:44Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1171 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directIncomes + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/directIncomes?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '4973' + reference: dt test contact + note: dt header description + issueDate: '2022-03-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Dt test line1 + accountRef: + id: '151' + name: Cash + taxRateRef: + id: '99' + name: UK Sale Goods Standard Rate + effectiveTaxRate: 20 + unitAmount: 125 + quantity: 1 + subTotal: 125 + taxAmount: 25 + totalAmount: 150 + trackingCategoryRefs: + - id: DEPARTMENT-1 + name: Sales + - id: LOCATION-8 + name: United Kingdom + - description: dt test line 2 + accountRef: + id: '152' + name: Cash Equivalents + taxRateRef: + id: '99' + name: UK Sale Goods Standard Rate + effectiveTaxRate: 20 + unitAmount: 166.67 + quantity: 1 + subTotal: 166.67 + taxAmount: 33.33 + totalAmount: 200 + trackingCategoryRefs: + - id: DEPARTMENT-2 + name: Services + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '4973' + note: dt header description + accountRef: + id: '289' + name: Checking 5 - Bank Of England + currency: GBP + paidOnDate: '2022-03-15T00:00:00' + totalAmount: 350 + allocation: + currency: GBP + allocatedOnDate: '2022-03-15T00:00:00' + totalAmount: 350 + subTotal: 291.67 + taxAmount: 58.33 + totalAmount: 350 + modifiedDate: '2022-10-28T11:10:26Z' + sourceModifiedDate: '2022-03-15T12:45:58Z' + - id: '5314' + reference: Test Int Income + note: Test Description + issueDate: '2022-03-24T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Interest earned + accountRef: + id: '5' + name: Other Income + unitAmount: 300 + quantity: 1 + subTotal: 300 + totalAmount: 300 + trackingCategoryRefs: + - id: DEPARTMENT-1 + name: Sales + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '5314' + note: Test Description + reference: Test Int Income + accountRef: + id: '289' + name: Checking 5 - Bank Of England + currency: GBP + paidOnDate: '2022-03-24T00:00:00' + totalAmount: 300 + allocation: + currency: GBP + allocatedOnDate: '2022-03-24T00:00:00' + totalAmount: 300 + subTotal: 300 + taxAmount: 0 + totalAmount: 300 + modifiedDate: '2022-10-28T11:10:26Z' + pageNumber: 1 + pageSize: 2 + totalResults: 43 + _links: + current: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directIncomes + next: + href: /companies/71ca2b28-8e86-41e7-8c55-f681042b11a0/connections/be80adfc-1157-4db4-9170-f8bcbbc051ba/data/directIncomes?page=2&pageSize=2 + Xero: + value: + results: + - id: 3a1be853-5964-4afe-ad6a-fb89cbaf6606 + reference: Sub 098801 + contactRef: + id: bc446de5-971e-48b5-8efd-1745149844ef + dataType: customers + issueDate: '2023-02-14T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Long-term subscriber discount - refund on sub + accountRef: + id: a40f43e2-c7b0-4187-919a-04ccdc14a630 + name: Subscriptions + taxRateRef: + id: EXEMPTINPUT + name: Exempt Expenses + effectiveTaxRate: 0 + unitAmount: 35 + quantity: 1 + subTotal: 35 + taxAmount: 0 + totalAmount: 35 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 3a1be853-5964-4afe-ad6a-fb89cbaf6606 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2023-02-14T00:00:00' + totalAmount: 35 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-02-14T00:00:00' + totalAmount: 35 + subTotal: 35 + taxAmount: 0 + totalAmount: 35 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2011-04-11T00:45:38' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directIncomes?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/directIncomes + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List direct incomes* endpoint returns a list of [direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) for a given company's connection.\n\n[Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are incomes received directly from the business' operations at the point of the sale.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-direct-incomes + x-speakeasy-group: accounts-receivable.direct-incomes + '/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Accounts receivable + summary: Get direct income + parameters: + - $ref: '#/components/parameters/accountingDirectIncomeId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingDirectIncome' + examples: + Clear Books: + value: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + reference: 3cb8ced3-3ecb-4974-ada5-8290b0ec3355 + note: 'Direct Income with 1 line items, totaling 188.33' + contactRef: + id: 51f03576-f6b0-40d5-9fba-81a490411c03 + dataType: customers + issueDate: '2022-04-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Underground - Drain Yard Gully + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + unitAmount: 171.21 + quantity: 1 + discountAmount: 0 + discountPercentage: 0 + subTotal: 171.21 + taxAmount: 17.12 + totalAmount: 188.33 + itemRef: + id: 00491160-6ee5-4d76-9f34-998f00687481 + name: Aluminium Silt Bucket + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + note: Payment for direct income 38e8c917-0afc-4583-8ffe-1b53ad601197 + reference: Direct Income 38e8c917-0afc-4583-8ffe-1b53ad601197 + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-19T00:00:00' + totalAmount: 188.33 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-19T00:00:00' + totalAmount: -188.33 + subTotal: 171.21 + taxAmount: 17.12 + totalAmount: 188.33 + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-05-13T01:06:00' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 8be30162-feec-ec11-82f9-000d3a8746a9 + reference: B1234 + note: '4006' + issueDate: '2022-06-18T00:00:00' + currency: USD + currencyRate: 0.648364486 + lineItems: + - description: Interest Income + accountRef: + id: 221217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Interest Income + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + unitAmount: 7.13 + quantity: 1 + subTotal: 7.13 + taxAmount: 1.43 + totalAmount: 8.56 + trackingCategoryRefs: + - id: adbc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: ADM-Administration + paymentAllocations: + - payment: + id: 8be30162-feec-ec11-82f9-000d3a8746a9 + accountRef: + id: 8277672c-b8e6-ec11-82f8-0022481a77f0 + name: B020-BoA + currency: USD + currencyRate: 0.6483644859813084 + paidOnDate: '2022-06-18T00:00:00' + totalAmount: 8.56 + allocation: + currency: USD + currencyRate: 0.6483644859813084 + allocatedOnDate: '2022-06-18T00:00:00' + totalAmount: 8.56 + subTotal: 7.13 + taxAmount: 1.43 + totalAmount: 8.56 + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-06-15T22:56:26Z' + metadata: + isDeleted: false + FreeAgent: + value: + id: '344673327' + note: Test Transaction 2 + issueDate: '2017-11-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Test Transaction 2 + accountRef: + id: '001' + name: Sales + unitAmount: 10.5 + quantity: 1 + subTotal: 10.5 + taxAmount: 0 + totalAmount: 10.5 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '344673327' + note: Test Transaction 2 + accountRef: + id: 750-1 + name: 'Bank Account: Business Current Account' + currency: GBP + paidOnDate: '2017-11-01T00:00:00' + totalAmount: 10.5 + allocation: + currency: GBP + allocatedOnDate: '2017-11-01T00:00:00' + totalAmount: 10.5 + subTotal: 10.5 + taxAmount: 0 + totalAmount: 10.5 + modifiedDate: '2023-04-25T14:20:36Z' + sourceModifiedDate: '2022-10-06T10:38:24Z' + metadata: + isDeleted: false + QuickBooks Desktop: + value: + id: 9B87-1181931723 + reference: 9C08-1181931827 + contactRef: + id: 280000-933272658 + dataType: customers + issueDate: '2023-01-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: 80000-933270541 + name: Undeposited Funds + unitAmount: 1228.18 + quantity: 1 + subTotal: 1228.18 + taxAmount: 0 + totalAmount: 1228.18 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 9B87-1181931723 + accountRef: + id: 20000-933270541 + name: Checking + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-15T00:00:00' + totalAmount: 1228.18 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-01-15T00:00:00' + totalAmount: 1228.18 + subTotal: 1228.18 + taxAmount: 0 + totalAmount: 1228.18 + modifiedDate: '2023-04-26T09:14:12Z' + sourceModifiedDate: '2023-12-16T05:06:23' + metadata: + isDeleted: false + QuickBooks Online Sandbox: + value: + id: 5-1 + contactRef: + id: '52' + dataType: suppliers + issueDate: '2015-11-24T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: contribution to start business + accountRef: + id: '61' + name: Owner's Equity - Contributions + taxRateRef: + id: 2_Invoices + name: Exempt Invoices + effectiveTaxRate: 0 + unitAmount: 10000 + quantity: 1 + discountAmount: 0 + subTotal: 10000 + taxAmount: 0 + totalAmount: 10000 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 5-1 + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2015-11-24T00:00:00' + totalAmount: 10000 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2015-11-24T00:00:00' + totalAmount: -10000 + subTotal: 10000 + taxAmount: 0 + totalAmount: 10000 + modifiedDate: '2023-04-26T09:36:04Z' + sourceModifiedDate: '2016-09-12T15:26:26Z' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '1' + note: Opening Balance from Bank + issueDate: '2018-09-21T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '53' + name: Retained profit balance forward account + unitAmount: 170.23 + quantity: 1 + discountAmount: 0 + subTotal: 170.23 + taxAmount: 0 + totalAmount: 170.23 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '1' + accountRef: + id: '61' + name: Dave PP Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-09-21T00:00:00' + totalAmount: 170.23 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2018-09-21T00:00:00' + totalAmount: -170.23 + subTotal: 170.23 + taxAmount: 0 + totalAmount: 170.23 + modifiedDate: '2023-01-18T11:02:50Z' + sourceModifiedDate: '2018-12-17T14:56:20Z' + Sage Intacct: + value: + id: '4973' + reference: dt test contact + note: dt header description + issueDate: '2022-03-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Dt test line1 + accountRef: + id: '151' + name: Cash + taxRateRef: + id: '99' + name: UK Sale Goods Standard Rate + effectiveTaxRate: 20 + unitAmount: 125 + quantity: 1 + subTotal: 125 + taxAmount: 25 + totalAmount: 150 + trackingCategoryRefs: + - id: DEPARTMENT-1 + name: Sales + - id: LOCATION-8 + name: United Kingdom + - description: dt test line 2 + accountRef: + id: '152' + name: Cash Equivalents + taxRateRef: + id: '99' + name: UK Sale Goods Standard Rate + effectiveTaxRate: 20 + unitAmount: 166.67 + quantity: 1 + subTotal: 166.67 + taxAmount: 33.33 + totalAmount: 200 + trackingCategoryRefs: + - id: DEPARTMENT-2 + name: Services + - id: LOCATION-8 + name: United Kingdom + paymentAllocations: + - payment: + id: '4973' + note: dt header description + accountRef: + id: '289' + name: Checking 5 - Bank Of England + currency: GBP + paidOnDate: '2022-03-15T00:00:00' + totalAmount: 350 + allocation: + currency: GBP + allocatedOnDate: '2022-03-15T00:00:00' + totalAmount: 350 + subTotal: 291.67 + taxAmount: 58.33 + totalAmount: 350 + modifiedDate: '2022-10-28T11:10:26Z' + sourceModifiedDate: '2022-03-15T12:45:58Z' + Xero: + value: + id: 3a1be853-5964-4afe-ad6a-fb89cbaf6606 + reference: Sub 098801 + contactRef: + id: bc446de5-971e-48b5-8efd-1745149844ef + dataType: customers + issueDate: '2023-02-14T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Long-term subscriber discount - refund on sub + accountRef: + id: a40f43e2-c7b0-4187-919a-04ccdc14a630 + name: Subscriptions + taxRateRef: + id: EXEMPTINPUT + name: Exempt Expenses + effectiveTaxRate: 0 + unitAmount: 35 + quantity: 1 + subTotal: 35 + taxAmount: 0 + totalAmount: 35 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: 3a1be853-5964-4afe-ad6a-fb89cbaf6606 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2023-02-14T00:00:00' + totalAmount: 35 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2023-02-14T00:00:00' + totalAmount: 35 + subTotal: 35 + taxAmount: 0 + totalAmount: 35 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2011-04-11T00:45:38' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get direct income* endpoint returns a single direct income for a given directIncomeId. + + [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are incomes received directly from the business' operations at the point of the sale. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-direct-income + x-speakeasy-group: accounts-receivable.direct-incomes + '/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectIncomeId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts receivable + summary: Get direct income attachment + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Get direct income attachment* endpoint returns a specific attachment for a given `directIncomeId` and `attachmentId`. + + [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are incomes received directly from the business' operations at the point of the sale. + operationId: get-accounting-direct-income-attachment + x-speakeasy-group: accounts-receivable.direct-incomes + '/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectIncomeId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts receivable + summary: Download direct income attachment + parameters: + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Download direct income attachment* endpoint downloads a specific attachment for a given `directIncomeId` and `attachmentId`. + + [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are incomes received directly from the business' operations at the point of the sale. + operationId: download-accounting-direct-income-attachment + x-speakeasy-group: accounts-receivable.direct-incomes + '/companies/{companyId}/connections/{connectionId}/data/directIncomes/{directIncomeId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingDirectIncomeId' + get: + tags: + - Accounts receivable + summary: List direct income attachments + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *List direct income attachments* endpoint returns a list of attachments available to download for given `directIncomeId`. + + [Direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome) are incomes received directly from the business' operations at the point of the sale. + operationId: list-accounting-direct-income-attachments + x-speakeasy-group: accounts-receivable.direct-incomes + '/companies/{companyId}/data/info': + parameters: + - $ref: '#/components/parameters/companyId' + get: + summary: Get company accounting profile + description: Gets the latest basic info for a company. + operationId: get-accounting-profile + x-speakeasy-name-override: get-accounting-profile + tags: + - Company info + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCompanyInfo' + examples: + Example 1: + value: + companyName: Codat + accountingPlatformRef: 1700060034_ETD + companyLegalName: Codat Ltd + addresses: + - type: Billing + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + region: England + country: United Kingdom + postalCode: WC1X 0BE + - type: Delivery + line1: 28 Easton Street + city: London + country: UK + postalCode: WC1X 0BE + phoneNumbers: + - number: 02012 345678 + type: Landline + - number: 07123 456789 + type: Mobile + - number: 02012 345678 + type: Fax + webLinks: + - type: Website + url: 'https://www.codat.io/' + - type: Social + url: 'https://www.linkedin.com/company/codat-limited/' + registrationNumber: '5590111724' + taxNumber: '74111622555799035846' + financialYearStartDate: '2023-04-01T00:00:00' + baseCurrency: GBP + sourceUrls: + Api: 'https://api.codat.io' + createdDate: '2020-03-09T15:19:26' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/invoices': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + summary: List invoices + description: "The *List invoices* endpoint returns a list of [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) for a given company's connection.\n\n[Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n \n### Useful queries\n\n- Outstanding invoices - `query = amountDue > 0`\n- Invoices due after a certain date: `query = dueDate > 2021-01-28`\n\n[Read more about querying](https://docs.codat.io/using-the-api/querying).\n\n### Tips and traps\n\nTo access the `paymentAllocations` property, ensure that the `payments` data type is queued and cached in Codat before retrieving `invoices` from Codat's cache.\n" + operationId: list-accounting-invoices + x-speakeasy-group: accounts-receivable.invoices + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingInvoices' + examples: + Clear Books: + value: + results: + - id: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + invoiceNumber: TKj7oD38 + customerRef: + id: d65ac505-072c-49ec-be3c-3cb74228966d + companyName: Jensen Steuber + salesOrderRefs: [] + issueDate: '2022-04-25T13:04:02' + dueDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2023-01-28T14:41:02' + paidOnDate: '2022-04-25T13:04:02' + currency: GBP + currencyRate: 1 + lineItems: + - description: Heavy Duty Hinged Gully Grating x4.00 + unitAmount: 402.89 + quantity: 4 + subTotal: 1611.56 + taxAmount: 161.16 + totalAmount: 1772.72 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + name: Heavy Duty Hinged Gully Grating + trackingCategoryRefs: + - id: costcode_9 + name: PandaConstruction + isDirectIncome: true + paymentAllocations: + - payment: + id: 9407d5ee-893a-4547-bd89-bc7b795ee774 + note: Payment against invoice 2518ca08-5e2a-4630-8cee-a6bcd1625660 + reference: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-25T13:04:02' + totalAmount: 1772.72 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + totalAmount: -1772.72 + withholdingTax: [] + totalDiscount: 0 + subTotal: 1611.56 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 161.16 + totalAmount: 1772.72 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + - id: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + invoiceNumber: 4F6ONfFP + customerRef: + id: a82042f1-a005-4ca5-bfd3-5bc237123aa5 + companyName: Keara Leffler + salesOrderRefs: [] + issueDate: '2022-04-25T13:04:02' + dueDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-08-22T07:43:02' + paidOnDate: '2022-04-25T13:04:02' + currency: GBP + currencyRate: 1 + lineItems: + - description: Heavy Duty Hinged Gully Grating x8.28 + unitAmount: 402.89 + quantity: 8.28 + subTotal: 3335.93 + taxAmount: 333.59 + totalAmount: 3669.52 + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + name: Heavy Duty Hinged Gully Grating + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 7ba4fc1b-e248-49ba-8bf8-0813d7f203a8 + note: Payment against invoice ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + reference: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-25T13:04:02' + totalAmount: 3669.52 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + totalAmount: -3669.52 + withholdingTax: [] + totalDiscount: 0 + subTotal: 3335.93 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 333.59 + totalAmount: 3669.52 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 142 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/invoices?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/invoices + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/invoices?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 18c906bf-89d1-ea11-bbaa-000d3a2b9185 + invoiceNumber: '103001' + customerRef: + id: b61217b3-89d1-ea11-bbaa-000d3a2b9185 + companyName: Trey Researches + salesOrderRefs: [] + issueDate: '2019-01-15T00:00:00' + dueDate: '2019-01-15T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-17T16:29:00Z' + paidOnDate: '2019-01-15T00:00:00' + currency: GBP + lineItems: + - description: AMSTERDAM Lamp + unitAmount: 35.6 + quantity: 3 + discountAmount: 0 + subTotal: 106.8 + taxAmount: 21.36 + totalAmount: 128.16 + accountRef: + id: 181217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 'Income, Product Sales' + discountPercentage: 0 + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-d41217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'AMSTERDAM Lamp / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: e0299ced-89d1-ea11-bbaa-000d3a2b9185 + note: Invoice 102001 + reference: 'Document No: 103001' + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + currency: GBP + currencyRate: 1 + paidOnDate: '2019-01-15T00:00:00' + totalAmount: 128.16 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-01-15T00:00:00' + totalAmount: -128.16 + withholdingTax: [] + totalDiscount: 0 + subTotal: 106.8 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 21.36 + totalAmount: 128.16 + amountDue: 0 + discountPercentage: 0 + status: Paid + note: '' + metadata: + isDeleted: false + - id: 31e97827-bb18-ed11-90eb-000d3a8747a0 + invoiceNumber: '102287' + customerRef: + id: 0ef95175-48c4-eb11-9f0a-0022481b4343 + companyName: '' + salesOrderRefs: [] + issueDate: '2019-01-15T00:00:00' + dueDate: '2019-01-15T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-08-10T14:46:08Z' + currency: USD + lineItems: [] + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 0 + amountDue: 0 + discountPercentage: 0 + status: Draft + note: '' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 368 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/invoices?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/invoices + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/invoices?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 91dccc63-b1af-4363-bee0-2aec6bab1bef + invoiceNumber: '19700002' + customerRef: + id: c3bf08a3-4d51-4859-acbb-5075f9484f87 + companyName: Mr Abe + salesOrderRefs: [] + issueDate: '2019-11-08T00:00:00Z' + dueDate: '2019-11-29T00:00:00Z' + modifiedDate: '2022-10-26T13:57:52Z' + sourceModifiedDate: '2019-11-08T11:56:22Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Consultancy per uur - Consultancy per uur + unitAmount: 75 + quantity: 8 + discountAmount: 0 + subTotal: 600 + taxAmount: 0 + totalAmount: 600 + accountRef: + id: 2421e8a0-5355-4ec0-af11-021fe4f39fcd + name: Omzet binnenland hoog tarief + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 600 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 600 + amountDue: 599 + discountPercentage: 0 + status: PartiallyPaid + - id: 0078bc15-10a4-433d-86fa-b1bb235fc0ab + invoiceNumber: '19700004' + customerRef: + id: 46951dc4-a170-42ce-bb38-9a80b776404f + companyName: Cust 03 + salesOrderRefs: [] + issueDate: '2019-11-13T00:00:00Z' + dueDate: '2019-12-04T00:00:00Z' + modifiedDate: '2022-10-26T13:57:52Z' + sourceModifiedDate: '2019-11-13T11:47:51Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Standaard artikel - Standaard artikel + unitAmount: 25 + quantity: 1 + discountAmount: 0 + subTotal: 25 + taxAmount: 5.25 + totalAmount: 30.25 + accountRef: + id: 2421e8a0-5355-4ec0-af11-021fe4f39fcd + name: Omzet binnenland hoog tarief + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 25 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 5.25 + totalAmount: 30.25 + amountDue: 30.25 + discountPercentage: 0 + status: Submitted + pageNumber: 1 + pageSize: 2 + totalResults: 5844 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/invoices?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/invoices + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/invoices?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: a05d1256-f253-46bd-aa13-c6f6a992aa47 + invoiceNumber: '17700002' + customerRef: + id: 570321bb-8b0c-49f1-a1f5-6fb1d6d94a62 + companyName: Some customer + salesOrderRefs: [] + issueDate: '2017-08-02T00:00:00Z' + dueDate: '2017-09-01T00:00:00Z' + modifiedDate: '2022-10-26T13:39:08Z' + sourceModifiedDate: '2017-08-02T18:23:43Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: A bunch of stuff - A bunch of stuff + unitAmount: 100 + quantity: 1000 + discountAmount: 0 + subTotal: 100000 + taxAmount: 0 + totalAmount: 100000 + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 100000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 100000 + amountDue: 0 + discountPercentage: 0 + status: Paid + - id: 0981b5d1-a817-40be-a101-4848f7b1a258 + invoiceNumber: '17700004' + customerRef: + id: 570321bb-8b0c-49f1-a1f5-6fb1d6d94a62 + companyName: Some customer + salesOrderRefs: [] + issueDate: '2017-08-03T00:00:00Z' + dueDate: '2017-09-02T00:00:00Z' + modifiedDate: '2022-10-26T13:39:08Z' + sourceModifiedDate: '2017-08-03T12:22:27Z' + paidOnDate: '2017-08-03T00:00:00Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: A bunch of stuff - A bunch of stuff + unitAmount: 100 + quantity: 150 + discountAmount: 0 + subTotal: 15000 + taxAmount: 0 + totalAmount: 15000 + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 15000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 15000 + amountDue: 0 + discountPercentage: 0 + status: Paid + pageNumber: 1 + pageSize: 2 + totalResults: 4214 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/invoices?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/invoices + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/invoices?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '50541736' + invoiceNumber: '2348' + customerRef: + id: '10123537' + companyName: _Test 1 + salesOrderRefs: [] + issueDate: '2016-12-30T00:00:00' + dueDate: '2016-12-30T00:00:00' + modifiedDate: '2023-04-25T14:19:19Z' + sourceModifiedDate: '2022-10-20T14:28:00Z' + paidOnDate: '2020-11-05T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 3.0 items with VatPercentage of 0.0 + unitAmount: 25.26 + quantity: 1 + discountAmount: 0 + subTotal: 25.26 + taxAmount: 0 + totalAmount: 25.26 + accountRef: + id: '001' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + - description: 3 service charges with 0.0% vat + unitAmount: 8.85 + quantity: 1 + discountAmount: 0 + subTotal: 8.85 + taxAmount: 0 + totalAmount: 8.85 + accountRef: + id: '001' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + - description: Tax + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '262466203' + note: E2E Test transaction 2 CREDIT �250.00 - Invoice receipt against 2348 + currency: GBP + paidOnDate: '2020-11-05T00:00:00' + totalAmount: 250 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.11 + withholdingTax: [] + subTotal: 34.11 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 34.11 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + - id: '21974783' + invoiceNumber: '023' + customerRef: + id: '6162023' + companyName: Alderley plc + salesOrderRefs: [] + issueDate: '2017-01-09T00:00:00' + dueDate: '2017-02-08T00:00:00' + modifiedDate: '2023-04-25T14:19:19Z' + sourceModifiedDate: '2023-02-06T15:31:38Z' + paidOnDate: '2023-02-06T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Laptop + unitAmount: 500 + quantity: 22 + discountAmount: 0 + subTotal: 11000 + taxAmount: 0 + totalAmount: 11000 + accountRef: + id: '001' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + - description: Tax + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '154350605' + note: Test Push Transaction OTHER �123.46 - Invoice receipt against 023 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2018-08-26T00:00:00' + totalAmount: 123.46 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -2 + - payment: + id: '154350605' + note: Test Push Transaction OTHER �123.46 - Invoice receipt against 023 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2018-08-26T00:00:00' + totalAmount: 123.46 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5 + - payment: + id: '214509356' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214338075' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214327399' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214327371' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214672049' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-22T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214671769' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-22T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214671495' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-22T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214671482' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-22T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '214671308' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-22T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216167014' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '215687795' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216167064' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-12-02T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256992092' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256991833' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256991177' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256987893' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256987069' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256983353' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256982947' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256955690' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '256953648' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216464177' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216453277' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216453273' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216168092' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '216168080' + note: �0.01 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2019-11-18T00:00:00' + totalAmount: 0.01 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '260537850' + note: E2E Test transaction 19 DEBIT �250.00 - E2 E Test Transaction 19 - E2 E Test Transaction 19 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2020-10-23T00:00:00' + totalAmount: 235 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -225 + - payment: + id: '413909805' + note: �1.00 - Invoice receipt against 023 + currency: GBP + paidOnDate: '2023-02-06T00:00:00' + totalAmount: 1 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1 + withholdingTax: [] + subTotal: 11000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 11000 + amountDue: 10766.74 + status: PartiallyPaid + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1449 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/invoices?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/invoices + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/invoices?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '2596455' + invoiceNumber: test-AL + customerRef: + id: '602174' + companyName: ab1 + salesOrderRefs: [] + issueDate: '1987-10-01T00:00:00' + dueDate: '1987-10-01T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2023-03-03T09:27:42' + paidOnDate: '2023-03-03T00:00:00' + currency: USD + lineItems: + - description: Editing creative writing for a client + unitAmount: 222.88 + quantity: 1 + discountAmount: 0 + subTotal: 222.88 + taxAmount: 0 + totalAmount: 222.88 + itemRef: + id: '639579' + name: Creative Writing Editorial + trackingCategoryRefs: [] + isDirectIncome: false + - description: '' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '2570292' + note: '' + currency: USD + paidOnDate: '2023-03-03T00:00:00' + totalAmount: 0.17 + allocation: + currency: USD + currencyRate: 1 + totalAmount: -0.17 + withholdingTax: [] + totalDiscount: 0 + subTotal: 222.88 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 222.88 + amountDue: 222.71 + status: Submitted + note: '' + metadata: + isDeleted: false + - id: '2396753' + invoiceNumber: '0000062' + customerRef: + id: '512927' + companyName: Wood Turnerss + salesOrderRefs: [] + issueDate: '2016-04-04T00:00:00' + dueDate: '2016-04-04T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2021-02-24T07:34:31' + currency: GBP + lineItems: [] + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 0 + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 0 + amountDue: 0 + status: Submitted + note: '' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 172 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/invoices?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/invoices + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/invoices?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '143008521' + invoiceNumber: '40' + customerRef: + id: '86832299' + companyName: Mr French Person + salesOrderRefs: [] + issueDate: '2005-12-15T00:00:00' + dueDate: '2006-01-12T00:00:00' + modifiedDate: '2022-09-30T10:29:15Z' + currency: EUR + currencyRate: 0.844737287 + lineItems: + - unitAmount: 0 + quantity: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: '0' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 0 + amountDue: 0 + status: Paid + - id: '143008597' + invoiceNumber: '41' + customerRef: + id: '86832299' + companyName: Mr French Person + salesOrderRefs: [] + issueDate: '2010-01-01T00:00:00' + dueDate: '2010-01-29T00:00:00' + modifiedDate: '2022-09-30T10:29:15Z' + paidOnDate: '2020-11-03T00:00:00' + currency: EUR + currencyRate: 0.844737287 + lineItems: + - unitAmount: 0 + quantity: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: '0' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '146438947' + note: '' + currency: EUR + paidOnDate: '2020-11-03T00:00:00' + totalAmount: 0 + allocation: + currency: EUR + currencyRate: 1 + totalAmount: 0 + withholdingTax: [] + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 0 + amountDue: 0 + status: Paid + pageNumber: 1 + pageSize: 2 + totalResults: 37 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/invoices?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/invoices + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/invoices?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '416' + invoiceNumber: INV01 + customerRef: + id: '417' + companyName: 10 Breww Ltd + salesOrderRefs: [] + issueDate: '2021-04-09T00:00:00' + dueDate: '2021-04-30T00:00:00' + modifiedDate: '2022-09-20T08:16:10Z' + sourceModifiedDate: '2021-08-25T15:55:36' + paidOnDate: '2021-04-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Non-Recurring Services - EC + unitAmount: 100 + quantity: 1 + subTotal: 100 + totalAmount: 100 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: location-1 + isDirectIncome: false + paymentAllocations: + - payment: + id: '428' + reference: 'Payment #PYMT01' + accountRef: + id: '122' + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2021-04-20T00:00:00' + totalAmount: 90 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '428' + reference: 'Payment #PYMT01' + accountRef: + id: '122' + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2021-04-20T00:00:00' + totalAmount: 90 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -90 + withholdingTax: [] + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 100 + amountDue: 0 + status: Paid + - id: '8529' + invoiceNumber: INV63 + customerRef: + id: '417' + companyName: 10 Breww Ltd + salesOrderRefs: [] + issueDate: '2021-04-09T00:00:00' + dueDate: '2021-04-30T00:00:00' + modifiedDate: '2022-09-20T08:16:10Z' + sourceModifiedDate: '2022-02-24T13:51:58' + paidOnDate: '2022-09-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Andy Test Item + unitAmount: 2 + quantity: 3 + subTotal: 6 + totalAmount: 6 + accountRef: + id: '54' + name: Sales + itemRef: + id: '143' + name: Andy Test Item + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + - description: Non-Recurring Services - EC + unitAmount: 4 + quantity: 5 + subTotal: 20 + totalAmount: 20 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: classification-2 + - id: department-1 + - id: location-1 + isDirectIncome: false + paymentAllocations: + - payment: + id: '17588' + note: Payment Example - Invoice allocation + reference: 'Payment #PYMT90' + accountRef: + id: '1' + name: Cheque Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-06-01T00:00:00' + totalAmount: 10 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '17589' + note: Example - Payment of an invoice + reference: 'Payment #PYMT91' + accountRef: + id: '1' + name: Cheque Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-06-01T00:00:00' + totalAmount: 20 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '24558' + note: Test Push Payments - 1 test + reference: 'Payment #PYMT109' + accountRef: + id: '1' + name: Cheque Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-09-12T00:00:00' + totalAmount: 0.1 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.1 + - payment: + id: '24659' + note: Test Push Payments - 1 test + reference: 'Payment #PYMT111' + accountRef: + id: '1' + name: Cheque Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-09-12T00:00:00' + totalAmount: 0.1 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.1 + withholdingTax: [] + totalDiscount: 0 + subTotal: 26 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 26 + amountDue: 5.8 + status: PartiallyPaid + pageNumber: 1 + pageSize: 2 + totalResults: 107 + _links: + current: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/invoices?page=1&pageSize=2 + self: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/invoices + next: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/invoices?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 2453-1071526256 + invoiceNumber: '975' + customerRef: + id: 420000-1071522044 + companyName: 'Prentice, Adelaide' + salesOrderRefs: [] + issueDate: '2022-11-28T00:00:00' + dueDate: '2023-12-28T00:00:00' + modifiedDate: '2023-04-26T09:08:12Z' + sourceModifiedDate: '2023-12-16T05:06:11' + paidOnDate: '2023-01-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Foundation slab - prep and pouring + unitAmount: 167.5 + quantity: 1 + subTotal: 167.5 + taxAmount: 0 + totalAmount: 167.5 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 320000-1071525597 + name: Concrete Slab + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - unitAmount: 0 + quantity: 1 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Rough lumber + unitAmount: 48 + quantity: 1 + subTotal: 48 + taxAmount: 0 + totalAmount: 48 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1C0000-933272656 + name: 'Lumber:Rough' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Trim lumber + unitAmount: 38 + quantity: 1 + subTotal: 38 + taxAmount: 0 + totalAmount: 38 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1D0000-933272656 + name: 'Lumber:Trim' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Window + unitAmount: 25 + quantity: 2 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Flooring + unitAmount: 50 + quantity: 1 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 310000-1071509547 + name: Flooring + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Window + unitAmount: 30 + quantity: 2 + subTotal: 60 + taxAmount: 0 + totalAmount: 60 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + paymentAllocations: + - payment: + id: 6973-1197775625 + note: Check - 80000-933270541 + reference: '983409' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-15T00:00:00' + totalAmount: 431.95 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -431.95 + withholdingTax: [] + totalDiscount: 0 + subTotal: 413.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 18.45 + totalAmount: 431.95 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + - id: '469E-1071530054' + invoiceNumber: '978' + customerRef: + id: 220000-933272658 + companyName: 'Melton, Johnny' + salesOrderRefs: [] + issueDate: '2022-11-30T00:00:00' + dueDate: '2023-12-30T00:00:00' + modifiedDate: '2023-04-26T09:08:12Z' + sourceModifiedDate: '2023-12-16T05:06:09' + paidOnDate: '2023-01-10T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: See attached specification for details on work below. + unitAmount: 0 + quantity: 1 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - unitAmount: 0 + quantity: 1 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Installation labor + unitAmount: 45.5 + quantity: 1 + subTotal: 45.5 + taxAmount: 0 + totalAmount: 45.5 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 20000-933272655 + name: Installation + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Install drywall + unitAmount: 1320 + quantity: 1 + subTotal: 1320 + taxAmount: 0 + totalAmount: 1320 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 70000-933272656 + name: 'Subs:Drywall' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Electrical work + unitAmount: 1650 + quantity: 1 + subTotal: 1650 + taxAmount: 0 + totalAmount: 1650 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 80000-933272656 + name: 'Subs:Electrical' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Metal Work + unitAmount: 660 + quantity: 1 + subTotal: 660 + taxAmount: 0 + totalAmount: 660 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: A0000-933272656 + name: 'Subs:Metal Wrk' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Install insulation + unitAmount: 1100 + quantity: 1 + subTotal: 1100 + taxAmount: 0 + totalAmount: 1100 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 90000-933272656 + name: 'Subs:Insulating' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Plumbing + unitAmount: 1650 + quantity: 1 + subTotal: 1650 + taxAmount: 0 + totalAmount: 1650 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: C0000-933272656 + name: 'Subs:Plumbing' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Painting + unitAmount: 2420 + quantity: 1 + subTotal: 2420 + taxAmount: 0 + totalAmount: 2420 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: B0000-933272656 + name: 'Subs:Painting' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Install carpeting + unitAmount: 3300 + quantity: 1 + subTotal: 3300 + taxAmount: 0 + totalAmount: 3300 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 60000-933272656 + name: 'Subs:Carpet' + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Custom Bay Window + unitAmount: 1925 + quantity: 1 + subTotal: 1925 + taxAmount: 0 + totalAmount: 1925 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Window + unitAmount: 115.5 + quantity: 1 + subTotal: 115.5 + taxAmount: 0 + totalAmount: 115.5 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: Equipment Rental + unitAmount: 700 + quantity: 1 + subTotal: 700 + taxAmount: 0 + totalAmount: 700 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 230000-933272656 + name: Equip Rental + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + - description: 10% retainage to be billed after job is complete and approved. + unitAmount: -555.5 + quantity: 1 + subTotal: -555.5 + taxAmount: 0 + totalAmount: -555.5 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 260000-933272656 + name: Retainage 1 + trackingCategoryRefs: + - id: 40000-933272658 + name: Remodel + isDirectIncome: false + paymentAllocations: + - payment: + id: 6915-1197775450 + note: Check - 80000-933270541 + reference: '19650' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-10T00:00:00' + totalAmount: 14488.64 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -14488.64 + withholdingTax: [] + totalDiscount: 0 + subTotal: 14330.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 158.14 + totalAmount: 14488.64 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 113 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/invoices?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/invoices + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/invoices?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '16' + invoiceNumber: '1001' + customerRef: + id: '3' + companyName: Information Sharing Technology + salesOrderRefs: [] + issueDate: '2019-02-18T00:00:00' + dueDate: '2019-03-20T00:00:00' + modifiedDate: '2023-01-18T11:03:02Z' + sourceModifiedDate: '2022-09-20T10:12:08Z' + paidOnDate: '2020-06-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Service + unitAmount: 500 + quantity: 10 + subTotal: 5000 + taxAmount: 0 + totalAmount: 5000 + accountRef: + id: '1' + name: Sales + itemRef: + id: '1' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '500' + note: Payments of type PrepaidPayment + reference: '498254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 37.77 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -37.77 + - payment: + id: '507' + note: Payments of type PrepaidPayment + reference: '505288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 62.82 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -54.62 + - payment: + id: '499' + note: Payments of type Cash + reference: '498147' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 1017 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5.08 + - payment: + id: '491' + note: Payments of type PrepaidPayment + reference: '489239' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-18T00:00:00' + totalAmount: 48.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -48.74 + - payment: + id: '490' + note: Payments of type Cash + reference: '489120' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-18T00:00:00' + totalAmount: 1112.76 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.74 + - payment: + id: '482' + note: Payments of type PrepaidPayment + reference: '480242' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-17T00:00:00' + totalAmount: 33.9 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.9 + - payment: + id: '481' + note: Payments of type Cash + reference: '480129' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-17T00:00:00' + totalAmount: 965.85 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.21 + - payment: + id: '470' + note: Payments of type PrepaidPayment + reference: '468248' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 67.83 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -41.38 + - payment: + id: '463' + note: Payments of type PrepaidPayment + reference: '461243' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 7.47 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.47 + - payment: + id: '462' + note: Payments of type Cash + reference: '461144' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 914.05 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.76 + - payment: + id: '456' + note: Payments of type PrepaidPayment + reference: '454252' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 70.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.72 + - payment: + id: '447' + note: Payments of type PrepaidPayment + reference: '445278' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 24.95 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -24.95 + - payment: + id: '446' + note: Payments of type Cash + reference: '44518' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 904.82 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.96 + - payment: + id: '438' + note: Payments of type PrepaidPayment + reference: '436234' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-10T00:00:00' + totalAmount: 6.03 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.03 + - payment: + id: '437' + note: Payments of type Cash + reference: '436168' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-10T00:00:00' + totalAmount: 760.05 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -31.48 + - payment: + id: '647' + note: Payments of type PrepaidPayment + reference: '645263' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-03-20T00:00:00' + totalAmount: 40.43 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '429' + note: Payments of type PrepaidPayment + reference: '427270' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-09T00:00:00' + totalAmount: 56.75 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -28.75 + - payment: + id: '420' + note: Payments of type PrepaidPayment + reference: '418258' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-08T00:00:00' + totalAmount: 8.92 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.92 + - payment: + id: '419' + note: Payments of type Cash + reference: '418157' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-08T00:00:00' + totalAmount: 407.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -2.55 + - payment: + id: '705' + note: Payments of type PrepaidPayment + reference: '703246' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-03T00:00:00' + totalAmount: 25 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25 + - payment: + id: '411' + note: Payments of type PrepaidPayment + reference: '409292' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-07T00:00:00' + totalAmount: 6.22 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.22 + - payment: + id: '410' + note: Payments of type Cash + reference: '409145' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-07T00:00:00' + totalAmount: 725.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.79 + - payment: + id: '772' + note: Payments of type PrepaidPayment + reference: '770263' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-24T00:00:00' + totalAmount: 10.35 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '779' + note: Payments of type PrepaidPayment + reference: '777217' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-24T00:00:00' + totalAmount: 39.55 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '792' + note: Payments of type PrepaidPayment + reference: '790262' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-29T00:00:00' + totalAmount: 12.46 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '402' + note: Payments of type PrepaidPayment + reference: '400275' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-06T00:00:00' + totalAmount: 32.88 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -29.29 + - payment: + id: '393' + note: Payments of type PrepaidPayment + reference: '391247' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 16.73 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.73 + - payment: + id: '392' + note: Payments of type Cash + reference: '391115' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 1094.8 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -47.35 + - payment: + id: '386' + note: Payments of type PrepaidPayment + reference: '384213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-04T00:00:00' + totalAmount: 9.99 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -9.99 + - payment: + id: '385' + note: Payments of type Cash + reference: '38418' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-04T00:00:00' + totalAmount: 858.41 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.4 + - payment: + id: '377' + note: Payments of type PrepaidPayment + reference: '375298' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-03T00:00:00' + totalAmount: 39.06 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -39.06 + - payment: + id: '376' + note: Payments of type Cash + reference: '375123' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-03T00:00:00' + totalAmount: 802.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.54 + - payment: + id: '368' + note: Payments of type PrepaidPayment + reference: '366288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-02T00:00:00' + totalAmount: 12.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -12.15 + - payment: + id: '367' + note: Payments of type Cash + reference: '366195' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-02T00:00:00' + totalAmount: 827.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25.4 + - payment: + id: '361' + note: Payments of type PrepaidPayment + reference: '359220' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-01T00:00:00' + totalAmount: 54.12 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -40.61 + - payment: + id: '349' + note: Payments of type PrepaidPayment + reference: '347216' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-31T00:00:00' + totalAmount: 25.32 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25.32 + - payment: + id: '348' + note: Payments of type Cash + reference: '34710' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-31T00:00:00' + totalAmount: 949.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.07 + - payment: + id: '342' + note: Payments of type PrepaidPayment + reference: '340292' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 26.59 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -26.59 + - payment: + id: '341' + note: Payments of type Cash + reference: '340128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 859.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -29.21 + - payment: + id: '333' + note: Payments of type PrepaidPayment + reference: '331236' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 17.94 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.58 + - payment: + id: '322' + note: Payments of type PrepaidPayment + reference: '320256' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 14.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -14.33 + - payment: + id: '321' + note: Payments of type Cash + reference: '320186' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 798.79 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.08 + - payment: + id: '313' + note: Payments of type PrepaidPayment + reference: '311211' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 45.06 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -41.47 + - payment: + id: '304' + note: Payments of type PrepaidPayment + reference: '302284' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-28T00:00:00' + totalAmount: 17.04 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.04 + - payment: + id: '303' + note: Payments of type Cash + reference: '302128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-28T00:00:00' + totalAmount: 837.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.66 + - payment: + id: '297' + note: Payments of type PrepaidPayment + reference: '295264' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-27T00:00:00' + totalAmount: 14.92 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -14.92 + - payment: + id: '296' + note: Payments of type Cash + reference: '295176' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-27T00:00:00' + totalAmount: 687.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4.18 + - payment: + id: '288' + note: Payments of type PrepaidPayment + reference: '286250' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-26T00:00:00' + totalAmount: 12.73 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -12.73 + - payment: + id: '287' + note: Payments of type Cash + reference: '286188' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-26T00:00:00' + totalAmount: 539.55 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.97 + - payment: + id: '279' + note: Payments of type PrepaidPayment + reference: '277281' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-25T00:00:00' + totalAmount: 30.58 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -30.58 + - payment: + id: '278' + note: Payments of type Cash + reference: '277153' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-25T00:00:00' + totalAmount: 1063.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -37.08 + - payment: + id: '270' + note: Payments of type PrepaidPayment + reference: '268269' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 11.69 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.69 + - payment: + id: '269' + note: Payments of type Cash + reference: '268154' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 968.21 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -48.58 + - payment: + id: '263' + note: Payments of type PrepaidPayment + reference: '261215' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 7.24 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.24 + - payment: + id: '262' + note: Payments of type Cash + reference: '261162' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 425.69 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.02 + - payment: + id: '256' + note: Payments of type PrepaidPayment + reference: '254258' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 37.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.6 + - payment: + id: '249' + note: Payments of type PrepaidPayment + reference: '247245' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 22.03 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.84 + - payment: + id: '240' + note: Payments of type PrepaidPayment + reference: '238213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 47.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -31.98 + - payment: + id: '231' + note: Payments of type Prepaid + reference: '229276' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 38.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -30.52 + - payment: + id: '218' + note: Payments of type Prepaid + reference: '216237' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-22T00:00:00' + totalAmount: 19.67 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -19.67 + - payment: + id: '217' + note: Payments of type Cash + reference: '216161' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-22T00:00:00' + totalAmount: 565.24 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1.66 + - payment: + id: '209' + note: Payments of type Prepaid + reference: '207254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-21T00:00:00' + totalAmount: 27.62 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.62 + - payment: + id: '208' + note: Payments of type Cash + reference: '207189' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-21T00:00:00' + totalAmount: 914.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.86 + - payment: + id: '200' + note: Payments of type Prepaid + reference: '198234' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 18.35 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.35 + - payment: + id: '199' + note: Payments of type Cash + reference: '198128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 1209.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -20.22 + - payment: + id: '191' + note: Payments of type Prepaid + reference: '18922' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 16.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.44 + - payment: + id: '190' + note: Payments of type Cash + reference: '189174' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 607.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.34 + - payment: + id: '182' + note: Payments of type Prepaid + reference: '180274' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 47.91 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -47.91 + - payment: + id: '181' + note: Payments of type Cash + reference: '180197' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 1087.13 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.04 + - payment: + id: '173' + note: Payments of type Prepaid + reference: '171213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 35.36 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -26.29 + - payment: + id: '166' + note: Payments of type Prepaid + reference: '164260' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 39.98 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -39.98 + - payment: + id: '165' + note: Payments of type Cash + reference: '164142' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 913.09 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.99 + - payment: + id: '157' + note: Payments of type Prepaid + reference: '155266' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 14.32 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4.87 + - payment: + id: '150' + note: Payments of type Prepaid + reference: '148217' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 11.57 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.57 + - payment: + id: '149' + note: Payments of type Cash + reference: '148151' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 643.97 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -22.26 + - payment: + id: '141' + note: Payments of type Prepaid + reference: '139288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 27.88 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.88 + - payment: + id: '140' + note: Payments of type Cash + reference: '139163' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 1078.72 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.71 + - payment: + id: '132' + note: Payments of type Prepaid + reference: '13022' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 47.38 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -42.36 + - payment: + id: '123' + note: Payments of type Prepaid + reference: '121293' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 34.45 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.45 + - payment: + id: '122' + note: Payments of type Cash + reference: '121197' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 771.61 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.31 + - payment: + id: '116' + note: Payments of type Prepaid + reference: '114213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 65.77 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -23.86 + - payment: + id: '521' + note: Payments of type PrepaidPayment + reference: '519243' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 14.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '843' + note: Payments of type PrepaidPayment + reference: '841264' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-07T00:00:00' + totalAmount: 25.64 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '850' + note: Payments of type PrepaidPayment + reference: '848254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-14T00:00:00' + totalAmount: 53.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '877' + note: Payments of type PrepaidPayment + reference: '875210' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-06-01T00:00:00' + totalAmount: 12.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + withholdingTax: [] + totalDiscount: 0 + subTotal: 5000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 5000 + amountDue: 3296.44 + status: PartiallyPaid + note: Invoice for service + - id: '17' + invoiceNumber: '1002' + customerRef: + id: '2' + companyName: Software Coperation + salesOrderRefs: [] + issueDate: '2019-02-18T00:00:00' + dueDate: '2019-03-20T00:00:00' + modifiedDate: '2023-01-18T11:03:02Z' + sourceModifiedDate: '2019-02-21T17:51:49Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: IT Support + unitAmount: 80 + quantity: 40 + subTotal: 3200 + taxAmount: 0 + totalAmount: 3200 + accountRef: + id: '1' + name: Sales + itemRef: + id: '2' + name: Hours + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 0 + subTotal: 3200 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 3200 + amountDue: 3200 + status: Submitted + pageNumber: 1 + pageSize: 2 + totalResults: 1326 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/invoices?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/invoices + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/invoices?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '30' + invoiceNumber: '1002' + customerRef: + id: '59' + companyName: Ecker Holiday event + salesOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-02-05T00:00:00' + modifiedDate: '2023-04-26T09:36:12Z' + sourceModifiedDate: '2023-01-25T13:49:52Z' + paidOnDate: '2016-02-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Holiday party - gold level test v1 + unitAmount: 2000 + quantity: 1 + subTotal: 2000 + taxAmount: 400 + totalAmount: 2400 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '7' + name: Gold party + trackingCategoryRefs: [] + isDirectIncome: false + - description: Venue rental + unitAmount: 10000 + quantity: 1 + subTotal: 10000 + taxAmount: 2000 + totalAmount: 12000 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '20' + name: Venue Rental + trackingCategoryRefs: [] + isDirectIncome: false + - description: promotional items -- misc engraved items + unitAmount: 13.5 + quantity: 75 + subTotal: 1012.5 + taxAmount: 202.5 + totalAmount: 1215 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '12' + name: Misc + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '31' + note: '' + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2016-02-12T00:00:00' + totalAmount: 15615 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15615 + withholdingTax: [] + totalDiscount: 0 + subTotal: 13012.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 2602.5 + totalAmount: 15615 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + - id: '3793' + invoiceNumber: 276e29c1 + customerRef: + id: '59' + companyName: Ecker Holiday event + salesOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-02-05T00:00:00' + modifiedDate: '2023-04-26T09:36:12Z' + sourceModifiedDate: '2022-08-22T13:04:50Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Holiday party - gold level test v1 + unitAmount: 2000 + quantity: 1 + subTotal: 2000 + taxAmount: 400 + totalAmount: 2400 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '7' + name: Gold party + trackingCategoryRefs: [] + isDirectIncome: false + - description: Venue rental + unitAmount: 10000 + quantity: 1 + subTotal: 10000 + taxAmount: 2000 + totalAmount: 12000 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '20' + name: Venue Rental + trackingCategoryRefs: [] + isDirectIncome: false + - description: promotional items -- misc engraved items + unitAmount: 13.5 + quantity: 75 + subTotal: 1012.5 + taxAmount: 202.5 + totalAmount: 1215 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '12' + name: Misc + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 0 + subTotal: 13012.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 2602.5 + totalAmount: 15615 + amountDue: 15615 + status: Submitted + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1077 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/invoices?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/invoices + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/invoices?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '82322' + invoiceNumber: '0000000110' + customerRef: + id: A1D001 + companyName: A1 Design Services + salesOrderRefs: [] + issueDate: '2020-07-13T00:00:00Z' + dueDate: '2020-08-12T00:00:00Z' + modifiedDate: '2022-10-14T09:36:12Z' + sourceModifiedDate: '2020-07-13T11:06:40Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Standard rate + unitAmount: 0 + quantity: 0 + discountAmount: 0.22 + subTotal: 0 + taxAmount: 8.67 + totalAmount: 8.67 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 1.08 + subTotal: 43.34 + taxAmount: 0 + totalAmount: 43.34 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 1.3 + subTotal: 43.34 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 8.67 + totalAmount: 52.01 + amountDue: 52.01 + discountPercentage: 2.49 + status: Submitted + note: '0000000114' + - id: '83515' + invoiceNumber: '0000000111' + customerRef: + id: BRO001 + companyName: Bronson Inc + salesOrderRefs: [] + issueDate: '2020-07-15T00:00:00Z' + dueDate: '2020-08-29T00:00:00Z' + modifiedDate: '2022-10-14T09:36:12Z' + sourceModifiedDate: '2020-07-15T10:45:56Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Zero rated + unitAmount: 0 + quantity: 0 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + taxRateRef: + id: '1728' + name: Zero rated + effectiveTaxRate: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 3.13 + subTotal: 125 + taxAmount: 0 + totalAmount: 125 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 3.13 + subTotal: 125 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 125 + amountDue: 125 + discountPercentage: 2.5 + status: Submitted + note: '0000000111' + pageNumber: 1 + pageSize: 2 + totalResults: 409 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/invoices?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/invoices + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/invoices?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: INV-1 + invoiceNumber: '1' + customerRef: + id: A1D001 + companyName: A1 Design Services + salesOrderRefs: [] + issueDate: '2021-01-02T00:00:00' + modifiedDate: '2023-03-30T14:42:42Z' + sourceModifiedDate: '2022-11-25T09:43:54' + paidOnDate: '2022-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: AT Mini Tower Case + unitAmount: 14.25 + quantity: 1 + discountAmount: 0 + subTotal: 14.25 + taxAmount: 2.43 + totalAmount: 16.68 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Whiteboard - Drywipe (900 x 1200) + unitAmount: 19 + quantity: 4 + discountAmount: 0 + subTotal: 76 + taxAmount: 12.97 + totalAmount: 88.97 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: A4 Ledger Book - 5 Column + unitAmount: 7.59 + quantity: 8 + discountAmount: 0 + subTotal: 60.72 + taxAmount: 10.36 + totalAmount: 71.08 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Shorthand Notebook - 80 Sheets + unitAmount: 4.27 + quantity: 20 + discountAmount: 0 + subTotal: 85.4 + taxAmount: 14.57 + totalAmount: 99.97 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Desktop + unitAmount: 9.5 + quantity: 1 + discountAmount: 0 + subTotal: 9.5 + taxAmount: 1.62 + totalAmount: 11.12 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Desktop (Printing) + unitAmount: 16.15 + quantity: 1 + discountAmount: 0 + subTotal: 16.15 + taxAmount: 2.76 + totalAmount: 18.91 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Printing Rolls + unitAmount: 5.7 + quantity: 15 + discountAmount: 0 + subTotal: 85.5 + taxAmount: 14.59 + totalAmount: 100.09 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Correction Fluid - White + unitAmount: 2.37 + quantity: 7 + discountAmount: 0 + subTotal: 16.59 + taxAmount: 2.83 + totalAmount: 19.42 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Envelope - White (110 x 220) Plain + unitAmount: 8.54 + quantity: 20 + discountAmount: 0 + subTotal: 170.8 + taxAmount: 29.14 + totalAmount: 199.94 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Flip Chart - A1 Pad + unitAmount: 15.2 + quantity: 10 + discountAmount: 0 + subTotal: 152 + taxAmount: 25.94 + totalAmount: 177.94 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Laminator Pouches - A4 + unitAmount: 11.4 + quantity: 5 + discountAmount: 0 + subTotal: 57 + taxAmount: 9.73 + totalAmount: 66.73 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Mouse Mat - (241 x 203) Blue + unitAmount: 1.42 + quantity: 5 + discountAmount: 0 + subTotal: 7.1 + taxAmount: 1.21 + totalAmount: 8.31 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Copy Paper - Economy Grade + unitAmount: 2.46 + quantity: 80 + discountAmount: 0 + subTotal: 196.8 + taxAmount: 33.58 + totalAmount: 230.38 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Coloured Paper - Pastel Blue + unitAmount: 3.61 + quantity: 5 + discountAmount: 0 + subTotal: 18.05 + taxAmount: 3.08 + totalAmount: 21.13 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Ball Point Pen - Black + unitAmount: 1.9 + quantity: 8 + discountAmount: 0 + subTotal: 15.2 + taxAmount: 2.59 + totalAmount: 17.79 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Pencil - HB + unitAmount: 2.37 + quantity: 3 + discountAmount: 0 + subTotal: 7.11 + taxAmount: 1.21 + totalAmount: 8.32 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Remember-Me Sticky Notes (Recycled) + unitAmount: 3.32 + quantity: 6 + discountAmount: 0 + subTotal: 19.92 + taxAmount: 3.4 + totalAmount: 23.32 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Scissors - Economy + unitAmount: 2.85 + quantity: 1 + discountAmount: 0 + subTotal: 2.85 + taxAmount: 0.49 + totalAmount: 3.34 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Adhesive Tape - Brown (50mm x 66m) + unitAmount: 2.66 + quantity: 5 + discountAmount: 0 + subTotal: 13.3 + taxAmount: 2.27 + totalAmount: 15.57 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: JP010 Jet Printer Cartridge + unitAmount: 17.1 + quantity: 5 + discountAmount: 0 + subTotal: 85.5 + taxAmount: 14.59 + totalAmount: 100.09 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Letter Trays - 3 pack (Red) + unitAmount: 6.65 + quantity: 2 + discountAmount: 0 + subTotal: 13.3 + taxAmount: 2.27 + totalAmount: 15.57 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -100.09 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -66.73 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -117.5 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -177.94 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -230.38 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.79 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -71.08 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -88.97 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.57 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -3.34 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -199.94 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -100.09 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.68 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.91 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -23.32 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -99.97 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -21.13 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.57 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -19.42 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.31 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.12 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.32 + withholdingTax: [] + totalDiscount: 0 + subTotal: 1223.04 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 209.13 + totalAmount: 1432.17 + amountDue: 0 + status: Paid + note: '' + metadata: + isDeleted: false + - id: INV-9 + invoiceNumber: '9' + customerRef: + id: KIN001 + companyName: Kinghorn & French + salesOrderRefs: [] + issueDate: '2021-01-04T00:00:00' + modifiedDate: '2023-03-30T14:42:42Z' + sourceModifiedDate: '2022-11-25T09:43:54' + paidOnDate: '2022-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: PC Combo Pack 4 + unitAmount: 765 + quantity: 5 + discountAmount: 765 + subTotal: 3060 + taxAmount: 522.11 + totalAmount: 3582.11 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 20 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: PC Combo Pack 5 + unitAmount: 1080 + quantity: 4 + discountAmount: 864 + subTotal: 3456 + taxAmount: 589.68 + totalAmount: 4045.68 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 20 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: PC Combo Pack 6 + unitAmount: 1350 + quantity: 2 + discountAmount: 540 + subTotal: 2160 + taxAmount: 368.55 + totalAmount: 2528.55 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 20 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: FX030 Multifunctional Fax + unitAmount: 414 + quantity: 2 + discountAmount: 165.6 + subTotal: 662.4 + taxAmount: 113.02 + totalAmount: 775.42 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 20 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Copy Paper - Premium Grade + unitAmount: 3.06 + quantity: 100 + discountAmount: 61.2 + subTotal: 244.8 + taxAmount: 41.77 + totalAmount: 286.57 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 20 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '271' + note: Sales receipt 271 linked to sales invoice inv-9. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 11123.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -276.57 + - payment: + id: '271' + note: Sales receipt 271 linked to sales invoice inv-9. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 11123.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -765.42 + - payment: + id: '271' + note: Sales receipt 271 linked to sales invoice inv-9. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 11123.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4035.68 + - payment: + id: '271' + note: Sales receipt 271 linked to sales invoice inv-9. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 11123.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -2518.55 + - payment: + id: '271' + note: Sales receipt 271 linked to sales invoice inv-9. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 11123.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -3527.11 + - payment: + id: '272' + note: Sales discount 272 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '272' + note: Sales discount 272 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '272' + note: Sales discount 272 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '272' + note: Sales discount 272 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '272' + note: Sales discount 272 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + - payment: + id: '9' + note: Sales credit tx-9 linked to sales invoice inv-9. + accountRef: + id: '' + currency: GBP + currencyRate: 1 + paidOnDate: '2021-12-31T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -45 + withholdingTax: [] + totalDiscount: 2395.8 + subTotal: 9583.2 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 1635.13 + totalAmount: 11218.33 + amountDue: 0 + status: Paid + note: '' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 86 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/invoices?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/invoices + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/invoices?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: b039b0a733de11e797950a57719b2edb + invoiceNumber: SI-1 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + salesOrderRefs: [] + issueDate: '2017-05-08T00:00:00' + dueDate: '2017-06-07T00:00:00' + modifiedDate: '2022-10-24T15:03:37Z' + sourceModifiedDate: '2021-07-23T13:42:59Z' + paidOnDate: '2021-07-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 8 + discountAmount: 0 + subTotal: 7200 + taxAmount: 1440 + totalAmount: 8640 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: e1c2bd659a6111e8bad90617b3da4b8a + note: Sales credit note + currency: GBP + currencyRate: 1 + paidOnDate: '2018-08-07T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1000 + - payment: + id: e1c2bd659a6111e8bad90617b3da4b8a + note: Sales credit note + currency: GBP + currencyRate: 1 + paidOnDate: '2018-08-07T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1000 + - payment: + id: 579388a0215911e8b45c025132dab352 + note: Customer receipt using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-01-02T00:00:00' + totalAmount: 1400 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1400 + - payment: + id: 52237e4e215911e8b45c025132dab352 + note: Customer receipt using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-01-02T00:00:00' + totalAmount: 4000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4000 + withholdingTax: [] + totalDiscount: 0 + subTotal: 7200 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 1440 + totalAmount: 8640 + amountDue: 1240 + status: PartiallyPaid + - id: 6420b3f8209611e8b45c025132dab352 + invoiceNumber: SI-2 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + salesOrderRefs: [] + issueDate: '2018-03-05T00:00:00' + dueDate: '2018-04-04T00:00:00' + modifiedDate: '2022-10-24T15:03:37Z' + sourceModifiedDate: '2018-03-05T16:58:39Z' + paidOnDate: '2018-03-05T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 5 + discountAmount: 0 + subTotal: 4500 + taxAmount: 900 + totalAmount: 5400 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 73a0490d209611e8b45c025132dab352 + note: Customer receipt using cash - PAYMENT-CASH-001 + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-03-05T00:00:00' + totalAmount: 5400 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5400 + withholdingTax: [] + totalDiscount: 0 + subTotal: 4500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 900 + totalAmount: 5400 + amountDue: 0 + status: Paid + pageNumber: 1 + pageSize: 2 + totalResults: 10759 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/invoices?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/invoices + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/invoices?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '2916' + invoiceNumber: IN0480 + customerRef: + id: '12' + companyName: MK Manufacturing + salesOrderRefs: [] + issueDate: '2021-04-22T00:00:00' + dueDate: '2021-05-22T00:00:00' + modifiedDate: '2023-04-04T16:31:54Z' + sourceModifiedDate: '2021-04-22T11:01:11Z' + paidOnDate: '2021-04-22T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 100 + quantity: 1 + subTotal: 100 + taxAmount: 20 + totalAmount: 120 + accountRef: + id: '176' + name: Revenue - Services + taxRateRef: + id: '105' + name: UK Sale Services Standard Rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: CUSTOMER-12 + name: MK Manufacturing + - id: DEPARTMENT-2 + name: Services + - id: LOCATION-11 + name: Codat Test Entity + isDirectIncome: false + paymentAllocations: + - payment: + id: '2918' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2021-04-22T00:00:00' + totalAmount: 120 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -120 + withholdingTax: [] + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 20 + totalAmount: 120 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + - id: '18827' + invoiceNumber: IN1515 + customerRef: + id: '6' + companyName: AG Insurance + salesOrderRefs: [] + issueDate: '2022-09-28T00:00:00' + dueDate: '2022-10-28T00:00:00' + modifiedDate: '2023-04-04T16:31:54Z' + sourceModifiedDate: '2022-10-05T11:02:22Z' + currency: USD + currencyRate: 0.9294 + lineItems: + - description: test desc Test05102022-1 + unitAmount: 180 + quantity: 1 + subTotal: 180 + taxAmount: 0 + totalAmount: 180 + accountRef: + id: '2' + name: Accounts Receivable + taxRateRef: + id: '58' + name: EC Sale Goods Standard Rate + effectiveTaxRate: 0 + trackingCategoryRefs: + - id: CUSTOMER-6 + name: AG Insurance + - id: DEPARTMENT-1 + name: Sales + - id: LOCATION-11 + name: Codat Test Entity + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 0 + subTotal: 180 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 180 + amountDue: 180 + status: Submitted + note: test desc Test05102022-1 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/invoices?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/invoices + Wave: + value: + results: + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0ludm9pY2U6NzgyNDQ4OTg1Nzc1MzE5MTYw + invoiceNumber: '1' + customerRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 + companyName: ABC Textiles + salesOrderRefs: [] + issueDate: '2019-10-17T00:00:00' + dueDate: '2019-10-17T00:00:00' + modifiedDate: '2022-11-16T18:15:23Z' + sourceModifiedDate: '2019-12-05T23:20:36Z' + paidOnDate: '2019-12-05T23:20:36Z' + currency: USD + currencyRate: 0.784736781 + lineItems: + - description: '' + unitAmount: 10 + quantity: 5 + subTotal: 50 + taxAmount: 2.5 + totalAmount: 52.5 + accountRef: + id: QWNjb3VudDo3OTE3NTA2MDA0MjQ0NTExMTU7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Sales + itemRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1Byb2R1Y3Q6MzU2NjcyNTI= + name: Golf balls + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 50 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 2.5 + totalAmount: 52.5 + amountDue: 0 + status: Paid + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0ludm9pY2U6ODgzOTc4MDA2NDIxMzUwODIx + invoiceNumber: '2' + customerRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjM2OTkxOTYw + companyName: NIC Cookies + salesOrderRefs: [] + issueDate: '2020-03-05T00:00:00' + dueDate: '2020-03-05T00:00:00' + modifiedDate: '2022-11-16T18:15:23Z' + sourceModifiedDate: '2020-03-30T14:10:21Z' + paidOnDate: '2020-03-30T14:10:21Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Decorated cookies + unitAmount: 4 + quantity: 50 + subTotal: 200 + taxAmount: 40 + totalAmount: 240 + accountRef: + id: QWNjb3VudDo3OTE3NTA2MDA0MjQ0NTExMTU7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Sales + itemRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1Byb2R1Y3Q6NDEzNzEwOTU= + name: Cookies + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 200 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 40 + totalAmount: 240 + amountDue: 0 + status: Paid + pageNumber: 1 + pageSize: 2 + totalResults: 19 + _links: + current: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/invoices?page=1&pageSize=2 + self: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/invoices + next: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/invoices?page=2&pageSize=2 + Xero: + value: + results: + - id: 321bfed3-2da2-4969-9358-4de97821181b + invoiceNumber: INV-001-0 + customerRef: + id: afd4093b-c655-4847-8ee2-10a4f2c3eae3 + companyName: Maddox Publishing Group + salesOrderRefs: [] + issueDate: '2021-12-20T00:00:00' + dueDate: '2022-01-17T00:00:00' + modifiedDate: '2023-03-15T20:38:11Z' + sourceModifiedDate: '2021-01-02T20:34:51' + paidOnDate: '2022-02-17T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Project management - onsite daily rate - your CRM integration project + unitAmount: 583.3333333333 + quantity: 6 + discountAmount: 0 + subTotal: 3500 + taxAmount: 700 + totalAmount: 4200 + accountRef: + id: a969500a-377c-4cea-8f2b-a4e385607fd0 + name: Other Revenue + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + itemRef: + id: aa1c5f84-4453-42fa-9c92-69d4085607c9 + name: Project management - daily rate + trackingCategoryRefs: + - id: 34b9b859-07a9-451a-b4d3-effc9946634a + name: North + isDirectIncome: false + paymentAllocations: + - payment: + id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-17T00:00:00' + totalAmount: 4200 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4200 + withholdingTax: [] + totalDiscount: 0 + subTotal: 3500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 700 + totalAmount: 4200 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + - id: 4b6d0c8f-10fa-42cd-a6e5-53b175e90005 + invoiceNumber: INV-0001 + customerRef: + id: a871a956-05b5-4e2a-9419-7aeb478ca647 + companyName: Ridgeway University + salesOrderRefs: [] + issueDate: '2022-02-07T00:00:00' + dueDate: '2022-02-17T00:00:00' + modifiedDate: '2023-03-15T20:38:11Z' + sourceModifiedDate: '2021-01-02T22:51:43' + paidOnDate: '2022-02-17T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Retainer for consulting work + unitAmount: 416.67 + quantity: 1 + discountAmount: 0 + subTotal: 416.67 + taxAmount: 83.33 + totalAmount: 500 + accountRef: + id: c563b607-fb0e-4d06-9ddb-76fdeef20ae3 + name: Sales + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 8c481b70-b5d7-4de4-a7f7-9e161be2c472 + reference: '' + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-17T00:00:00' + totalAmount: 500 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -500 + withholdingTax: [] + totalDiscount: 0 + subTotal: 416.67 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 83.33 + totalAmount: 500 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 44 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/invoices?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/invoices + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/invoices?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000038034' + invoiceNumber: INV-102 + customerRef: + id: '104957000000037097' + companyName: Test Company + salesOrderRefs: [] + issueDate: '2020-02-06T10:54:03' + dueDate: '2020-02-17T00:00:00' + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-05-19T15:36:26' + paidOnDate: '2020-05-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + paymentAllocations: + - payment: + id: '104957000000129048' + note: '' + reference: '9' + accountRef: + id: '104957000000000349' + name: Petty Cash + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-29T00:00:00' + totalAmount: 9000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -9000 + - payment: + id: '104957000000137017' + note: '' + reference: '11' + accountRef: + id: '104957000000060010' + name: Abdi Test + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-19T00:00:00' + totalAmount: 9000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1 + withholdingTax: [] + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 9001 + amountDue: 0 + status: Paid + - id: '104957000000038052' + invoiceNumber: INV-104 + customerRef: + id: '104957000000037097' + companyName: Test Company + salesOrderRefs: [] + issueDate: '2020-02-06T10:54:04' + dueDate: '2020-02-17T00:00:00' + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-02-17T14:21:05' + paidOnDate: '2020-02-06T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + paymentAllocations: + - payment: + id: '104957000000070175' + note: Cheque deposit + reference: '4' + accountRef: + id: '104957000000060010' + name: Abdi Test + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-06T00:00:00' + totalAmount: 9001 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -9001 + withholdingTax: [] + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 9001 + amountDue: 0 + status: Paid + pageNumber: 1 + pageSize: 2 + totalResults: 48 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/invoices?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/invoices + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/invoices?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/invoices/{invoiceId}': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingInvoiceId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingInvoice' + examples: + Clear Books: + value: + id: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + invoiceNumber: TKj7oD38 + customerRef: + id: d65ac505-072c-49ec-be3c-3cb74228966d + companyName: Jensen Steuber + salesOrderRefs: [] + issueDate: '2022-04-25T13:04:02' + dueDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2023-01-28T14:41:02' + paidOnDate: '2022-04-25T13:04:02' + currency: GBP + currencyRate: 1 + lineItems: + - description: Heavy Duty Hinged Gully Grating x4.00 + unitAmount: 402.89 + quantity: 4 + subTotal: 1611.56 + taxAmount: 161.16 + totalAmount: 1772.72 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: Sales Tax (10%) + effectiveTaxRate: 10 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + name: Heavy Duty Hinged Gully Grating + trackingCategoryRefs: + - id: costcode_9 + name: PandaConstruction + isDirectIncome: true + paymentAllocations: + - payment: + id: 9407d5ee-893a-4547-bd89-bc7b795ee774 + note: Payment against invoice 2518ca08-5e2a-4630-8cee-a6bcd1625660 + reference: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-04-25T13:04:02' + totalAmount: 1772.72 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + totalAmount: -1772.72 + withholdingTax: [] + totalDiscount: 0 + subTotal: 1611.56 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 161.16 + totalAmount: 1772.72 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 18c906bf-89d1-ea11-bbaa-000d3a2b9185 + invoiceNumber: '103001' + customerRef: + id: b61217b3-89d1-ea11-bbaa-000d3a2b9185 + companyName: Trey Researches + salesOrderRefs: [] + issueDate: '2019-01-15T00:00:00' + dueDate: '2019-01-15T00:00:00' + modifiedDate: '2023-03-27T14:21:25Z' + sourceModifiedDate: '2022-05-17T16:29:00Z' + paidOnDate: '2019-01-15T00:00:00' + currency: GBP + lineItems: + - description: AMSTERDAM Lamp + unitAmount: 35.6 + quantity: 3 + discountAmount: 0 + subTotal: 106.8 + taxAmount: 21.36 + totalAmount: 128.16 + accountRef: + id: 181217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 'Income, Product Sales' + discountPercentage: 0 + taxRateRef: + id: 63bc0fb9-89d1-ea11-bbaa-000d3a2b9185 + name: Setup for DOMESTIC / STANDARD + effectiveTaxRate: 10 + itemRef: + id: ITEM-d41217b3-89d1-ea11-bbaa-000d3a2b9185-DOMESTIC-DOMESTIC + name: 'AMSTERDAM Lamp / General Business Posting Group: ''DOMESTIC'' / VAT Business Posting Group: ''DOMESTIC''' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: e0299ced-89d1-ea11-bbaa-000d3a2b9185 + note: Invoice 102001 + reference: 'Document No: 103001' + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + currency: GBP + currencyRate: 1 + paidOnDate: '2019-01-15T00:00:00' + totalAmount: 128.16 + allocation: + currency: GBP + currencyRate: 1 + allocatedOnDate: '2019-01-15T00:00:00' + totalAmount: -128.16 + withholdingTax: [] + totalDiscount: 0 + subTotal: 106.8 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 21.36 + totalAmount: 128.16 + amountDue: 0 + discountPercentage: 0 + status: Paid + note: '' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 91dccc63-b1af-4363-bee0-2aec6bab1bef + invoiceNumber: '19700002' + customerRef: + id: c3bf08a3-4d51-4859-acbb-5075f9484f87 + companyName: Mr Abe + salesOrderRefs: [] + issueDate: '2019-11-08T00:00:00Z' + dueDate: '2019-11-29T00:00:00Z' + modifiedDate: '2022-10-26T13:57:52Z' + sourceModifiedDate: '2019-11-08T11:56:22Z' + currency: EUR + currencyRate: 1 + lineItems: + - description: Consultancy per uur - Consultancy per uur + unitAmount: 75 + quantity: 8 + discountAmount: 0 + subTotal: 600 + taxAmount: 0 + totalAmount: 600 + accountRef: + id: 2421e8a0-5355-4ec0-af11-021fe4f39fcd + name: Omzet binnenland hoog tarief + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 600 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 600 + amountDue: 599 + discountPercentage: 0 + status: PartiallyPaid + Exact (UK): + value: + id: a05d1256-f253-46bd-aa13-c6f6a992aa47 + invoiceNumber: '17700002' + customerRef: + id: 570321bb-8b0c-49f1-a1f5-6fb1d6d94a62 + companyName: Some customer + salesOrderRefs: [] + issueDate: '2017-08-02T00:00:00Z' + dueDate: '2017-09-01T00:00:00Z' + modifiedDate: '2022-10-26T13:39:08Z' + sourceModifiedDate: '2017-08-02T18:23:43Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: A bunch of stuff - A bunch of stuff + unitAmount: 100 + quantity: 1000 + discountAmount: 0 + subTotal: 100000 + taxAmount: 0 + totalAmount: 100000 + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 100000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 100000 + amountDue: 0 + discountPercentage: 0 + status: Paid + FreeAgent: + value: + id: '50541736' + invoiceNumber: '2348' + customerRef: + id: '10123537' + companyName: _Test 1 + salesOrderRefs: [] + issueDate: '2016-12-30T00:00:00' + dueDate: '2016-12-30T00:00:00' + modifiedDate: '2023-04-25T14:19:19Z' + sourceModifiedDate: '2022-10-20T14:28:00Z' + paidOnDate: '2020-11-05T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: 3.0 items with VatPercentage of 0.0 + unitAmount: 25.26 + quantity: 1 + discountAmount: 0 + subTotal: 25.26 + taxAmount: 0 + totalAmount: 25.26 + accountRef: + id: '001' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + - description: 3 service charges with 0.0% vat + unitAmount: 8.85 + quantity: 1 + discountAmount: 0 + subTotal: 8.85 + taxAmount: 0 + totalAmount: 8.85 + accountRef: + id: '001' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + - description: Tax + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '262466203' + note: E2E Test transaction 2 CREDIT �250.00 - Invoice receipt against 2348 + currency: GBP + paidOnDate: '2020-11-05T00:00:00' + totalAmount: 250 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.11 + withholdingTax: [] + subTotal: 34.11 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 34.11 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + FreshBooks: + value: + id: '2596455' + invoiceNumber: test-AL + customerRef: + id: '602174' + companyName: ab1 + salesOrderRefs: [] + issueDate: '1987-10-01T00:00:00' + dueDate: '1987-10-01T00:00:00' + modifiedDate: '2023-03-24T16:07:23Z' + sourceModifiedDate: '2023-03-03T09:27:42' + paidOnDate: '2023-03-03T00:00:00' + currency: USD + lineItems: + - description: Editing creative writing for a client + unitAmount: 222.88 + quantity: 1 + discountAmount: 0 + subTotal: 222.88 + taxAmount: 0 + totalAmount: 222.88 + itemRef: + id: '639579' + name: Creative Writing Editorial + trackingCategoryRefs: [] + isDirectIncome: false + - description: '' + unitAmount: 0 + quantity: 1 + discountAmount: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '2570292' + note: '' + currency: USD + paidOnDate: '2023-03-03T00:00:00' + totalAmount: 0.17 + allocation: + currency: USD + currencyRate: 1 + totalAmount: -0.17 + withholdingTax: [] + totalDiscount: 0 + subTotal: 222.88 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 222.88 + amountDue: 222.71 + status: Submitted + note: '' + metadata: + isDeleted: false + KashFlow: + value: + id: '143008521' + invoiceNumber: '40' + customerRef: + id: '86832299' + companyName: Mr French Person + salesOrderRefs: [] + issueDate: '2005-12-15T00:00:00' + dueDate: '2006-01-12T00:00:00' + modifiedDate: '2022-09-30T10:29:15Z' + currency: EUR + currencyRate: 0.844737287 + lineItems: + - unitAmount: 0 + quantity: 0 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + accountRef: + id: '0' + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 0 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 0 + amountDue: 0 + status: Paid + Oracle NetSuite: + value: + id: '416' + invoiceNumber: INV01 + customerRef: + id: '417' + companyName: 10 Breww Ltd + salesOrderRefs: [] + issueDate: '2021-04-09T00:00:00' + dueDate: '2021-04-30T00:00:00' + modifiedDate: '2022-09-20T08:16:10Z' + sourceModifiedDate: '2021-08-25T15:55:36' + paidOnDate: '2021-04-20T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Non-Recurring Services - EC + unitAmount: 100 + quantity: 1 + subTotal: 100 + totalAmount: 100 + accountRef: + id: '54' + name: Sales + itemRef: + id: '28' + name: Non-Recurring Services - EC + trackingCategoryRefs: + - id: location-1 + isDirectIncome: false + paymentAllocations: + - payment: + id: '428' + reference: 'Payment #PYMT01' + accountRef: + id: '122' + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2021-04-20T00:00:00' + totalAmount: 90 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -90 + - payment: + id: '428' + reference: 'Payment #PYMT01' + accountRef: + id: '122' + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2021-04-20T00:00:00' + totalAmount: 90 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10 + withholdingTax: [] + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 100 + amountDue: 0 + status: Paid + QuickBooks Desktop: + value: + id: 2453-1071526256 + invoiceNumber: '975' + customerRef: + id: 420000-1071522044 + companyName: 'Prentice, Adelaide' + salesOrderRefs: [] + issueDate: '2022-11-28T00:00:00' + dueDate: '2023-12-28T00:00:00' + modifiedDate: '2023-04-26T09:08:12Z' + sourceModifiedDate: '2023-12-16T05:06:11' + paidOnDate: '2023-01-15T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Foundation slab - prep and pouring + unitAmount: 167.5 + quantity: 1 + subTotal: 167.5 + taxAmount: 0 + totalAmount: 167.5 + taxRateRef: + id: 20000-999022286 + name: Non-Taxable Sales + itemRef: + id: 320000-1071525597 + name: Concrete Slab + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - unitAmount: 0 + quantity: 1 + subTotal: 0 + taxAmount: 0 + totalAmount: 0 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Rough lumber + unitAmount: 48 + quantity: 1 + subTotal: 48 + taxAmount: 0 + totalAmount: 48 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1C0000-933272656 + name: 'Lumber:Rough' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Trim lumber + unitAmount: 38 + quantity: 1 + subTotal: 38 + taxAmount: 0 + totalAmount: 38 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1D0000-933272656 + name: 'Lumber:Trim' + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Window + unitAmount: 25 + quantity: 2 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Flooring + unitAmount: 50 + quantity: 1 + subTotal: 50 + taxAmount: 0 + totalAmount: 50 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 310000-1071509547 + name: Flooring + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + - description: Window + unitAmount: 30 + quantity: 2 + subTotal: 60 + taxAmount: 0 + totalAmount: 60 + taxRateRef: + id: 10000-999022286 + name: Taxable Sales + itemRef: + id: 1F0000-933272656 + name: Window + trackingCategoryRefs: + - id: 10000-933272658 + name: New Construction + isDirectIncome: false + paymentAllocations: + - payment: + id: 6973-1197775625 + note: Check - 80000-933270541 + reference: '983409' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + currency: GBP + currencyRate: 1 + paidOnDate: '2023-01-15T00:00:00' + totalAmount: 431.95 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -431.95 + withholdingTax: [] + totalDiscount: 0 + subTotal: 413.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 18.45 + totalAmount: 431.95 + amountDue: 0 + discountPercentage: 0 + status: Paid + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '16' + invoiceNumber: '1001' + customerRef: + id: '3' + companyName: Information Sharing Technology + salesOrderRefs: [] + issueDate: '2019-02-18T00:00:00' + dueDate: '2019-03-20T00:00:00' + modifiedDate: '2023-01-18T11:03:02Z' + sourceModifiedDate: '2022-09-20T10:12:08Z' + paidOnDate: '2020-06-01T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Service + unitAmount: 500 + quantity: 10 + subTotal: 5000 + taxAmount: 0 + totalAmount: 5000 + accountRef: + id: '1' + name: Sales + itemRef: + id: '1' + name: Sales + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '116' + note: Payments of type Prepaid + reference: '114213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 65.77 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -23.86 + - payment: + id: '122' + note: Payments of type Cash + reference: '121197' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 771.61 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.31 + - payment: + id: '123' + note: Payments of type Prepaid + reference: '121293' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 34.45 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.45 + - payment: + id: '132' + note: Payments of type Prepaid + reference: '13022' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-10T00:00:00' + totalAmount: 47.38 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -42.36 + - payment: + id: '140' + note: Payments of type Cash + reference: '139163' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 1078.72 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.71 + - payment: + id: '141' + note: Payments of type Prepaid + reference: '139288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 27.88 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.88 + - payment: + id: '149' + note: Payments of type Cash + reference: '148151' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 643.97 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -22.26 + - payment: + id: '150' + note: Payments of type Prepaid + reference: '148217' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-13T00:00:00' + totalAmount: 11.57 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.57 + - payment: + id: '157' + note: Payments of type Prepaid + reference: '155266' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 14.32 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4.87 + - payment: + id: '165' + note: Payments of type Cash + reference: '164142' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 913.09 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.99 + - payment: + id: '166' + note: Payments of type Prepaid + reference: '164260' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 39.98 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -39.98 + - payment: + id: '173' + note: Payments of type Prepaid + reference: '171213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-15T00:00:00' + totalAmount: 35.36 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -26.29 + - payment: + id: '181' + note: Payments of type Cash + reference: '180197' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 1087.13 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.04 + - payment: + id: '182' + note: Payments of type Prepaid + reference: '180274' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 47.91 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -47.91 + - payment: + id: '190' + note: Payments of type Cash + reference: '189174' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 607.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.34 + - payment: + id: '191' + note: Payments of type Prepaid + reference: '18922' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-17T00:00:00' + totalAmount: 16.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.44 + - payment: + id: '199' + note: Payments of type Cash + reference: '198128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 1209.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -20.22 + - payment: + id: '200' + note: Payments of type Prepaid + reference: '198234' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-20T00:00:00' + totalAmount: 18.35 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.35 + - payment: + id: '208' + note: Payments of type Cash + reference: '207189' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-21T00:00:00' + totalAmount: 914.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.86 + - payment: + id: '209' + note: Payments of type Prepaid + reference: '207254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-21T00:00:00' + totalAmount: 27.62 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.62 + - payment: + id: '217' + note: Payments of type Cash + reference: '216161' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-22T00:00:00' + totalAmount: 565.24 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1.66 + - payment: + id: '218' + note: Payments of type Prepaid + reference: '216237' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-22T00:00:00' + totalAmount: 19.67 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -19.67 + - payment: + id: '231' + note: Payments of type Prepaid + reference: '229276' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 38.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -30.52 + - payment: + id: '240' + note: Payments of type PrepaidPayment + reference: '238213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 47.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -31.98 + - payment: + id: '249' + note: Payments of type PrepaidPayment + reference: '247245' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 22.03 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.84 + - payment: + id: '256' + note: Payments of type PrepaidPayment + reference: '254258' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-23T00:00:00' + totalAmount: 37.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.6 + - payment: + id: '262' + note: Payments of type Cash + reference: '261162' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 425.69 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.02 + - payment: + id: '263' + note: Payments of type PrepaidPayment + reference: '261215' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 7.24 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.24 + - payment: + id: '269' + note: Payments of type Cash + reference: '268154' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 968.21 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -48.58 + - payment: + id: '270' + note: Payments of type PrepaidPayment + reference: '268269' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-24T00:00:00' + totalAmount: 11.69 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.69 + - payment: + id: '278' + note: Payments of type Cash + reference: '277153' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-25T00:00:00' + totalAmount: 1063.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -37.08 + - payment: + id: '279' + note: Payments of type PrepaidPayment + reference: '277281' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-25T00:00:00' + totalAmount: 30.58 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -30.58 + - payment: + id: '287' + note: Payments of type Cash + reference: '286188' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-26T00:00:00' + totalAmount: 539.55 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.97 + - payment: + id: '288' + note: Payments of type PrepaidPayment + reference: '286250' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-26T00:00:00' + totalAmount: 12.73 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -12.73 + - payment: + id: '296' + note: Payments of type Cash + reference: '295176' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-27T00:00:00' + totalAmount: 687.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4.18 + - payment: + id: '297' + note: Payments of type PrepaidPayment + reference: '295264' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-27T00:00:00' + totalAmount: 14.92 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -14.92 + - payment: + id: '303' + note: Payments of type Cash + reference: '302128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-28T00:00:00' + totalAmount: 837.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.66 + - payment: + id: '304' + note: Payments of type PrepaidPayment + reference: '302284' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-28T00:00:00' + totalAmount: 17.04 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.04 + - payment: + id: '313' + note: Payments of type PrepaidPayment + reference: '311211' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 45.06 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -41.47 + - payment: + id: '321' + note: Payments of type Cash + reference: '320186' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 798.79 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -27.08 + - payment: + id: '322' + note: Payments of type PrepaidPayment + reference: '320256' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-29T00:00:00' + totalAmount: 14.33 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -14.33 + - payment: + id: '333' + note: Payments of type PrepaidPayment + reference: '331236' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 17.94 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.58 + - payment: + id: '341' + note: Payments of type Cash + reference: '340128' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 859.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -29.21 + - payment: + id: '342' + note: Payments of type PrepaidPayment + reference: '340292' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-30T00:00:00' + totalAmount: 26.59 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -26.59 + - payment: + id: '348' + note: Payments of type Cash + reference: '34710' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-31T00:00:00' + totalAmount: 949.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.07 + - payment: + id: '349' + note: Payments of type PrepaidPayment + reference: '347216' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-01-31T00:00:00' + totalAmount: 25.32 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25.32 + - payment: + id: '361' + note: Payments of type PrepaidPayment + reference: '359220' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-01T00:00:00' + totalAmount: 54.12 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -40.61 + - payment: + id: '367' + note: Payments of type Cash + reference: '366195' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-02T00:00:00' + totalAmount: 827.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25.4 + - payment: + id: '368' + note: Payments of type PrepaidPayment + reference: '366288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-02T00:00:00' + totalAmount: 12.15 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -12.15 + - payment: + id: '376' + note: Payments of type Cash + reference: '375123' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-03T00:00:00' + totalAmount: 802.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.54 + - payment: + id: '377' + note: Payments of type PrepaidPayment + reference: '375298' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-03T00:00:00' + totalAmount: 39.06 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -39.06 + - payment: + id: '385' + note: Payments of type Cash + reference: '38418' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-04T00:00:00' + totalAmount: 858.41 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -13.4 + - payment: + id: '386' + note: Payments of type PrepaidPayment + reference: '384213' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-04T00:00:00' + totalAmount: 9.99 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -9.99 + - payment: + id: '392' + note: Payments of type Cash + reference: '391115' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 1094.8 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -47.35 + - payment: + id: '393' + note: Payments of type PrepaidPayment + reference: '391247' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-05T00:00:00' + totalAmount: 16.73 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.73 + - payment: + id: '402' + note: Payments of type PrepaidPayment + reference: '400275' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-06T00:00:00' + totalAmount: 32.88 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -29.29 + - payment: + id: '410' + note: Payments of type Cash + reference: '409145' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-07T00:00:00' + totalAmount: 725.48 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.79 + - payment: + id: '411' + note: Payments of type PrepaidPayment + reference: '409292' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-07T00:00:00' + totalAmount: 6.22 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.22 + - payment: + id: '419' + note: Payments of type Cash + reference: '418157' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-08T00:00:00' + totalAmount: 407.2 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -2.55 + - payment: + id: '420' + note: Payments of type PrepaidPayment + reference: '418258' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-08T00:00:00' + totalAmount: 8.92 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.92 + - payment: + id: '429' + note: Payments of type PrepaidPayment + reference: '427270' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-09T00:00:00' + totalAmount: 56.75 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -28.75 + - payment: + id: '437' + note: Payments of type Cash + reference: '436168' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-10T00:00:00' + totalAmount: 760.05 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -31.48 + - payment: + id: '438' + note: Payments of type PrepaidPayment + reference: '436234' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-10T00:00:00' + totalAmount: 6.03 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -6.03 + - payment: + id: '446' + note: Payments of type Cash + reference: '44518' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 904.82 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.96 + - payment: + id: '447' + note: Payments of type PrepaidPayment + reference: '445278' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 24.95 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -24.95 + - payment: + id: '456' + note: Payments of type PrepaidPayment + reference: '454252' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-11T00:00:00' + totalAmount: 70.44 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.72 + - payment: + id: '462' + note: Payments of type Cash + reference: '461144' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 914.05 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -34.76 + - payment: + id: '463' + note: Payments of type PrepaidPayment + reference: '461243' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 7.47 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.47 + - payment: + id: '470' + note: Payments of type PrepaidPayment + reference: '468248' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-13T00:00:00' + totalAmount: 67.83 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -41.38 + - payment: + id: '481' + note: Payments of type Cash + reference: '480129' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-17T00:00:00' + totalAmount: 965.85 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -10.21 + - payment: + id: '482' + note: Payments of type PrepaidPayment + reference: '480242' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-17T00:00:00' + totalAmount: 33.9 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -33.9 + - payment: + id: '490' + note: Payments of type Cash + reference: '489120' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-18T00:00:00' + totalAmount: 1112.76 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -7.74 + - payment: + id: '491' + note: Payments of type PrepaidPayment + reference: '489239' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-18T00:00:00' + totalAmount: 48.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -48.74 + - payment: + id: '499' + note: Payments of type Cash + reference: '498147' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 1017 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -5.08 + - payment: + id: '500' + note: Payments of type PrepaidPayment + reference: '498254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 37.77 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -37.77 + - payment: + id: '507' + note: Payments of type PrepaidPayment + reference: '505288' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 62.82 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -54.62 + - payment: + id: '521' + note: Payments of type PrepaidPayment + reference: '519243' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-02-20T00:00:00' + totalAmount: 14.74 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '647' + note: Payments of type PrepaidPayment + reference: '645263' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-03-20T00:00:00' + totalAmount: 40.43 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '705' + note: Payments of type PrepaidPayment + reference: '703246' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-03T00:00:00' + totalAmount: 25 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -25 + - payment: + id: '772' + note: Payments of type PrepaidPayment + reference: '770263' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-24T00:00:00' + totalAmount: 10.35 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '779' + note: Payments of type PrepaidPayment + reference: '777217' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-24T00:00:00' + totalAmount: 39.55 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '792' + note: Payments of type PrepaidPayment + reference: '790262' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-29T00:00:00' + totalAmount: 12.46 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '843' + note: Payments of type PrepaidPayment + reference: '841264' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-07T00:00:00' + totalAmount: 25.64 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '850' + note: Payments of type PrepaidPayment + reference: '848254' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-14T00:00:00' + totalAmount: 53.68 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + - payment: + id: '877' + note: Payments of type PrepaidPayment + reference: '875210' + accountRef: + id: '60' + name: Money (oney) + currency: GBP + currencyRate: 1 + paidOnDate: '2020-06-01T00:00:00' + totalAmount: 12.7 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -0.01 + withholdingTax: [] + totalDiscount: 0 + subTotal: 5000 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 5000 + amountDue: 3296.44 + status: PartiallyPaid + note: Invoice for service + QuickBooks Online Sandbox: + value: + id: '30' + invoiceNumber: '1002' + customerRef: + id: '59' + companyName: Ecker Holiday event + salesOrderRefs: [] + issueDate: '2016-01-06T00:00:00' + dueDate: '2016-02-05T00:00:00' + modifiedDate: '2023-04-26T09:36:12Z' + sourceModifiedDate: '2023-01-25T13:49:52Z' + paidOnDate: '2016-02-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Holiday party - gold level test v1 + unitAmount: 2000 + quantity: 1 + subTotal: 2000 + taxAmount: 400 + totalAmount: 2400 + accountRef: + id: '44' + name: Sales + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '7' + name: Gold party + trackingCategoryRefs: [] + isDirectIncome: false + - description: Venue rental + unitAmount: 10000 + quantity: 1 + subTotal: 10000 + taxAmount: 2000 + totalAmount: 12000 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '20' + name: Venue Rental + trackingCategoryRefs: [] + isDirectIncome: false + - description: promotional items -- misc engraved items + unitAmount: 13.5 + quantity: 75 + subTotal: 1012.5 + taxAmount: 202.5 + totalAmount: 1215 + accountRef: + id: '68' + name: Billable Expenses Income + taxRateRef: + id: 3_Invoices + name: 20.0% S Invoices + effectiveTaxRate: 20 + itemRef: + id: '12' + name: Misc + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: '31' + note: '' + accountRef: + id: '81' + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2016-02-12T00:00:00' + totalAmount: 15615 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15615 + withholdingTax: [] + totalDiscount: 0 + subTotal: 13012.5 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 2602.5 + totalAmount: 15615 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '82322' + invoiceNumber: '0000000110' + customerRef: + id: A1D001 + companyName: A1 Design Services + salesOrderRefs: [] + issueDate: '2020-07-13T00:00:00Z' + dueDate: '2020-08-12T00:00:00Z' + modifiedDate: '2022-10-14T09:36:12Z' + sourceModifiedDate: '2020-07-13T11:06:40Z' + currency: GBP + currencyRate: 1 + lineItems: + - description: Tax Summary - Standard rate + unitAmount: 0 + quantity: 0 + discountAmount: 0.22 + subTotal: 0 + taxAmount: 8.67 + totalAmount: 8.67 + taxRateRef: + id: '1729' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: [] + isDirectIncome: false + - description: Goods Summary + unitAmount: 0 + quantity: 0 + discountAmount: 1.08 + subTotal: 43.34 + taxAmount: 0 + totalAmount: 43.34 + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + totalDiscount: 1.3 + subTotal: 43.34 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 8.67 + totalAmount: 52.01 + amountDue: 52.01 + discountPercentage: 2.49 + status: Submitted + note: '0000000114' + Sage 50 (UK): + value: + id: INV-1 + invoiceNumber: '1' + customerRef: + id: A1D001 + companyName: A1 Design Services + salesOrderRefs: [] + issueDate: '2021-01-02T00:00:00' + modifiedDate: '2023-03-30T14:42:42Z' + sourceModifiedDate: '2022-11-25T09:43:54' + paidOnDate: '2022-01-29T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: AT Mini Tower Case + unitAmount: 14.25 + quantity: 1 + discountAmount: 0 + subTotal: 14.25 + taxAmount: 2.43 + totalAmount: 16.68 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Whiteboard - Drywipe (900 x 1200) + unitAmount: 19 + quantity: 4 + discountAmount: 0 + subTotal: 76 + taxAmount: 12.97 + totalAmount: 88.97 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: A4 Ledger Book - 5 Column + unitAmount: 7.59 + quantity: 8 + discountAmount: 0 + subTotal: 60.72 + taxAmount: 10.36 + totalAmount: 71.08 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Shorthand Notebook - 80 Sheets + unitAmount: 4.27 + quantity: 20 + discountAmount: 0 + subTotal: 85.4 + taxAmount: 14.57 + totalAmount: 99.97 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Desktop + unitAmount: 9.5 + quantity: 1 + discountAmount: 0 + subTotal: 9.5 + taxAmount: 1.62 + totalAmount: 11.12 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Desktop (Printing) + unitAmount: 16.15 + quantity: 1 + discountAmount: 0 + subTotal: 16.15 + taxAmount: 2.76 + totalAmount: 18.91 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Calculator - Printing Rolls + unitAmount: 5.7 + quantity: 15 + discountAmount: 0 + subTotal: 85.5 + taxAmount: 14.59 + totalAmount: 100.09 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Correction Fluid - White + unitAmount: 2.37 + quantity: 7 + discountAmount: 0 + subTotal: 16.59 + taxAmount: 2.83 + totalAmount: 19.42 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Envelope - White (110 x 220) Plain + unitAmount: 8.54 + quantity: 20 + discountAmount: 0 + subTotal: 170.8 + taxAmount: 29.14 + totalAmount: 199.94 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Flip Chart - A1 Pad + unitAmount: 15.2 + quantity: 10 + discountAmount: 0 + subTotal: 152 + taxAmount: 25.94 + totalAmount: 177.94 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Laminator Pouches - A4 + unitAmount: 11.4 + quantity: 5 + discountAmount: 0 + subTotal: 57 + taxAmount: 9.73 + totalAmount: 66.73 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Mouse Mat - (241 x 203) Blue + unitAmount: 1.42 + quantity: 5 + discountAmount: 0 + subTotal: 7.1 + taxAmount: 1.21 + totalAmount: 8.31 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Copy Paper - Economy Grade + unitAmount: 2.46 + quantity: 80 + discountAmount: 0 + subTotal: 196.8 + taxAmount: 33.58 + totalAmount: 230.38 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Coloured Paper - Pastel Blue + unitAmount: 3.61 + quantity: 5 + discountAmount: 0 + subTotal: 18.05 + taxAmount: 3.08 + totalAmount: 21.13 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Ball Point Pen - Black + unitAmount: 1.9 + quantity: 8 + discountAmount: 0 + subTotal: 15.2 + taxAmount: 2.59 + totalAmount: 17.79 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Pencil - HB + unitAmount: 2.37 + quantity: 3 + discountAmount: 0 + subTotal: 7.11 + taxAmount: 1.21 + totalAmount: 8.32 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Remember-Me Sticky Notes (Recycled) + unitAmount: 3.32 + quantity: 6 + discountAmount: 0 + subTotal: 19.92 + taxAmount: 3.4 + totalAmount: 23.32 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Scissors - Economy + unitAmount: 2.85 + quantity: 1 + discountAmount: 0 + subTotal: 2.85 + taxAmount: 0.49 + totalAmount: 3.34 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Adhesive Tape - Brown (50mm x 66m) + unitAmount: 2.66 + quantity: 5 + discountAmount: 0 + subTotal: 13.3 + taxAmount: 2.27 + totalAmount: 15.57 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: JP010 Jet Printer Cartridge + unitAmount: 17.1 + quantity: 5 + discountAmount: 0 + subTotal: 85.5 + taxAmount: 14.59 + totalAmount: 100.09 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + - description: Letter Trays - 3 pack (Red) + unitAmount: 6.65 + quantity: 2 + discountAmount: 0 + subTotal: 13.3 + taxAmount: 2.27 + totalAmount: 15.57 + accountRef: + id: '4000' + name: Sales North + discountPercentage: 0 + taxRateRef: + id: '1' + name: Standard rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: department_1 + name: Sales + isDirectIncome: false + paymentAllocations: + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.32 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -11.12 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -8.31 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -19.42 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.57 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -21.13 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -99.97 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -23.32 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -18.91 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -16.68 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -100.09 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -199.94 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -3.34 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -15.57 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -100.09 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -66.73 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -117.5 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -177.94 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -230.38 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -17.79 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -71.08 + - payment: + id: '265' + note: Sales receipt 265 linked to sales invoice inv-1. + accountRef: + id: '1200' + name: Bank Current Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-01-29T00:00:00' + totalAmount: 1432.17 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -88.97 + withholdingTax: [] + totalDiscount: 0 + subTotal: 1223.04 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 209.13 + totalAmount: 1432.17 + amountDue: 0 + status: Paid + note: '' + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: b039b0a733de11e797950a57719b2edb + invoiceNumber: SI-1 + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + salesOrderRefs: [] + issueDate: '2017-05-08T00:00:00' + dueDate: '2017-06-07T00:00:00' + modifiedDate: '2022-10-24T15:03:37Z' + sourceModifiedDate: '2021-07-23T13:42:59Z' + paidOnDate: '2021-07-23T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Consulting services + unitAmount: 900 + quantity: 8 + discountAmount: 0 + subTotal: 7200 + taxAmount: 1440 + totalAmount: 8640 + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + discountPercentage: 0 + taxRateRef: + id: GB_STANDARD + name: Standard 20.00% + effectiveTaxRate: 20 + itemRef: + id: a87b922b33de11e797950a57719b2edb + name: Consulting services + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: + - payment: + id: 52237e4e215911e8b45c025132dab352 + note: Customer receipt using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-01-02T00:00:00' + totalAmount: 4000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4000 + - payment: + id: 579388a0215911e8b45c025132dab352 + note: Customer receipt using credit/debit card + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + currency: GBP + currencyRate: 1 + paidOnDate: '2018-01-02T00:00:00' + totalAmount: 1400 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1400 + - payment: + id: e1c2bd659a6111e8bad90617b3da4b8a + note: Sales credit note + currency: GBP + currencyRate: 1 + paidOnDate: '2018-08-07T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1000 + - payment: + id: e1c2bd659a6111e8bad90617b3da4b8a + note: Sales credit note + currency: GBP + currencyRate: 1 + paidOnDate: '2018-08-07T00:00:00' + totalAmount: 0 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1000 + withholdingTax: [] + totalDiscount: 0 + subTotal: 7200 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 1440 + totalAmount: 8640 + amountDue: 1240 + status: PartiallyPaid + Sage Intacct: + value: + id: '2916' + invoiceNumber: IN0480 + customerRef: + id: '12' + companyName: MK Manufacturing + salesOrderRefs: [] + issueDate: '2021-04-22T00:00:00' + dueDate: '2021-05-22T00:00:00' + modifiedDate: '2023-04-04T16:31:54Z' + sourceModifiedDate: '2021-04-22T11:01:11Z' + paidOnDate: '2021-04-22T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - unitAmount: 100 + quantity: 1 + subTotal: 100 + taxAmount: 20 + totalAmount: 120 + accountRef: + id: '176' + name: Revenue - Services + taxRateRef: + id: '105' + name: UK Sale Services Standard Rate + effectiveTaxRate: 20 + trackingCategoryRefs: + - id: CUSTOMER-12 + name: MK Manufacturing + - id: DEPARTMENT-2 + name: Services + - id: LOCATION-11 + name: Codat Test Entity + isDirectIncome: false + paymentAllocations: + - payment: + id: '2918' + note: '' + accountRef: + id: '353' + name: Current Account + currency: GBP + paidOnDate: '2021-04-22T00:00:00' + totalAmount: 120 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -120 + withholdingTax: [] + totalDiscount: 0 + subTotal: 100 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 20 + totalAmount: 120 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + Wave: + value: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0ludm9pY2U6NzgyNDQ4OTg1Nzc1MzE5MTYw + invoiceNumber: '1' + customerRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O0N1c3RvbWVyOjMyMzkzNTA4 + companyName: ABC Textiles + salesOrderRefs: [] + issueDate: '2019-10-17T00:00:00' + dueDate: '2019-10-17T00:00:00' + modifiedDate: '2022-11-16T18:15:23Z' + sourceModifiedDate: '2019-12-05T23:20:36Z' + paidOnDate: '2019-12-05T23:20:36Z' + currency: USD + currencyRate: 0.784736781 + lineItems: + - description: '' + unitAmount: 10 + quantity: 5 + subTotal: 50 + taxAmount: 2.5 + totalAmount: 52.5 + accountRef: + id: QWNjb3VudDo3OTE3NTA2MDA0MjQ0NTExMTU7QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2 + name: Sales + itemRef: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1Byb2R1Y3Q6MzU2NjcyNTI= + name: Golf balls + trackingCategoryRefs: [] + isDirectIncome: false + paymentAllocations: [] + withholdingTax: [] + subTotal: 50 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 2.5 + totalAmount: 52.5 + amountDue: 0 + status: Paid + Xero: + value: + id: 321bfed3-2da2-4969-9358-4de97821181b + invoiceNumber: INV-001-0 + customerRef: + id: afd4093b-c655-4847-8ee2-10a4f2c3eae3 + companyName: Maddox Publishing Group + salesOrderRefs: [] + issueDate: '2021-12-20T00:00:00' + dueDate: '2022-01-17T00:00:00' + modifiedDate: '2023-03-15T20:38:11Z' + sourceModifiedDate: '2021-01-02T20:34:51' + paidOnDate: '2022-02-17T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - description: Project management - onsite daily rate - your CRM integration project + unitAmount: 583.3333333333 + quantity: 6 + discountAmount: 0 + subTotal: 3500 + taxAmount: 700 + totalAmount: 4200 + accountRef: + id: a969500a-377c-4cea-8f2b-a4e385607fd0 + name: Other Revenue + discountPercentage: 0 + taxRateRef: + id: OUTPUT2 + name: 20% (VAT on Income) + effectiveTaxRate: 20 + itemRef: + id: aa1c5f84-4453-42fa-9c92-69d4085607c9 + name: Project management - daily rate + trackingCategoryRefs: + - id: 34b9b859-07a9-451a-b4d3-effc9946634a + name: North + isDirectIncome: false + paymentAllocations: + - payment: + id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + currency: GBP + currencyRate: 1 + paidOnDate: '2022-02-17T00:00:00' + totalAmount: 4200 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -4200 + withholdingTax: [] + totalDiscount: 0 + subTotal: 3500 + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 700 + totalAmount: 4200 + amountDue: 0 + status: Paid + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000038034' + invoiceNumber: INV-102 + customerRef: + id: '104957000000037097' + companyName: Test Company + salesOrderRefs: [] + issueDate: '2020-02-06T10:54:03' + dueDate: '2020-02-17T00:00:00' + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2020-05-19T15:36:26' + paidOnDate: '2020-05-19T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: [] + paymentAllocations: + - payment: + id: '104957000000129048' + note: '' + reference: '9' + accountRef: + id: '104957000000000349' + name: Petty Cash + currency: GBP + currencyRate: 1 + paidOnDate: '2020-04-29T00:00:00' + totalAmount: 9000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -9000 + - payment: + id: '104957000000137017' + note: '' + reference: '11' + accountRef: + id: '104957000000060010' + name: Abdi Test + currency: GBP + currencyRate: 1 + paidOnDate: '2020-05-19T00:00:00' + totalAmount: 9000 + allocation: + currency: GBP + currencyRate: 1 + totalAmount: -1 + withholdingTax: [] + additionalTaxAmount: 0 + additionalTaxPercentage: 0 + totalTaxAmount: 0 + totalAmount: 9001 + amountDue: 0 + status: Paid + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get invoice + description: | + The *Get invoice* endpoint returns a single invoice for a given invoiceId. + + [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + ### Tips and traps + + To access the `paymentAllocations` property, ensure that the `payments` data type is queued and cached in Codat before retrieving `invoices` from Codat's cache. + operationId: get-accounting-invoice + x-speakeasy-group: accounts-receivable.invoices + '/companies/{companyId}/data/invoices/{invoiceId}/pdf': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingInvoiceId' + responses: + '200': + description: Success + content: + application/pdf: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get invoice as PDF + description: "\uFEFF\x44\x6F\x77\x6E\x6C\x6F\x61\x64\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x61\x73\x20\x61\x20\x70\x64\x66\x2E" + operationId: download-accounting-invoice-pdf + x-speakeasy-name-override: download-pdf + x-speakeasy-group: accounts-receivable.invoices + '/companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingInvoiceId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: List invoice attachments + description: |- + The *List invoice attachments* endpoint returns a list of attachments available to download for given `invoiceId`. + + [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + operationId: list-accounting-invoice-attachments + x-speakeasy-group: accounts-receivable.invoices + '/companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingInvoiceId' + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get invoice attachment + description: | + The *Get invoice attachment* endpoint returns a specific attachment for a given `invoiceId` and `attachmentId`. + + [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + operationId: get-accounting-invoice-attachment + x-speakeasy-group: accounts-receivable.invoices + '/companies/{companyId}/connections/{connectionId}/data/invoices/{invoiceId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingInvoiceId' + - $ref: '#/components/parameters/attachmentId' + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Download invoice attachment + description: | + The *Download invoice attachment* endpoint downloads a specific attachment for a given `invoiceId` and `attachmentId`. + + [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + operationId: download-accounting-invoice-attachment + x-speakeasy-group: accounts-receivable.invoices + '/companies/{companyId}/data/journalEntries': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Transactions + summary: List journal entries + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingJournalEntries' + examples: + Clear Books: + value: + results: + - id: 770c89bb-3d6a-449a-9243-739378b4cd7d + postedOn: '2022-04-19T00:00:00' + createdOn: '2022-04-19T00:00:00' + journalRef: + id: 90bb7784-083b-4bcb-a534-b30756cee65d + name: General Journal + journalLines: + - description: '' + netAmount: 32095.91 + currency: GBP + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + - description: Tax for direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + netAmount: -2917.81 + currency: GBP + accountRef: + id: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + name: VAT + - description: '' + netAmount: -29178.09 + currency: GBP + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + modifiedDate: '2023-04-26T12:38:18Z' + recordRef: + id: c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + dataType: directIncomes + metadata: + isDeleted: false + - id: 9f96606f-6846-40c6-b423-9b1753458e75 + postedOn: '2022-04-19T00:00:00' + createdOn: '2022-04-19T00:00:00' + journalRef: + id: 90bb7784-083b-4bcb-a534-b30756cee65d + name: General Journal + journalLines: + - description: '' + netAmount: 188.33 + currency: GBP + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + - description: Tax for direct income 38e8c917-0afc-4583-8ffe-1b53ad601197 + netAmount: -17.12 + currency: GBP + accountRef: + id: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + name: VAT + - description: '' + netAmount: -171.21 + currency: GBP + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + modifiedDate: '2023-04-26T12:38:18Z' + recordRef: + id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + dataType: directIncomes + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1862 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/journalEntries + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/journalEntries?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: START + postedOn: '2018-12-31T00:00:00' + createdOn: '2018-12-31T00:00:00' + journalRef: + id: 4caabc3e-3d64-ed11-8c34-000d3a870cba + name: DEFAULT + journalLines: + - description: Opening Entry + netAmount: -69723.14 + currency: GBP + accountRef: + id: ac1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Retained Earnings + - description: Opening Entry + netAmount: -20000 + currency: GBP + accountRef: + id: aa1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Share Capital + - description: Opening Entry + netAmount: -2329.42 + currency: GBP + accountRef: + id: 8a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Payable + - description: Opening Entry + netAmount: 3499 + currency: GBP + accountRef: + id: 6e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accumulated Depreciation + - description: Opening Entry + netAmount: 5498 + currency: GBP + accountRef: + id: 6c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Equipment + - description: Opening Entry + netAmount: 28547.16 + currency: GBP + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + - description: Opening Entry + netAmount: 31638.4 + currency: GBP + accountRef: + id: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Receivable + - description: Opening Entry + netAmount: 2870 + currency: GBP + accountRef: + id: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Receivable + - description: Opening Entry + netAmount: 20000 + currency: GBP + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + modifiedDate: '2023-03-27T14:21:31Z' + sourceModifiedDate: '2020-07-29T10:56:12Z' + metadata: + isDeleted: false + - id: 01-2019 + postedOn: '2019-01-01T00:00:00' + createdOn: '2019-01-01T00:00:00' + journalRef: + id: 4caabc3e-3d64-ed11-8c34-000d3a870cba + name: DEFAULT + journalLines: + - description: January 2019 + netAmount: -2000 + currency: GBP + accountRef: + id: 5e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Checking account + - description: January 2019 + netAmount: 1000 + currency: GBP + accountRef: + id: 401217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Salaries Expense + - description: January 2019 + netAmount: 1000 + currency: GBP + accountRef: + id: 341217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Rent Expense + modifiedDate: '2023-03-27T14:21:31Z' + sourceModifiedDate: '2020-07-29T10:56:12Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 825 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/journalEntries + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/journalEntries?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 00002c0a-8061-4ad2-84fa-c879eea880a7 + createdOn: '2022-01-11T14:18:54' + updatedOn: '2022-01-11T14:18:54' + journalRef: + id: 55ff34a3-0857-4202-b7ec-a399cfc26a4e + name: Memoriaal + journalLines: + - description: 1 transactions of type CARD_PAYMENT_FEE_REFUND + netAmount: -6.94 + currency: EUR + accountRef: + id: e0217fbf-8963-4134-80ef-929d5de8612d + name: Kosten 13e maand + tracking: + recordRefs: [] + - description: 1 transactions of type CARD_PAYMENT_FEE_REFUND + netAmount: 6.94 + currency: EUR + accountRef: + id: 0166c96b-adf2-4667-a755-87e67c741f41 + name: Resultaat verkoop activa + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:37:10Z' + sourceModifiedDate: '2022-01-11T14:18:54Z' + - id: 000154f0-e83a-4012-96a3-7db0b036b96b + createdOn: '2020-04-22T13:56:46' + updatedOn: '2020-04-22T13:56:46' + journalRef: + id: 151313ae-55b1-4ba0-b32a-e2ef6a8ce52a + name: Nominal Card + journalLines: + - description: Refunds with payment type of Cash + netAmount: -144.36 + currency: EUR + accountRef: + id: 0741cc89-e33a-4358-bcbd-3acb07b005dc + name: Nominal Card + tracking: + recordRefs: [] + - description: Refunds with payment type of Cash + netAmount: 144.36 + currency: EUR + accountRef: + id: ef2fde36-4416-4bc5-b239-315b2929348c + name: Debiteuren + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:37:08Z' + sourceModifiedDate: '2020-04-22T13:56:46Z' + pageNumber: 1 + pageSize: 2 + totalResults: 35972 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/journalEntries + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/journalEntries?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 0008ef00-c5f8-4f97-bce9-5094b2f569dd + createdOn: '2020-07-03T10:51:46' + updatedOn: '2020-07-03T10:51:46' + journalRef: + id: ed5068ff-cb0e-4edd-9777-36ac94a5d6f0 + name: Sales journal + journalLines: + - netAmount: -9.1 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - description: 6 service charges with 0.0% vat + netAmount: -11.21 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 28.0 items with VatPercentage of 0.0 + netAmount: -308.61 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: Gratuity + netAmount: -25.87 + currency: GBP + accountRef: + id: febc52c4-a1ed-4000-b51a-76f9f525445d + name: Salary Control Account + tracking: + recordRefs: [] + - netAmount: -47.14 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - description: 19.0 items with VatPercentage of 20.0 + netAmount: -235.72 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 13.0 items with VatPercentage of 5.0 + netAmount: -182.06 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 1.0 gift cards + netAmount: -1 + currency: GBP + accountRef: + id: febc52c4-a1ed-4000-b51a-76f9f525445d + name: Salary Control Account + tracking: + recordRefs: [] + - netAmount: 820.71 + currency: GBP + accountRef: + id: cf9572e7-8afa-4339-9113-af32a66d9df9 + name: Trade Debtors + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:35:45Z' + sourceModifiedDate: '2020-07-03T10:51:46Z' + recordRef: + id: 0008ef00-c5f8-4f97-bce9-5094b2f569dd + dataType: invoices + - id: 001a8d63-2d5b-4b00-b17f-894108b6ce81 + createdOn: '2021-07-30T18:02:23' + updatedOn: '2021-07-30T18:02:23' + journalRef: + id: ed5068ff-cb0e-4edd-9777-36ac94a5d6f0 + name: Sales journal + journalLines: + - netAmount: 1038.01 + currency: GBP + accountRef: + id: cf9572e7-8afa-4339-9113-af32a66d9df9 + name: Trade Debtors + tracking: + recordRefs: [] + - description: 1.0 gift cards + netAmount: -1 + currency: GBP + accountRef: + id: cc0ab812-d89a-452b-88a8-61666a0f0211 + name: Accruals + tracking: + recordRefs: [] + - netAmount: -19.29 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - netAmount: -60.82 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - description: 15.0 items with VatPercentage of 0.0 + netAmount: -248.28 + currency: GBP + accountRef: + id: ba7d27d1-72cf-411b-8ef3-55ca4b13dac3 + name: Sundry Non-Operating Expenses + tracking: + recordRefs: [] + - description: Gratuity + netAmount: -8.97 + currency: GBP + accountRef: + id: 8f27a6b8-101d-4613-a059-2b462fb01b2f + name: anna_test_prod + tracking: + recordRefs: [] + - description: 28.0 items with VatPercentage of 5.0 + netAmount: -385.7 + currency: GBP + accountRef: + id: ba7d27d1-72cf-411b-8ef3-55ca4b13dac3 + name: Sundry Non-Operating Expenses + tracking: + recordRefs: [] + - description: 2 service charges with 0.0% vat + netAmount: -9.85 + currency: GBP + accountRef: + id: ba7d27d1-72cf-411b-8ef3-55ca4b13dac3 + name: Sundry Non-Operating Expenses + tracking: + recordRefs: [] + - description: 27.0 items with VatPercentage of 20.0 + netAmount: -304.1 + currency: GBP + accountRef: + id: ba7d27d1-72cf-411b-8ef3-55ca4b13dac3 + name: Sundry Non-Operating Expenses + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:35:45Z' + sourceModifiedDate: '2021-07-30T18:02:23Z' + recordRef: + id: 001a8d63-2d5b-4b00-b17f-894108b6ce81 + dataType: invoices + pageNumber: 1 + pageSize: 2 + totalResults: 6785 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/journalEntries + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/journalEntries?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '24389149' + postedOn: '1987-10-01T00:00:00' + createdOn: '1987-10-01T00:00:00' + updatedOn: '1987-10-01T00:00:00' + journalLines: + - description: '' + netAmount: 222.88 + currency: GBP + accountRef: + id: '128611' + name: Accounts Receivable + - description: Creative Writing Editorial + netAmount: -222.88 + currency: GBP + accountRef: + id: '128613' + name: Sales + - description: '' + netAmount: 0 + currency: GBP + accountRef: + id: '128613' + name: Sales + modifiedDate: '2023-03-24T16:07:38Z' + sourceModifiedDate: '1987-10-01T00:00:00' + recordRef: + id: '2596455' + dataType: invoices + metadata: + isDeleted: false + - id: '24389396' + postedOn: '1987-10-01T00:00:00' + createdOn: '1987-10-01T00:00:00' + updatedOn: '1987-10-01T00:00:00' + journalLines: + - description: '' + netAmount: -222.88 + currency: GBP + accountRef: + id: '128611' + name: Accounts Receivable + - description: Creative Writing Editorial + netAmount: 222.88 + currency: GBP + accountRef: + id: '128613' + name: Sales + - description: '' + netAmount: 0 + currency: GBP + accountRef: + id: '128613' + name: Sales + modifiedDate: '2023-03-24T16:07:38Z' + sourceModifiedDate: '1987-10-01T00:00:00' + recordRef: + id: '2596455' + dataType: invoices + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 734 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/journalEntries + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/journalEntries?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '112' + postedOn: '2021-03-26T00:00:00' + createdOn: '2021-03-26T10:31:05' + updatedOn: '2021-03-26T10:31:06' + journalLines: + - netAmount: -120 + currency: GBP + accountRef: + id: '825' + name: Codat Europe Bank + tracking: + recordRefs: + - id: location-4 + dataType: trackingCategories + - id: '724' + dataType: suppliers + - netAmount: 120 + currency: GBP + accountRef: + id: '111' + name: Accounts Payable + tracking: + recordRefs: + - id: location-4 + dataType: trackingCategories + - id: '724' + dataType: suppliers + modifiedDate: '2023-01-30T14:49:07Z' + sourceModifiedDate: '2021-03-26T10:31:06' + recordRef: + id: '112' + dataType: billPayments + - id: '7' + postedOn: '2021-03-26T00:00:00' + createdOn: '2021-03-26T10:02:18' + updatedOn: '2022-07-05T13:38:10' + journalLines: + - netAmount: -144 + currency: GBP + accountRef: + id: '111' + name: Accounts Payable + tracking: + recordRefs: + - id: '724' + dataType: suppliers + - netAmount: 120 + currency: GBP + accountRef: + id: '716' + name: Inventory In Transit + tracking: + recordRefs: + - id: location-4 + dataType: trackingCategories + - description: VAT + netAmount: 24 + currency: GBP + accountRef: + id: '211' + name: VAT on Purchases + tracking: + recordRefs: + - id: '713' + dataType: suppliers + modifiedDate: '2023-01-30T14:49:07Z' + sourceModifiedDate: '2022-07-05T13:38:10' + recordRef: + id: '7' + dataType: bills + pageNumber: 1 + pageSize: 2 + totalResults: 11 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/journalEntries + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/journalEntries?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 2453-1071526256 + postedOn: '2022-11-28T00:00:00' + createdOn: '2022-11-28T00:00:00' + journalLines: + - description: '' + netAmount: 431.95 + currency: GBP + accountRef: + id: 40000-933270541 + name: Accounts Receivable + - description: Foundation slab - prep and pouring + netAmount: -167.5 + currency: GBP + accountRef: + id: 190000-933270541 + name: Labor Income + - description: 'CA sales tax, San Domingo County' + netAmount: -18.45 + currency: GBP + accountRef: + id: 100000-933270541 + name: Sales Tax Payable + - description: Rough lumber + netAmount: -48 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Trim lumber + netAmount: -38 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Window + netAmount: -50 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Flooring + netAmount: -50 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Window + netAmount: -60 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + modifiedDate: '2023-04-26T09:11:56Z' + sourceModifiedDate: '2023-12-16T05:04:21' + recordRef: + id: 2453-1071526256 + dataType: invoices + metadata: + isDeleted: false + - id: '469E-1071530054' + postedOn: '2022-11-30T00:00:00' + createdOn: '2022-11-30T00:00:00' + journalLines: + - description: '' + netAmount: 14488.64 + currency: GBP + accountRef: + id: 40000-933270541 + name: Accounts Receivable + - description: Installation labor + netAmount: -45.5 + currency: GBP + accountRef: + id: 190000-933270541 + name: Labor Income + - description: Install drywall + netAmount: -1320 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Electrical work + netAmount: -1650 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Metal Work + netAmount: -660 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Install insulation + netAmount: -1100 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Plumbing + netAmount: -1650 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Painting + netAmount: -2420 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Install carpeting + netAmount: -3300 + currency: GBP + accountRef: + id: 1C0000-933270542 + name: Subcontracted Labor Income + - description: Custom Bay Window + netAmount: -1925 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Window + netAmount: -115.5 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Equipment Rental + netAmount: -700 + currency: GBP + accountRef: + id: 190000-933270541 + name: Labor Income + - description: 10% retainage to be billed after job is complete and approved. + netAmount: 555.5 + currency: GBP + accountRef: + id: 70000-933270541 + name: Retainage Receivable + - description: 'CA sales tax, San Tomas County' + netAmount: -158.14 + currency: GBP + accountRef: + id: 100000-933270541 + name: Sales Tax Payable + modifiedDate: '2023-04-26T09:11:56Z' + sourceModifiedDate: '2023-12-16T05:05:41' + recordRef: + id: '469E-1071530054' + dataType: invoices + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 140 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journalEntries + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journalEntries?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '1' + postedOn: '2018-09-21T00:00:00' + createdOn: '2018-09-21T00:00:00' + journalLines: + - description: Opening Balance from Bank + netAmount: 170.23 + currency: GBP + accountRef: + id: '61' + name: Dave PP Current + tracking: + recordRefs: [] + - description: '' + netAmount: -170.23 + currency: GBP + accountRef: + id: '53' + name: Retained profit balance forward account + tracking: + recordRefs: [] + modifiedDate: '2023-01-18T11:03:25Z' + sourceModifiedDate: '2018-12-17T14:56:20Z' + - id: '15' + postedOn: '2018-09-21T00:00:00' + createdOn: '2018-09-21T00:00:00' + journalLines: + - description: Payment to Google + netAmount: -1.59 + currency: GBP + accountRef: + id: '61' + name: Dave PP Current + tracking: + recordRefs: [] + - description: Payment to Google + netAmount: 1.59 + currency: GBP + accountRef: + id: '37' + name: Computer equipment accumulated depreciation brought forward + tracking: + recordRefs: [] + modifiedDate: '2023-01-18T11:03:25Z' + sourceModifiedDate: '2018-12-17T14:56:44Z' + recordRef: + id: PUR-15 + dataType: directCosts + pageNumber: 1 + pageSize: 2 + totalResults: 9405 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/journalEntries + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/journalEntries?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '12' + postedOn: '2015-02-23T00:00:00' + createdOn: '2015-02-23T00:00:00' + journalLines: + - description: Opening stock for Guest Book + netAmount: 0 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: 0 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: 250 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: -250 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-12T16:02:02Z' + metadata: + isDeleted: false + - id: '13' + postedOn: '2015-02-23T00:00:00' + createdOn: '2015-02-23T00:00:00' + journalLines: + - description: Opening stock for Name Badges + netAmount: 0 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + - description: Opening stock for Name Badges + netAmount: 0 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Name Badges + netAmount: 7500 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Name Badges + netAmount: -7500 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-12T16:02:04Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 9190 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/journalEntries + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/journalEntries?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '88' + description: Opening Stock + postedOn: '2021-01-01T00:00:00' + createdOn: '2010-04-27T17:16:57' + journalLines: + - description: Opening Stock + netAmount: -40710 + currency: GBP + accountRef: + id: '1001' + name: Stock + - description: Opening Stock + netAmount: 40710 + currency: GBP + accountRef: + id: '5200' + name: Opening Stock + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54' + recordRef: + id: '88' + dataType: journalEntries + metadata: + isDeleted: false + - id: '92' + description: Goods + postedOn: '2021-01-01T00:00:00' + createdOn: '2010-04-27T17:16:57' + journalLines: + - description: Goods/Services - Goods + netAmount: -5875 + currency: GBP + accountRef: + id: '2100' + name: Creditors Control Account + - description: Goods/Services - Goods + netAmount: 5000 + currency: GBP + accountRef: + id: '5000' + name: Materials Purchased + - description: Goods/Services - Goods + netAmount: 875 + currency: GBP + accountRef: + id: '2201' + name: Purchase Tax Control Account + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54' + recordRef: + id: '92' + dataType: bills + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1119 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/journalEntries + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/journalEntries?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: b0489c4b33de11e797950a57719b2edb + postedOn: '2017-05-08T11:08:39' + createdOn: '2017-05-08T11:08:39' + updatedOn: '2017-05-08T11:08:39' + journalLines: + - description: Consulting services + netAmount: 1440 + currency: GBP + accountRef: + id: 9a9931b4267a11e797950a57719b2edb + name: VAT on Sales - Holding Account + - description: Consulting services + netAmount: 7200 + currency: GBP + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + - netAmount: -8640 + currency: GBP + accountRef: + id: 9a991c56267a11e797950a57719b2edb + name: Trade Debtors + modifiedDate: '2022-10-24T15:31:26Z' + sourceModifiedDate: '2017-05-08T11:08:39Z' + - id: c23efa4233de11e797950a57719b2edb + postedOn: '2017-05-08T11:09:09' + createdOn: '2017-05-08T11:09:09' + updatedOn: '2017-05-08T11:09:09' + journalLines: + - netAmount: 1080 + currency: GBP + accountRef: + id: 9a991c56267a11e797950a57719b2edb + name: Trade Debtors + - description: Consulting services + netAmount: -180 + currency: GBP + accountRef: + id: 9a9931b4267a11e797950a57719b2edb + name: VAT on Sales - Holding Account + - description: Consulting services + netAmount: -900 + currency: GBP + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + modifiedDate: '2022-10-24T15:31:26Z' + sourceModifiedDate: '2017-05-08T11:09:09Z' + pageNumber: 1 + pageSize: 2 + totalResults: 24386 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/journalEntries + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/journalEntries?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '262177' + description: 'Invoices - 1100: 2021/04/22 03:44:26:7042 Batch Summary Entry' + postedOn: '2021-04-22T00:00:00' + createdOn: '2021-04-22T10:44:27' + updatedOn: '2021-04-22T10:44:27' + journalRef: + id: '1' + name: Accounts Receivable Journal + journalLines: + - description: '' + netAmount: -100 + currency: GBP + accountRef: + id: '176' + name: Revenue - Services + - description: '' + netAmount: -20 + currency: GBP + accountRef: + id: '306' + name: Sales Tax Payable + - description: '' + netAmount: 120 + currency: GBP + accountRef: + id: '2' + name: Accounts Receivable + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2021-04-22T10:44:27' + metadata: + isDeleted: false + - id: '262179' + description: 'Receipts(Bank-501_CHK) - 1100: April 2021 Batch Summary Entry' + postedOn: '2021-04-30T00:00:00' + createdOn: '2021-04-22T11:01:11' + updatedOn: '2022-04-19T13:38:45' + journalRef: + id: '7' + name: Cash Receipts Journal + journalLines: + - description: '' + netAmount: -120 + currency: GBP + accountRef: + id: '2' + name: Accounts Receivable + - description: '' + netAmount: 120 + currency: GBP + accountRef: + id: '353' + name: Current Account + - description: '' + netAmount: 150 + currency: GBP + accountRef: + id: '353' + name: Current Account + - description: '' + netAmount: -150 + currency: GBP + accountRef: + id: '179' + name: Revenue - Other + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2022-04-19T13:38:45' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 21 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/journalEntries + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/journalEntries?page=2&pageSize=2 + Xero: + value: + results: + - id: 033d79c7-565b-419a-9e1b-33ab58efcf3d + postedOn: '2021-11-19T00:00:00' + createdOn: '2023-02-17T21:07:12' + journalLines: + - description: '' + netAmount: -7267.2 + currency: GBP + accountRef: + id: e0faa299-ca0d-4b0a-9e32-0dfabdf9179a + name: Accounts Payable + - description: Half day training - Microsoft Office + netAmount: 1800 + currency: GBP + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + name: Consulting + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + netAmount: 4000 + currency: GBP + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + - description: Stationery charges + netAmount: 256 + currency: GBP + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + - description: '' + netAmount: 1211.2 + currency: GBP + accountRef: + id: b12f79b9-a082-4b8b-971e-d321292943c7 + name: VAT + modifiedDate: '2023-03-15T20:37:09Z' + sourceModifiedDate: '2023-02-17T21:07:12' + recordRef: + id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + dataType: bills + metadata: + isDeleted: false + - id: 98ac5060-c9ed-4359-bcd5-711e649e7899 + postedOn: '2021-12-20T00:00:00' + createdOn: '2023-02-17T21:07:23' + journalLines: + - description: '' + netAmount: -7267.2 + currency: GBP + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + - description: '' + netAmount: 7267.2 + currency: GBP + accountRef: + id: e0faa299-ca0d-4b0a-9e32-0dfabdf9179a + name: Accounts Payable + modifiedDate: '2023-03-15T20:37:09Z' + sourceModifiedDate: '2023-02-17T21:07:23' + recordRef: + id: 74004690-82a1-4810-aaca-6ce575af94b4 + dataType: billPayments + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 290 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/journalEntries?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/journalEntries + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/journalEntries?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List journal entries* endpoint returns a list of [journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) for a given company's connection.\n\n[Journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-journal-entries + x-speakeasy-group: transactions.journal-entries + '/companies/{companyId}/data/journalEntries/{journalEntryId}': + parameters: + - $ref: '#/components/parameters/companyId' + - name: journalEntryId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a journal entry. + get: + tags: + - Transactions + summary: Get journal entry + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingJournalEntry' + examples: + Clear Books: + value: + id: 770c89bb-3d6a-449a-9243-739378b4cd7d + postedOn: '2022-04-19T00:00:00' + createdOn: '2022-04-19T00:00:00' + journalRef: + id: 90bb7784-083b-4bcb-a534-b30756cee65d + name: General Journal + journalLines: + - description: '' + netAmount: 32095.91 + currency: GBP + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + name: Undeposited Funds + - description: Tax for direct income c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + netAmount: -2917.81 + currency: GBP + accountRef: + id: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + name: VAT + - description: '' + netAmount: -29178.09 + currency: GBP + accountRef: + id: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + modifiedDate: '2023-04-26T12:38:18Z' + recordRef: + id: c31a3778-e3ea-4d01-9281-dd2f291c8cb8 + dataType: directIncomes + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: START + postedOn: '2018-12-31T00:00:00' + createdOn: '2018-12-31T00:00:00' + journalRef: + id: 4caabc3e-3d64-ed11-8c34-000d3a870cba + name: DEFAULT + journalLines: + - description: Opening Entry + netAmount: -69723.14 + currency: GBP + accountRef: + id: ac1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Retained Earnings + - description: Opening Entry + netAmount: -20000 + currency: GBP + accountRef: + id: aa1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Share Capital + - description: Opening Entry + netAmount: -2329.42 + currency: GBP + accountRef: + id: 8a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Payable + - description: Opening Entry + netAmount: 3499 + currency: GBP + accountRef: + id: 6e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accumulated Depreciation + - description: Opening Entry + netAmount: 5498 + currency: GBP + accountRef: + id: 6c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Equipment + - description: Opening Entry + netAmount: 28547.16 + currency: GBP + accountRef: + id: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Inventory + - description: Opening Entry + netAmount: 31638.4 + currency: GBP + accountRef: + id: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Receivable + - description: Opening Entry + netAmount: 2870 + currency: GBP + accountRef: + id: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Accounts Receivable + - description: Opening Entry + netAmount: 20000 + currency: GBP + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + modifiedDate: '2023-03-27T14:21:31Z' + sourceModifiedDate: '2020-07-29T10:56:12Z' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 00002c0a-8061-4ad2-84fa-c879eea880a7 + createdOn: '2022-01-11T14:18:54' + updatedOn: '2022-01-11T14:18:54' + journalRef: + id: 55ff34a3-0857-4202-b7ec-a399cfc26a4e + name: Memoriaal + journalLines: + - description: 1 transactions of type CARD_PAYMENT_FEE_REFUND + netAmount: -6.94 + currency: EUR + accountRef: + id: e0217fbf-8963-4134-80ef-929d5de8612d + name: Kosten 13e maand + tracking: + recordRefs: [] + - description: 1 transactions of type CARD_PAYMENT_FEE_REFUND + netAmount: 6.94 + currency: EUR + accountRef: + id: 0166c96b-adf2-4667-a755-87e67c741f41 + name: Resultaat verkoop activa + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:37:10Z' + sourceModifiedDate: '2022-01-11T14:18:54Z' + Exact (UK): + value: + id: 0008ef00-c5f8-4f97-bce9-5094b2f569dd + createdOn: '2020-07-03T10:51:46' + updatedOn: '2020-07-03T10:51:46' + journalRef: + id: ed5068ff-cb0e-4edd-9777-36ac94a5d6f0 + name: Sales journal + journalLines: + - netAmount: -9.1 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - description: 6 service charges with 0.0% vat + netAmount: -11.21 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 28.0 items with VatPercentage of 0.0 + netAmount: -308.61 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: Gratuity + netAmount: -25.87 + currency: GBP + accountRef: + id: febc52c4-a1ed-4000-b51a-76f9f525445d + name: Salary Control Account + tracking: + recordRefs: [] + - netAmount: -47.14 + currency: GBP + accountRef: + id: 45ae4323-c93b-48b1-8393-db54254e4e6c + name: VAT To Pay + tracking: + recordRefs: [] + - description: 19.0 items with VatPercentage of 20.0 + netAmount: -235.72 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 13.0 items with VatPercentage of 5.0 + netAmount: -182.06 + currency: GBP + accountRef: + id: 43acd218-6a95-445f-994c-660273e0ced9 + name: Sales + tracking: + recordRefs: [] + - description: 1.0 gift cards + netAmount: -1 + currency: GBP + accountRef: + id: febc52c4-a1ed-4000-b51a-76f9f525445d + name: Salary Control Account + tracking: + recordRefs: [] + - netAmount: 820.71 + currency: GBP + accountRef: + id: cf9572e7-8afa-4339-9113-af32a66d9df9 + name: Trade Debtors + tracking: + recordRefs: [] + modifiedDate: '2022-10-26T13:35:45Z' + sourceModifiedDate: '2020-07-03T10:51:46Z' + recordRef: + id: 0008ef00-c5f8-4f97-bce9-5094b2f569dd + dataType: invoices + FreshBooks: + value: + id: '24389149' + postedOn: '1987-10-01T00:00:00' + createdOn: '1987-10-01T00:00:00' + updatedOn: '1987-10-01T00:00:00' + journalLines: + - description: '' + netAmount: 222.88 + currency: GBP + accountRef: + id: '128611' + name: Accounts Receivable + - description: Creative Writing Editorial + netAmount: -222.88 + currency: GBP + accountRef: + id: '128613' + name: Sales + - description: '' + netAmount: 0 + currency: GBP + accountRef: + id: '128613' + name: Sales + modifiedDate: '2023-03-24T16:07:38Z' + sourceModifiedDate: '1987-10-01T00:00:00' + recordRef: + id: '2596455' + dataType: invoices + metadata: + isDeleted: false + Oracle NetSuite: + value: + id: '112' + postedOn: '2021-03-26T00:00:00' + createdOn: '2021-03-26T10:31:05' + updatedOn: '2021-03-26T10:31:06' + journalLines: + - netAmount: -120 + currency: GBP + accountRef: + id: '825' + name: Codat Europe Bank + tracking: + recordRefs: + - id: location-4 + dataType: trackingCategories + - id: '724' + dataType: suppliers + - netAmount: 120 + currency: GBP + accountRef: + id: '111' + name: Accounts Payable + tracking: + recordRefs: + - id: location-4 + dataType: trackingCategories + - id: '724' + dataType: suppliers + modifiedDate: '2023-01-30T14:49:07Z' + sourceModifiedDate: '2021-03-26T10:31:06' + recordRef: + id: '112' + dataType: billPayments + QuickBooks Desktop: + value: + id: 2453-1071526256 + postedOn: '2022-11-28T00:00:00' + createdOn: '2022-11-28T00:00:00' + journalLines: + - description: '' + netAmount: 431.95 + currency: GBP + accountRef: + id: 40000-933270541 + name: Accounts Receivable + - description: Foundation slab - prep and pouring + netAmount: -167.5 + currency: GBP + accountRef: + id: 190000-933270541 + name: Labor Income + - description: 'CA sales tax, San Domingo County' + netAmount: -18.45 + currency: GBP + accountRef: + id: 100000-933270541 + name: Sales Tax Payable + - description: Rough lumber + netAmount: -48 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Trim lumber + netAmount: -38 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Window + netAmount: -50 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Flooring + netAmount: -50 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + - description: Window + netAmount: -60 + currency: GBP + accountRef: + id: 1A0000-933270542 + name: Materials Income + modifiedDate: '2023-04-26T09:11:56Z' + sourceModifiedDate: '2023-12-16T05:04:21' + recordRef: + id: 2453-1071526256 + dataType: invoices + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '1' + postedOn: '2018-09-21T00:00:00' + createdOn: '2018-09-21T00:00:00' + journalLines: + - description: Opening Balance from Bank + netAmount: 170.23 + currency: GBP + accountRef: + id: '61' + name: Dave PP Current + tracking: + recordRefs: [] + - description: '' + netAmount: -170.23 + currency: GBP + accountRef: + id: '53' + name: Retained profit balance forward account + tracking: + recordRefs: [] + modifiedDate: '2023-01-18T11:03:25Z' + sourceModifiedDate: '2018-12-17T14:56:20Z' + QuickBooks Online Sandbox: + value: + id: '12' + postedOn: '2015-02-23T00:00:00' + createdOn: '2015-02-23T00:00:00' + journalLines: + - description: Opening stock for Guest Book + netAmount: 0 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: 0 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: 250 + currency: GBP + accountRef: + id: '65' + name: Stock Asset + tracking: + recordRefs: [] + - description: Opening stock for Guest Book + netAmount: -250 + currency: GBP + accountRef: + id: '55' + name: Opening Balance Equity + tracking: + recordRefs: [] + modifiedDate: '2023-04-26T09:36:42Z' + sourceModifiedDate: '2016-09-12T16:02:02Z' + metadata: + isDeleted: false + Sage 50 (UK): + value: + id: '88' + description: Opening Stock + postedOn: '2021-01-01T00:00:00' + createdOn: '2010-04-27T17:16:57' + journalLines: + - description: Opening Stock + netAmount: -40710 + currency: GBP + accountRef: + id: '1001' + name: Stock + - description: Opening Stock + netAmount: 40710 + currency: GBP + accountRef: + id: '5200' + name: Opening Stock + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54' + recordRef: + id: '88' + dataType: journalEntries + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: b0489c4b33de11e797950a57719b2edb + postedOn: '2017-05-08T11:08:39' + createdOn: '2017-05-08T11:08:39' + updatedOn: '2017-05-08T11:08:39' + journalLines: + - description: Consulting services + netAmount: 1440 + currency: GBP + accountRef: + id: 9a9931b4267a11e797950a57719b2edb + name: VAT on Sales - Holding Account + - description: Consulting services + netAmount: 7200 + currency: GBP + accountRef: + id: 9a994b92267a11e797950a57719b2edb + name: Sales Type A + - netAmount: -8640 + currency: GBP + accountRef: + id: 9a991c56267a11e797950a57719b2edb + name: Trade Debtors + modifiedDate: '2022-10-24T15:31:26Z' + sourceModifiedDate: '2017-05-08T11:08:39Z' + Sage Intacct: + value: + id: '262177' + description: 'Invoices - 1100: 2021/04/22 03:44:26:7042 Batch Summary Entry' + postedOn: '2021-04-22T00:00:00' + createdOn: '2021-04-22T10:44:27' + updatedOn: '2021-04-22T10:44:27' + journalRef: + id: '1' + name: Accounts Receivable Journal + journalLines: + - description: '' + netAmount: -100 + currency: GBP + accountRef: + id: '176' + name: Revenue - Services + - description: '' + netAmount: -20 + currency: GBP + accountRef: + id: '306' + name: Sales Tax Payable + - description: '' + netAmount: 120 + currency: GBP + accountRef: + id: '2' + name: Accounts Receivable + modifiedDate: '2023-04-04T16:31:37Z' + sourceModifiedDate: '2021-04-22T10:44:27' + metadata: + isDeleted: false + Xero: + value: + id: 033d79c7-565b-419a-9e1b-33ab58efcf3d + postedOn: '2021-11-19T00:00:00' + createdOn: '2023-02-17T21:07:12' + journalLines: + - description: '' + netAmount: -7267.2 + currency: GBP + accountRef: + id: e0faa299-ca0d-4b0a-9e32-0dfabdf9179a + name: Accounts Payable + - description: Half day training - Microsoft Office + netAmount: 1800 + currency: GBP + accountRef: + id: 46f9461e-788b-4906-8b74-d1ea17f6dc10 + name: Consulting + - description: Desktop/network support via email & phone.Per month fixed fee for minimum 20 hours/month. + netAmount: 4000 + currency: GBP + accountRef: + id: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + - description: Stationery charges + netAmount: 256 + currency: GBP + accountRef: + id: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + - description: '' + netAmount: 1211.2 + currency: GBP + accountRef: + id: b12f79b9-a082-4b8b-971e-d321292943c7 + name: VAT + modifiedDate: '2023-03-15T20:37:09Z' + sourceModifiedDate: '2023-02-17T21:07:12' + recordRef: + id: 3945273c-cc04-479f-a4b5-1e3dc7a55ed1 + dataType: bills + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get journal entry* endpoint returns a single journal entry for a given journalEntryId. + + [Journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) are made in a company's general ledger, or accounts, when transactions are approved. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-journal-entry + x-speakeasy-group: transactions.journal-entries + '/companies/{companyId}/data/journals': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Transactions + summary: List journals + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingJournals' + examples: + Clear Books: + value: + results: + - id: 90bb7784-083b-4bcb-a534-b30756cee65d + journalCode: GJ + name: General Journal + type: General Journal + hasChildren: true + createdOn: '2021-12-11T13:04:02' + status: Active + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-07-15T20:19:02' + metadata: + isDeleted: false + - id: 07b94827-c0a5-4cc7-ba58-3f9efec3b4b3 + journalCode: PAY + name: Payroll Journal + type: Payroll Journal + parentId: 90bb7784-083b-4bcb-a534-b30756cee65d + hasChildren: false + createdOn: '2021-12-11T13:04:02' + status: Active + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-07-24T14:17:02' + metadata: + isDeleted: false + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2 + pageNumber: 1 + pageSize: 2 + totalResults: 4 + Dynamics 365 Business Central: + value: + results: + - id: 211317b3-89d1-ea11-bbaa-000d3a2b9185 + journalCode: ASSETS + name: ASSETS + type: Assets + hasChildren: true + status: Active + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2023-02-02T10:26:25Z' + metadata: + isDeleted: false + - id: 9a94ef78-92ec-ec11-82f9-000d3a8746a9 + journalCode: BNKDEPOSIT-BNKD + name: BNKD + type: Bank Deposits + parentId: af7d7e6b-e5c8-ec11-8e7e-000d3a86e04a + hasChildren: false + createdOn: '2022-06-15T10:03:59' + status: Active + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2022-06-15T22:45:30Z' + metadata: + isDeleted: false + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2 + pageNumber: 1 + pageSize: 2 + totalResults: 46 + Exact (Netherlands): + value: + results: + - id: aae31284-e23d-456b-9957-fbf4bcef6c19 + journalCode: '21' + name: '12345678' + type: Bank + hasChildren: false + createdOn: '2019-11-05T14:44:51' + status: Active + modifiedDate: '2022-10-26T13:31:58Z' + sourceModifiedDate: '2020-01-24T11:41:25Z' + - id: 74677165-1bd3-49b4-87d0-32d974674f86 + journalCode: '23' + name: Abraham's Billion Dollar stuff + type: Bank + hasChildren: false + createdOn: '2019-11-22T13:35:57' + status: Active + modifiedDate: '2022-10-26T13:31:58Z' + sourceModifiedDate: '2019-11-22T13:35:57Z' + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2 + pageNumber: 1 + pageSize: 2 + totalResults: 47 + Exact (UK): + value: + results: + - id: 05b9febe-34b3-4836-8277-002294b233a9 + journalCode: '25' + name: annaBankAccount1 + type: Bank + hasChildren: false + createdOn: '2021-04-26T16:44:47' + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2021-04-26T16:44:47Z' + - id: b9c3d6a6-4ce2-4714-9ff6-fb15892300f7 + journalCode: '31' + name: annaBankAccount10 + type: Bank + hasChildren: false + createdOn: '2021-05-18T10:24:18' + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2021-05-18T10:24:18Z' + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2 + pageNumber: 1 + pageSize: 2 + totalResults: 21 + Sage Intacct: + value: + results: + - id: '207' + journalCode: AJPT + name: A Journal Push Test + type: '' + hasChildren: false + createdOn: '2022-01-17T10:44:23' + status: Active + modifiedDate: '2023-04-04T16:31:30Z' + sourceModifiedDate: '2022-01-17T10:44:23' + metadata: + isDeleted: false + - id: '223' + journalCode: AJPT2 + name: A Journal Push Test 2 + type: '' + hasChildren: false + createdOn: '2022-01-18T15:39:07' + status: Active + modifiedDate: '2023-04-04T16:31:30Z' + sourceModifiedDate: '2022-01-18T15:39:07' + metadata: + isDeleted: false + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/journals?page=2&pageSize=2 + pageNumber: 1 + pageSize: 2 + totalResults: 1211 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List journals* endpoint returns a list of [journals](https://docs.codat.io/lending-api#/schemas/Journal) for a given company's connection.\n\n[Journals](https://docs.codat.io/lending-api#/schemas/Journal) are used to record all the financial transactions of a company.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-journals + x-speakeasy-group: transactions.journals + '/companies/{companyId}/data/journals/{journalId}': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Transactions + summary: Get journal + parameters: + - name: journalId + in: path + required: true + schema: + type: string + description: Unique identifier for a journal. + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingJournal' + examples: + Clear Books: + value: + id: 90bb7784-083b-4bcb-a534-b30756cee65d + journalCode: GJ + name: General Journal + type: General Journal + hasChildren: true + createdOn: '2021-12-11T13:04:02' + status: Active + modifiedDate: '2023-04-26T12:38:18Z' + sourceModifiedDate: '2022-07-15T20:19:02' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 211317b3-89d1-ea11-bbaa-000d3a2b9185 + journalCode: ASSETS + name: ASSETS + type: Assets + hasChildren: true + status: Active + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2023-02-02T10:26:25Z' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: aae31284-e23d-456b-9957-fbf4bcef6c19 + journalCode: '21' + name: '12345678' + type: Bank + hasChildren: false + createdOn: '2019-11-05T14:44:51' + status: Active + modifiedDate: '2022-10-26T13:31:58Z' + sourceModifiedDate: '2020-01-24T11:41:25Z' + Exact (UK): + value: + id: 05b9febe-34b3-4836-8277-002294b233a9 + journalCode: '25' + name: annaBankAccount1 + type: Bank + hasChildren: false + createdOn: '2021-04-26T16:44:47' + status: Active + modifiedDate: '2022-10-26T13:33:08Z' + sourceModifiedDate: '2021-04-26T16:44:47Z' + Sage Intacct: + value: + id: '207' + journalCode: AJPT + name: A Journal Push Test + type: '' + hasChildren: false + createdOn: '2022-01-17T10:44:23' + status: Active + modifiedDate: '2023-04-04T16:31:30Z' + sourceModifiedDate: '2022-01-17T10:44:23' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get journal* endpoint returns a single journal for a given journalId. + + [Journals](https://docs.codat.io/lending-api#/schemas/Journal) are used to record all the financial transactions of a company. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-journal + x-speakeasy-group: transactions.journals + '/companies/{companyId}/data/payments': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + summary: List payments + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingPayments' + examples: + Clear Books: + value: + results: + - id: 7ba4fc1b-e248-49ba-8bf8-0813d7f203a8 + customerRef: + id: a82042f1-a005-4ca5-bfd3-5bc237123aa5 + companyName: Keara Leffler + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + totalAmount: 3669.52 + currency: GBP + currencyRate: 1 + date: '2022-04-25T13:04:02' + note: Payment against invoice ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + lines: + - amount: 3669.52 + links: + - type: Invoice + id: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + amount: -3669.52 + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-04-25T13:04:02' + reference: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + metadata: + isDeleted: false + - id: 9407d5ee-893a-4547-bd89-bc7b795ee774 + customerRef: + id: d65ac505-072c-49ec-be3c-3cb74228966d + companyName: Jensen Steuber + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + paymentMethodRef: + id: 8db2de81-0db4-46ee-b7f9-c711a7e89a01 + name: Cash payments-IHz + totalAmount: 1772.72 + currency: GBP + currencyRate: 1 + date: '2022-04-25T13:04:02' + note: Payment against invoice 2518ca08-5e2a-4630-8cee-a6bcd1625660 + lines: + - amount: 1772.72 + links: + - type: Invoice + id: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + amount: -1772.72 + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-04-25T13:04:02' + reference: 2518ca08-5e2a-4630-8cee-a6bcd1625660 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 200 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/payments?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/payments + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/payments?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: e0299ced-89d1-ea11-bbaa-000d3a2b9185 + customerRef: + id: b61217b3-89d1-ea11-bbaa-000d3a2b9185 + companyName: Trey Researches + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 128.16 + currency: GBP + currencyRate: 1 + date: '2019-01-15T00:00:00' + note: Invoice 102001 + lines: + - amount: 128.16 + links: + - type: Invoice + id: 18c906bf-89d1-ea11-bbaa-000d3a2b9185 + amount: -128.16 + currencyRate: 1 + allocatedOnDate: '2019-01-15T00:00:00' + modifiedDate: '2023-03-27T14:21:27Z' + sourceModifiedDate: '0001-01-01T00:00:00Z' + reference: 'Document No: 103001' + metadata: + isDeleted: false + - id: 042a9ced-89d1-ea11-bbaa-000d3a2b9185 + customerRef: + id: b41217b3-89d1-ea11-bbaa-000d3a2b9185 + companyName: Adatum Corporation + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 600.48 + currency: GBP + currencyRate: 1 + date: '2019-01-16T00:00:00' + note: Invoice 102002 + lines: + - amount: 600.48 + links: + - type: Invoice + id: 1bc906bf-89d1-ea11-bbaa-000d3a2b9185 + amount: -600.48 + currencyRate: 1 + allocatedOnDate: '2019-01-16T00:00:00' + modifiedDate: '2023-03-27T14:21:27Z' + sourceModifiedDate: '0001-01-01T00:00:00Z' + reference: 'Document No: 103002' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 249 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/payments?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/payments + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/payments?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 090f5d9f-d1ce-4a61-985f-d3915618b64a_c3bf08a3-4d51-4859-acbb-5075f9484f87 + customerRef: + id: c3bf08a3-4d51-4859-acbb-5075f9484f87 + companyName: Mr Abe + accountRef: + id: 35717508-0696-4481-a32c-2835f0ed8b4e + name: Test GL account 2 + totalAmount: 229.08 + currency: EUR + currencyRate: 1 + date: '2019-11-26T00:00:00Z' + lines: + - amount: 229.08 + links: + - type: Invoice + id: f010d4df-13ea-45d1-8525-785164df7dd9 + amount: -229.08 + currencyRate: 1 + modifiedDate: '2022-10-26T13:36:13Z' + sourceModifiedDate: '2019-11-26T12:31:46Z' + reference: '19230011' + - id: 1650bb9c-5d9a-40f2-9015-0e251a12f861_c3bf08a3-4d51-4859-acbb-5075f9484f87 + customerRef: + id: c3bf08a3-4d51-4859-acbb-5075f9484f87 + companyName: Mr Abe + accountRef: + id: 35717508-0696-4481-a32c-2835f0ed8b4e + name: Test GL account 2 + totalAmount: 991.56 + currency: EUR + currencyRate: 1 + date: '2019-11-26T00:00:00Z' + lines: + - amount: 991.56 + links: + - type: Invoice + id: 013f05e6-2583-4e6d-8309-a479808cf7bf + amount: -991.56 + currencyRate: 1 + modifiedDate: '2022-10-26T13:36:13Z' + sourceModifiedDate: '2019-11-26T12:31:12Z' + reference: '19230010' + pageNumber: 1 + pageSize: 2 + totalResults: 46 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/payments?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/payments + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/payments?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 14b7d656-07ee-4d70-aafa-61c0030c08ad_7e566728-a7f3-4860-a7f5-381664673287 + customerRef: + id: 7e566728-a7f3-4860-a7f5-381664673287 + companyName: Customer A + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 1 + currency: GBP + currencyRate: 1 + date: '2020-01-02T00:00:00Z' + lines: + - amount: 1 + links: + - type: Invoice + id: 6220ed43-1fec-4e17-a88f-c7ee5b949e76 + amount: -1 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:14Z' + sourceModifiedDate: '2020-01-02T10:08:27Z' + reference: '20200002' + - id: d8b093cf-3d37-405b-9e85-72552226553f_7e566728-a7f3-4860-a7f5-381664673287 + customerRef: + id: 7e566728-a7f3-4860-a7f5-381664673287 + companyName: Customer A + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 1 + currency: GBP + currencyRate: 1 + date: '2020-01-02T00:00:00Z' + lines: + - amount: 1 + links: + - type: Invoice + id: 6220ed43-1fec-4e17-a88f-c7ee5b949e76 + amount: -1 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:14Z' + sourceModifiedDate: '2020-01-02T09:58:15Z' + reference: '20200001' + pageNumber: 1 + pageSize: 2 + totalResults: 5 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/payments?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/payments + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/payments?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '135234099' + customerRef: + id: '6162049' + companyName: Wintershall Holding GmbH + totalAmount: 100 + currency: GBP + date: '2017-11-23T00:00:00' + note: 'CODAT LTD ref: NOV TOPUP OTHER �100.00 - Invoice receipt against 015' + lines: + - amount: 100 + links: + - type: Invoice + id: '21973931' + amount: -100 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:37Z' + metadata: + isDeleted: false + - id: '135258250' + customerRef: + id: '6162230' + companyName: Stronachs LLP + totalAmount: 100 + currency: GBP + date: '2017-11-23T00:00:00' + note: 'CODAT LTD ref: NOV TOPUP OTHER �100.00 - Invoice receipt against 006' + lines: + - amount: 100 + links: + - type: Invoice + id: '21952246' + amount: -100 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:37Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 1146 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/payments?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/payments + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/payments?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: '765831' + customerRef: + id: '113070' + totalAmount: 1 + currency: GBP + date: '2018-09-11T00:00:00' + note: 'Overpayment: invoice #0000003, some test' + lines: + - amount: 1 + links: + - type: PaymentOnAccount + id: '113070' + amount: -1 + currencyRate: 1 + modifiedDate: '2023-03-24T16:07:24Z' + sourceModifiedDate: '2018-09-11T06:58:46' + metadata: + isDeleted: false + - id: '988600' + customerRef: + id: '380630' + totalAmount: 5 + currency: GBP + date: '2019-01-21T00:00:00' + note: 'Overpayment: invoice #0000007' + lines: + - amount: 5 + links: + - type: PaymentOnAccount + id: '380630' + amount: -5 + currencyRate: 1 + modifiedDate: '2023-03-24T16:07:24Z' + sourceModifiedDate: '2019-01-21T10:23:59' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 239 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/payments?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/payments + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/payments?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '139214921' + customerRef: + id: '85743294' + companyName: Parent customer + totalAmount: 1.2 + currency: GBP + date: '2010-04-07T00:00:00' + note: '' + lines: + - amount: 1.2 + links: + - type: Invoice + id: '137055108' + amount: -1.2 + currencyRate: 1 + modifiedDate: '2022-09-30T10:29:15Z' + - id: '86861497' + customerRef: + id: '69946501' + companyName: Peter Lord + totalAmount: 10 + currency: GBP + date: '2017-05-01T00:00:00' + note: '' + lines: + - amount: 10 + links: + - type: Invoice + id: '85315064' + amount: -10 + currencyRate: 1 + modifiedDate: '2022-09-30T10:29:15Z' + pageNumber: 1 + pageSize: 2 + totalResults: 74 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/payments?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/payments + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/payments?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '8828' + customerRef: + id: '417' + companyName: 10 Breww Ltd + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2021-04-09T00:00:00' + lines: + - amount: 0 + links: + - type: Invoice + id: '8530' + amount: -16 + currencyRate: 1 + - type: CreditNote + id: '8828' + amount: 16 + currencyRate: 1 + modifiedDate: '2022-09-20T08:18:33Z' + sourceModifiedDate: '2022-02-25T10:58:37' + reference: 'Credit Memo #CM28' + - id: '428' + customerRef: + id: '417' + companyName: 10 Breww Ltd + accountRef: + id: '122' + name: Undeposited Funds + totalAmount: 90 + currency: GBP + currencyRate: 1 + date: '2021-04-20T00:00:00' + lines: + - amount: 90 + links: + - type: Invoice + id: '416' + amount: -90 + currencyRate: 1 + - amount: 10 + links: + - type: Invoice + id: '416' + amount: -10 + currencyRate: 1 + - amount: -10 + links: + - type: Other + id: '428' + amount: 10 + currencyRate: 1 + modifiedDate: '2022-09-20T08:18:33Z' + sourceModifiedDate: '2022-04-28T13:36:54' + reference: 'Payment #PYMT01' + pageNumber: 1 + pageSize: 2 + totalResults: 113 + _links: + current: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/payments?page=1&pageSize=2 + self: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/payments + next: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/data/payments?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 6915-1197775450 + customerRef: + id: 220000-933272658 + companyName: 'Melton, Johnny' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + totalAmount: 14488.64 + currency: GBP + currencyRate: 1 + date: '2023-01-10T00:00:00' + note: Check - 80000-933270541 + lines: + - amount: 14488.64 + links: + - type: Invoice + id: '469E-1071530054' + amount: -14488.64 + currencyRate: 1 + modifiedDate: '2023-04-26T09:08:36Z' + sourceModifiedDate: '2023-12-16T05:06:11' + reference: '19650' + metadata: + isDeleted: false + - id: 6973-1197775625 + customerRef: + id: 420000-1071522044 + companyName: 'Prentice, Adelaide' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + totalAmount: 431.95 + currency: GBP + currencyRate: 1 + date: '2023-01-15T00:00:00' + note: Check - 80000-933270541 + lines: + - amount: 431.95 + links: + - type: Invoice + id: 2453-1071526256 + amount: -431.95 + currencyRate: 1 + modifiedDate: '2023-04-26T09:08:36Z' + sourceModifiedDate: '2023-12-16T05:06:11' + reference: '983409' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 108 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/payments?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/payments + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/payments?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '710' + customerRef: + id: '9' + companyName: Abe + accountRef: + id: '56' + name: Undeposited Funds + totalAmount: 95.2 + currency: GBP + currencyRate: 1 + date: '2018-10-05T00:00:00' + note: Sarah's Test + lines: + - amount: 95.2 + links: + - type: Invoice + id: '688' + amount: -95.2 + currencyRate: 1 + modifiedDate: '2023-01-18T11:03:14Z' + sourceModifiedDate: '2020-08-14T09:59:29Z' + - id: '9298' + customerRef: + id: '9' + companyName: Abe + accountRef: + id: '56' + name: Undeposited Funds + totalAmount: 95.2 + currency: GBP + currencyRate: 1 + date: '2018-10-05T00:00:00' + note: Adeel Test + lines: + - amount: 95.2 + links: + - type: PaymentOnAccount + id: '9' + amount: -95.2 + currencyRate: 1 + modifiedDate: '2023-01-18T11:03:18Z' + sourceModifiedDate: '2022-06-20T13:51:36Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3723 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/payments?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/payments + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/payments?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '25' + customerRef: + id: '55' + companyName: Oxon Insurance - Holiday Party + accountRef: + id: '81' + name: Current + totalAmount: 10800 + currency: GBP + currencyRate: 1 + date: '2016-02-12T00:00:00' + note: '' + lines: + - amount: 10800 + links: + - type: PaymentOnAccount + id: '55' + amount: -10800 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:50Z' + sourceModifiedDate: '2022-02-03T12:09:35Z' + metadata: + isDeleted: false + - id: '31' + customerRef: + id: '59' + companyName: Ecker Holiday event + accountRef: + id: '81' + name: Current + totalAmount: 15615 + currency: GBP + currencyRate: 1 + date: '2016-02-12T00:00:00' + note: '' + lines: + - amount: 15615 + links: + - type: Invoice + id: '30' + amount: -15615 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:50Z' + sourceModifiedDate: '2016-09-12T16:50:17Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 813 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/payments?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/payments + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/payments?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '29684' + customerRef: + id: STE001 + companyName: Stevenson & Smith + totalAmount: 500 + currency: GBP + currencyRate: 1 + date: '2019-01-30T00:00:00Z' + note: Payment on Account + lines: + - amount: 12.5 + links: + - type: Invoice + id: '29676' + amount: -12.5 + currencyRate: 1 + - amount: 487.5 + links: + - type: Invoice + id: '29851' + amount: -487.5 + currencyRate: 1 + modifiedDate: '2022-10-14T09:36:05Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: '5897532' + - id: '29681' + customerRef: + id: MAC001 + companyName: Macolm Hall Associates + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2019-12-31T00:00:00Z' + note: Opening Balance + lines: + - amount: 0 + links: + - type: Invoice + id: '29745' + amount: 0.05 + currencyRate: 1 + - type: CreditNote + id: '29681' + amount: -0.05 + currencyRate: 1 + modifiedDate: '2022-10-14T09:36:05Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: O/BAL + pageNumber: 1 + pageSize: 2 + totalResults: 83 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/payments?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/payments + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/payments?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '53' + customerRef: + id: STE001 + companyName: Stevenson & Smith + accountRef: + id: '1200' + name: Bank Current Account + totalAmount: 500 + currency: GBP + currencyRate: 1 + date: '2021-01-30T00:00:00' + note: 'Sales receipt on account 53 linked to sales invoice tx-3, sales invoice inv-31.' + lines: + - amount: 12.5 + links: + - type: Invoice + id: TX-3 + amount: -12.5 + currencyRate: 1 + - amount: 245.34 + links: + - type: Invoice + id: INV-31 + amount: -245.34 + currencyRate: 1 + - amount: 126.9 + links: + - type: Invoice + id: INV-31 + amount: -126.9 + currencyRate: 1 + - amount: 115.26 + links: + - type: Invoice + id: INV-31 + amount: -115.26 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:39Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + - id: '8' + customerRef: + id: MAC001 + companyName: Macolm Hall Associates + accountRef: + id: '' + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2021-12-31T00:00:00' + note: Sales credit tx-8 linked to sales invoice inv-10. + lines: + - amount: 0 + links: + - type: Invoice + id: INV-10 + amount: -0.05 + currencyRate: 1 + - type: CreditNote + id: TX-8 + amount: 0.05 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:39Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 53 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/payments?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/payments + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/payments?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: d39f7a5733de11e797950a57719b2edb + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + totalAmount: -1080 + currency: GBP + currencyRate: 1 + date: '2017-05-08T00:00:00' + note: Customer refund using credit/debit card + lines: + - amount: -1080 + links: + - type: CreditNote + id: c1a0176c33de11e797950a57719b2edb + amount: 1080 + currencyRate: 1 + modifiedDate: '2022-10-24T14:55:39Z' + sourceModifiedDate: '2017-05-08T11:09:38Z' + - id: 03a5fdc8baa643fb97587033b0c4590b + customerRef: + id: 3cc3148bbd8111e8bad90617b3da4b8a + companyName: John's Test Customer + accountRef: + id: 2572c8766afc11e8aaa5027d54329956 + name: Tide Current + totalAmount: 100 + currency: GBP + currencyRate: 1 + date: '2017-11-23T00:00:00' + note: Customer receipt using credit/debit card + lines: + - amount: 100 + links: + - type: Invoice + id: ede1e735bd8111e8bad90617b3da4b8a + amount: -100 + currencyRate: 1 + modifiedDate: '2022-10-24T14:55:39Z' + sourceModifiedDate: '2019-01-17T14:14:55Z' + pageNumber: 1 + pageSize: 2 + totalResults: 2321 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/payments?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/payments + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/payments?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '2918' + customerRef: + id: '12' + companyName: MK Manufacturing + accountRef: + id: '353' + name: Current Account + paymentMethodRef: + id: '1' + name: Printed Check + totalAmount: 120 + currency: GBP + date: '2021-04-22T00:00:00' + note: '' + lines: + - amount: 120 + links: + - type: Invoice + id: '2916' + amount: -120 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:02Z' + sourceModifiedDate: '2021-04-22T11:01:11Z' + metadata: + isDeleted: false + - id: '6105' + customerRef: + id: '531' + companyName: Shoprite + accountRef: + id: '353' + name: Current Account + paymentMethodRef: + id: '6' + name: Cash + totalAmount: 150 + currency: GBP + date: '2022-04-19T00:00:00' + note: '' + lines: + - amount: 150 + links: + - type: PaymentOnAccount + id: '531' + amount: -150 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:02Z' + sourceModifiedDate: '2022-04-19T13:38:45Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/payments?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/payments + Xero: + value: + results: + - id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + customerRef: + id: afd4093b-c655-4847-8ee2-10a4f2c3eae3 + companyName: Maddox Publishing Group + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 4200 + currency: GBP + currencyRate: 1 + date: '2022-02-17T00:00:00' + lines: + - amount: 4200 + links: + - type: Invoice + id: 321bfed3-2da2-4969-9358-4de97821181b + amount: -4200 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:08Z' + sourceModifiedDate: '2021-01-02T22:50:58' + metadata: + isDeleted: false + - id: 8c481b70-b5d7-4de4-a7f7-9e161be2c472 + customerRef: + id: a871a956-05b5-4e2a-9419-7aeb478ca647 + companyName: Ridgeway University + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 500 + currency: GBP + currencyRate: 1 + date: '2022-02-17T00:00:00' + lines: + - amount: 500 + links: + - type: Invoice + id: 4b6d0c8f-10fa-42cd-a6e5-53b175e90005 + amount: -500 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:08Z' + sourceModifiedDate: '2021-01-02T22:51:43' + reference: '' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 30 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/payments?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/payments + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/payments?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000000070175' + customerRef: + id: '104957000000037097' + companyName: Test Company + accountRef: + id: '104957000000060010' + name: Abdi Test + totalAmount: 9001 + currency: GBP + currencyRate: 1 + date: '2020-02-06T00:00:00' + note: Cheque deposit + lines: + - amount: 9001 + links: + - type: Invoice + id: '104957000000038052' + amount: -9001 + currencyRate: 1 + modifiedDate: '2022-10-03T08:41:17Z' + reference: '4' + - id: '104957000000067014' + customerRef: + id: '104957000000037097' + companyName: Test Company + accountRef: + id: '104957000000060010' + name: Abdi Test + totalAmount: 9001 + currency: GBP + currencyRate: 1 + date: '2020-02-14T00:00:00' + note: '' + lines: + - amount: 9001 + links: + - type: Invoice + id: '104957000000038106' + amount: -9001 + currencyRate: 1 + modifiedDate: '2022-10-03T08:41:17Z' + reference: '1' + pageNumber: 1 + pageSize: 2 + totalResults: 33 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/payments?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/payments + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/payments?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List payments* endpoint returns a list of [payments](https://docs.codat.io/lending-api#/schemas/Payment) for a given company's connection.\n\n[Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-payments + x-speakeasy-group: accounts-receivable.payments + '/companies/{companyId}/data/payments/{paymentId}': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/paymentId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingPayment' + examples: + Clear Books: + value: + id: 7ba4fc1b-e248-49ba-8bf8-0813d7f203a8 + customerRef: + id: a82042f1-a005-4ca5-bfd3-5bc237123aa5 + companyName: Keara Leffler + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + totalAmount: 3669.52 + currency: GBP + currencyRate: 1 + date: '2022-04-25T13:04:02' + note: Payment against invoice ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + lines: + - amount: 3669.52 + links: + - type: Invoice + id: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + amount: -3669.52 + currencyRate: 1 + allocatedOnDate: '2022-04-25T13:04:02' + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '2022-04-25T13:04:02' + reference: ac3ac4dd-defe-4f9c-b7bb-2c3fe726a9d1 + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: e0299ced-89d1-ea11-bbaa-000d3a2b9185 + customerRef: + id: b61217b3-89d1-ea11-bbaa-000d3a2b9185 + companyName: Trey Researches + accountRef: + id: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: Petty Cash + totalAmount: 128.16 + currency: GBP + currencyRate: 1 + date: '2019-01-15T00:00:00' + note: Invoice 102001 + lines: + - amount: 128.16 + links: + - type: Invoice + id: 18c906bf-89d1-ea11-bbaa-000d3a2b9185 + amount: -128.16 + currencyRate: 1 + allocatedOnDate: '2019-01-15T00:00:00' + modifiedDate: '2023-03-27T14:21:27Z' + sourceModifiedDate: '0001-01-01T00:00:00Z' + reference: 'Document No: 103001' + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 090f5d9f-d1ce-4a61-985f-d3915618b64a_c3bf08a3-4d51-4859-acbb-5075f9484f87 + customerRef: + id: c3bf08a3-4d51-4859-acbb-5075f9484f87 + companyName: Mr Abe + accountRef: + id: 35717508-0696-4481-a32c-2835f0ed8b4e + name: Test GL account 2 + totalAmount: 229.08 + currency: EUR + currencyRate: 1 + date: '2019-11-26T00:00:00Z' + lines: + - amount: 229.08 + links: + - type: Invoice + id: f010d4df-13ea-45d1-8525-785164df7dd9 + amount: -229.08 + currencyRate: 1 + modifiedDate: '2022-10-26T13:36:13Z' + sourceModifiedDate: '2019-11-26T12:31:46Z' + reference: '19230011' + Exact (UK): + value: + id: 14b7d656-07ee-4d70-aafa-61c0030c08ad_7e566728-a7f3-4860-a7f5-381664673287 + customerRef: + id: 7e566728-a7f3-4860-a7f5-381664673287 + companyName: Customer A + accountRef: + id: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: Bank + totalAmount: 1 + currency: GBP + currencyRate: 1 + date: '2020-01-02T00:00:00Z' + lines: + - amount: 1 + links: + - type: Invoice + id: 6220ed43-1fec-4e17-a88f-c7ee5b949e76 + amount: -1 + currencyRate: 1 + modifiedDate: '2022-10-26T13:35:14Z' + sourceModifiedDate: '2020-01-02T10:08:27Z' + reference: '20200002' + FreeAgent: + value: + id: '135234099' + customerRef: + id: '6162049' + companyName: Wintershall Holding GmbH + totalAmount: 100 + currency: GBP + date: '2017-11-23T00:00:00' + note: 'CODAT LTD ref: NOV TOPUP OTHER �100.00 - Invoice receipt against 015' + lines: + - amount: 100 + links: + - type: Invoice + id: '21973931' + amount: -100 + currencyRate: 1 + modifiedDate: '2023-04-25T14:21:37Z' + metadata: + isDeleted: false + FreshBooks: + value: + id: '765831' + customerRef: + id: '113070' + totalAmount: 1 + currency: GBP + date: '2018-09-11T00:00:00' + note: 'Overpayment: invoice #0000003, some test' + lines: + - amount: 1 + links: + - type: PaymentOnAccount + id: '113070' + amount: -1 + currencyRate: 1 + modifiedDate: '2023-03-24T16:07:24Z' + sourceModifiedDate: '2018-09-11T06:58:46' + metadata: + isDeleted: false + KashFlow: + value: + id: '139214921' + customerRef: + id: '85743294' + companyName: Parent customer + totalAmount: 1.2 + currency: GBP + date: '2010-04-07T00:00:00' + note: '' + lines: + - amount: 1.2 + links: + - type: Invoice + id: '137055108' + amount: -1.2 + currencyRate: 1 + modifiedDate: '2022-09-30T10:29:15Z' + Oracle NetSuite: + value: + id: '8828' + customerRef: + id: '417' + companyName: 10 Breww Ltd + totalAmount: 0 + currency: GBP + currencyRate: 1 + date: '2021-04-09T00:00:00' + lines: + - amount: 0 + links: + - type: Invoice + id: '8530' + amount: -16 + currencyRate: 1 + - type: CreditNote + id: '8828' + amount: 16 + currencyRate: 1 + modifiedDate: '2022-09-20T08:18:33Z' + sourceModifiedDate: '2022-02-25T10:58:37' + reference: 'Credit Memo #CM28' + QuickBooks Desktop: + value: + id: 6915-1197775450 + customerRef: + id: 220000-933272658 + companyName: 'Melton, Johnny' + accountRef: + id: 80000-933270541 + name: Undeposited Funds + totalAmount: 14488.64 + currency: GBP + currencyRate: 1 + date: '2023-01-10T00:00:00' + note: Check - 80000-933270541 + lines: + - amount: 14488.64 + links: + - type: Invoice + id: '469E-1071530054' + amount: -14488.64 + currencyRate: 1 + modifiedDate: '2023-04-26T09:08:36Z' + sourceModifiedDate: '2023-12-16T05:06:11' + reference: '19650' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '710' + customerRef: + id: '9' + companyName: Abe + accountRef: + id: '56' + name: Undeposited Funds + totalAmount: 95.2 + currency: GBP + currencyRate: 1 + date: '2018-10-05T00:00:00' + note: Sarah's Test + lines: + - amount: 95.2 + links: + - type: Invoice + id: '688' + amount: -95.2 + currencyRate: 1 + modifiedDate: '2023-01-18T11:03:14Z' + sourceModifiedDate: '2020-08-14T09:59:29Z' + QuickBooks Online Sandbox: + value: + id: '25' + customerRef: + id: '55' + companyName: Oxon Insurance - Holiday Party + accountRef: + id: '81' + name: Current + totalAmount: 10800 + currency: GBP + currencyRate: 1 + date: '2016-02-12T00:00:00' + note: '' + lines: + - amount: 10800 + links: + - type: PaymentOnAccount + id: '55' + amount: -10800 + currencyRate: 1 + modifiedDate: '2023-04-26T09:36:50Z' + sourceModifiedDate: '2022-02-03T12:09:35Z' + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '29684' + customerRef: + id: STE001 + companyName: Stevenson & Smith + totalAmount: 500 + currency: GBP + currencyRate: 1 + date: '2019-01-30T00:00:00Z' + note: Payment on Account + lines: + - amount: 12.5 + links: + - type: Invoice + id: '29676' + amount: -12.5 + currencyRate: 1 + - amount: 487.5 + links: + - type: Invoice + id: '29851' + amount: -487.5 + currencyRate: 1 + modifiedDate: '2022-10-14T09:36:05Z' + sourceModifiedDate: '2020-02-28T14:23:46Z' + reference: '5897532' + Sage 50 (UK): + value: + id: '53' + customerRef: + id: STE001 + companyName: Stevenson & Smith + accountRef: + id: '1200' + name: Bank Current Account + totalAmount: 500 + currency: GBP + currencyRate: 1 + date: '2021-01-30T00:00:00' + note: 'Sales receipt on account 53 linked to sales invoice tx-3, sales invoice inv-31.' + lines: + - amount: 12.5 + links: + - type: Invoice + id: TX-3 + amount: -12.5 + currencyRate: 1 + - amount: 245.34 + links: + - type: Invoice + id: INV-31 + amount: -245.34 + currencyRate: 1 + - amount: 126.9 + links: + - type: Invoice + id: INV-31 + amount: -126.9 + currencyRate: 1 + - amount: 115.26 + links: + - type: Invoice + id: INV-31 + amount: -115.26 + currencyRate: 1 + modifiedDate: '2023-03-30T14:42:39Z' + sourceModifiedDate: '2022-11-25T09:43:54' + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: d39f7a5733de11e797950a57719b2edb + customerRef: + id: f4ff85ba33dd11e797950a57719b2edb + companyName: Widgets Limited + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + totalAmount: -1080 + currency: GBP + currencyRate: 1 + date: '2017-05-08T00:00:00' + note: Customer refund using credit/debit card + lines: + - amount: -1080 + links: + - type: CreditNote + id: c1a0176c33de11e797950a57719b2edb + amount: 1080 + currencyRate: 1 + modifiedDate: '2022-10-24T14:55:39Z' + sourceModifiedDate: '2017-05-08T11:09:38Z' + Sage Intacct: + value: + id: '2918' + customerRef: + id: '12' + companyName: MK Manufacturing + accountRef: + id: '353' + name: Current Account + paymentMethodRef: + id: '1' + name: Printed Check + totalAmount: 120 + currency: GBP + date: '2021-04-22T00:00:00' + note: '' + lines: + - amount: 120 + links: + - type: Invoice + id: '2916' + amount: -120 + currencyRate: 1 + modifiedDate: '2023-04-04T16:32:02Z' + sourceModifiedDate: '2021-04-22T11:01:11Z' + metadata: + isDeleted: false + Xero: + value: + id: 65b746c8-9a5d-4a95-8096-d2316fcff592 + customerRef: + id: afd4093b-c655-4847-8ee2-10a4f2c3eae3 + companyName: Maddox Publishing Group + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + totalAmount: 4200 + currency: GBP + currencyRate: 1 + date: '2022-02-17T00:00:00' + lines: + - amount: 4200 + links: + - type: Invoice + id: 321bfed3-2da2-4969-9358-4de97821181b + amount: -4200 + currencyRate: 1 + modifiedDate: '2023-03-15T20:37:08Z' + sourceModifiedDate: '2021-01-02T22:50:58' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000070175' + customerRef: + id: '104957000000037097' + companyName: Test Company + accountRef: + id: '104957000000060010' + name: Abdi Test + totalAmount: 9001 + currency: GBP + currencyRate: 1 + date: '2020-02-06T00:00:00' + note: Cheque deposit + lines: + - amount: 9001 + links: + - type: Invoice + id: '104957000000038052' + amount: -9001 + currencyRate: 1 + modifiedDate: '2022-10-03T08:41:17Z' + reference: '4' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get payment + description: | + The *Get payment* endpoint returns a single payment for a given paymentId. + + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-payment + x-speakeasy-group: accounts-receivable.payments + '/companies/{companyId}/data/suppliers': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + summary: List suppliers + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingSuppliers' + examples: + Clear Books: + value: + results: + - id: owQ2Gqgj9f + supplierName: Abshire - Kshlerin + contactName: Faye Hansen + emailAddress: hello@Abshire-Kshlerin.info + phone: 01338 858162 + addresses: + - type: Delivery + line1: Suite 431 + line2: 289 Giles Lake + city: Cesarmouth + region: Northern Ireland + country: United Kingdom + postalCode: BG40 9GP + registrationNumber: VYL1XZXR + taxNumber: '1396267523.0914588' + status: Active + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '1660-11-28T23:18:00' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: FyUkHbZxhn + supplierName: Arjun Kuvalis + contactName: Werner Langworth + emailAddress: Arjun34@hotmail.com + phone: 0116 796 3163 + addresses: + - type: Delivery + line1: Suite 214 + line2: 8439 Lueilwitz Passage + city: Fernandohaven + region: Northern Ireland + country: United Kingdom + postalCode: JG04 7PV + - type: Delivery + line1: Suite 096 + line2: 864 Halie Course + city: Juliochester + region: England + country: United Kingdom + postalCode: DZ8 4BF + - type: Delivery + line1: Suite 001 + line2: 416 Stokes Fords + city: Naderborough + region: Wales + country: United Kingdom + postalCode: XG25 0XX + registrationNumber: NI7JEJVM + taxNumber: '7505220209.583549' + status: Active + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '0177-04-27T11:56:00' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 100 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/suppliers?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/suppliers + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/data/suppliers?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: 78623f13-931e-eb11-bbf8-0022481b3585 + supplierName: '' + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:12Z' + sourceModifiedDate: '2020-11-04T11:44:22Z' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: be49ec62-6754-ed11-946f-0022481b67d1 + supplierName: '' + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:12Z' + sourceModifiedDate: '2022-10-25T13:17:36Z' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 31 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/suppliers + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/data/suppliers?page=2&pageSize=2 + Exact (Netherlands): + value: + results: + - id: 3150917c-1d92-4d77-9018-31b5c4758ca9 + supplierName: Abe + contactName: Kelly's Contact Name + emailAddress: sales@kellysupplies.com + phone: 07999 999999 + addresses: + - type: Billing + line1: Unit 51 + city: Bakersfield + region: California + country: US + postalCode: '933081' + registrationNumber: '8409314368' + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2022-07-15T12:01:15Z' + defaultCurrency: EUR + - id: 00014c12-2616-481a-a2e8-31bdf2497775 + supplierName: Ann's test supplier 2 + contactName: Ann's contact name + emailAddress: anna@anna888888.com + phone: '55555555' + addresses: + - type: Billing + line1: line1 + line2: line2 + city: city + region: region + country: RU + postalCode: postal + registrationNumber: '55566677788899944455' + taxNumber: RU4444444 + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2021-06-09T12:04:08Z' + defaultCurrency: USD + pageNumber: 1 + pageSize: 2 + totalResults: 73 + _links: + current: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/suppliers?page=1&pageSize=2 + self: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/suppliers + next: + href: /companies/b83b1923-4db6-45a8-a779-b4e320c15979/data/suppliers?page=2&pageSize=2 + Exact (UK): + value: + results: + - id: 0185fea2-0298-445b-909a-0db685118a9e + supplierName: a + addresses: + - type: Billing + country: GB + status: Active + modifiedDate: '2022-10-26T13:33:13Z' + sourceModifiedDate: '2017-08-02T10:58:54Z' + defaultCurrency: GBP + - id: 64ae712f-4155-48bb-9fce-98232c51d979 + supplierName: aa + addresses: + - type: Billing + country: GB + status: Active + modifiedDate: '2022-10-26T13:33:13Z' + sourceModifiedDate: '2020-05-01T14:05:46Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 118 + _links: + current: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers + next: + href: /companies/d95030cd-22b2-482b-9c7b-2980dcc2b1ce/data/suppliers?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '11526230' + supplierName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Active + modifiedDate: '2023-04-25T14:19:08Z' + sourceModifiedDate: '2023-04-17T06:02:46' + metadata: + isDeleted: false + - id: '9677150' + supplierName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Active + modifiedDate: '2023-04-25T14:19:08Z' + sourceModifiedDate: '2023-04-24T06:19:23' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 159 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/data/suppliers?page=2&pageSize=2 + FreshBooks: + value: + results: + - id: api vendor + supplierName: api vendor + addresses: [] + status: Active + modifiedDate: '2023-03-24T16:07:25Z' + metadata: + isDeleted: false + - id: DUndsRykrmy8kFsc+FvYk29YkJze4zSjGecoF4YcUEhVU7auJ5JkQA0VjXptZ7XQ+D4n6WoxFIkaGY2V/t4flA== + supplierName: 'Chekko Test merchant 100 - Test Very long name: ORIG CO NAME:AMERICAN EXPRESS ORIG ID:9493560001 DESC DATE:220307 CO ENTRY DESCR:ACH PMT SEC:CCD TRACE#:021000023255482 EED:220307 IND ID:A4670 IND NAME:Rick Sanchez' + addresses: [] + status: Active + modifiedDate: '2023-03-24T16:07:25Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers?page=1&pageSize=2 + self: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers + next: + href: /companies/3691c49e-0db4-4172-b3ab-e4084c365013/data/suppliers?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '6202387' + supplierName: Dell + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + taxNumber: '' + status: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '2017-05-09T00:00:00' + - id: '9338173' + supplierName: Home + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + taxNumber: '' + status: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '1990-01-01T00:00:00' + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/suppliers?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/suppliers + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/data/suppliers?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '779' + supplierName: Test Vendor + contactName: Test Vendor + emailAddress: '' + phone: '' + addresses: [] + status: Active + modifiedDate: '2023-01-30T14:47:02Z' + sourceModifiedDate: '2022-02-04T14:24:43' + defaultCurrency: GBP + - id: '726' + supplierName: Vendor -.A + contactName: Vendor -.A + emailAddress: '' + phone: '' + addresses: [] + status: Active + modifiedDate: '2023-01-30T14:47:02Z' + sourceModifiedDate: '2021-03-26T09:53:15' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/suppliers + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/data/suppliers?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: A60000-1197760912 + supplierName: A Cheung Limited + contactName: Angela Cheung + emailAddress: AC@CheungLimited.com + phone: 510 555 5723 + addresses: + - type: Billing + line1: 'A Cheung Limited, Angela Cheung' + line2: 3818 Bear Rd. West + city: Berkeley + region: CA + postalCode: '94688' + status: Active + modifiedDate: '2023-04-26T09:09:03Z' + sourceModifiedDate: '2023-12-16T05:06:44' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: A40000-1197774038 + supplierName: Bank of Anycity + contactName: Lisa D. Holzhauser + emailAddress: lisah@samplename.com + phone: 415-555-9135 + addresses: + - type: Billing + line1: 'Bank of Anycity, Lisa Holzhauser' + line2: 1935 Main Street + city: Middlefield + region: CA + postalCode: '94482' + status: Active + modifiedDate: '2023-04-26T09:09:03Z' + sourceModifiedDate: '2023-12-16T05:06:44' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 54 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/suppliers?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/suppliers + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/data/suppliers?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '41' + supplierName: AI Support + contactName: AI Support + addresses: + - type: Billing + line1: test + region: string + country: Djibouti + status: Active + modifiedDate: '2023-01-18T11:02:36Z' + sourceModifiedDate: '2022-12-07T10:48:18Z' + defaultCurrency: GBP + - id: '42' + supplierName: AI Support 2 + contactName: AI Support 2 + addresses: + - type: Billing + line1: test + region: string + country: DJ + status: Active + modifiedDate: '2023-01-18T11:02:36Z' + sourceModifiedDate: '2021-08-31T08:45:02Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 23 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/data/suppliers?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '129' + supplierName: Ally Johnson + contactName: Miss Smith + phone: 0728 38474 + addresses: + - type: Billing + line1: 100 London Road + line2: Angel + city: London + region: Greater London + country: England + postalCode: EC1M + status: Active + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-13T01:51:08Z' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: '88' + supplierName: Andrew Haberbosch + addresses: [] + status: Active + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2022-07-06T15:55:28Z' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/data/suppliers?page=2&pageSize=2 + Sage 200cloud: + value: + results: + - id: '776' + supplierName: Aaren + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Unknown + line1: '' + line2: '' + city: '' + region: '' + country: Great Britain + postalCode: '' + taxNumber: '' + status: Archived + modifiedDate: '2022-10-14T09:35:58Z' + defaultCurrency: GBP + metadata: + isDeleted: true + - id: '914' + supplierName: Aaren + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Unknown + line1: '' + line2: '' + city: '' + region: '' + country: Great Britain + postalCode: '' + taxNumber: '' + status: Archived + modifiedDate: '2022-10-14T09:35:58Z' + defaultCurrency: GBP + metadata: + isDeleted: true + pageNumber: 1 + pageSize: 2 + totalResults: 943 + _links: + current: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers?page=1&pageSize=2 + self: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers + next: + href: /companies/93c21e2d-049c-4d24-b41b-57e61c30b69e/data/suppliers?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: CON001 + supplierName: Concept Stationery Supplies + contactName: Mark Ramsay + emailAddress: newbusinessadvice@sage.com + phone: 0191 643 4343 + addresses: + - type: Delivery + line1: 66 New Street + line2: Ridgeway + city: Newcastle Upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + - type: Unknown + line1: 66 New Street + line2: Ridgeway + city: Newcastle upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + taxNumber: GB988 3453 23 + status: Active + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + defaultCurrency: GBP + metadata: + isDeleted: false + - id: MCN001 + supplierName: McNally Computer Supplies + contactName: Stuart Lynn + emailAddress: newbusinessadvice@sage.com + phone: 0191 415 3434 + addresses: + - type: Delivery + line1: Station Lane Ind Est + line2: Birtley + city: Chester le Street + region: County Durham + country: GB + postalCode: DH1 3RG + - type: Unknown + line1: Station Lane Ind Est + line2: Birtley + city: Chester le Street + region: County Durham + country: GB + postalCode: DH1 3RG + taxNumber: GB455 2385 34 + status: Active + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-12-05T13:37:26Z' + defaultCurrency: GBP + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 15 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/suppliers?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/suppliers + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/data/suppliers?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 65179671e9ef424caff8b9006cd111c8 + supplierName: 5555 Abdul's Test Name + contactName: Main Contact + addresses: + - type: Billing + country: United Kingdom (GB) + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2020-02-25T17:23:33Z' + defaultCurrency: GBP + - id: cf7f44d693904944a6a7cf3de0887964 + supplierName: Abdi Supplier + contactName: Abdi + emailAddress: abdisupplier@company.com + addresses: + - type: Billing + line1: 1 Place House + city: London + country: United Kingdom (GB) + postalCode: WC1X 1AH + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2020-02-13T10:38:19Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/data/suppliers?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '3' + supplierName: ADP + contactName: 'Jones, William' + phone: 214-760-9491 + addresses: + - type: Unknown + line1: 208 S Akard St + line2: '' + city: Dallas + region: TX + country: United States + postalCode: '75265' + registrationNumber: '' + taxNumber: 85-3678274 + status: Active + modifiedDate: '2023-04-04T16:32:20Z' + sourceModifiedDate: '2023-02-16T09:48:27' + defaultCurrency: USD + metadata: + isDeleted: false + - id: '29' + supplierName: Advisor Printing + contactName: 'Roach, Nathan' + phone: 130-202-4796 + addresses: + - type: Unknown + line1: 5 Carey Hill + line2: '' + city: Drayton Valley + region: Alberta + country: Canada + postalCode: G8V + registrationNumber: '' + taxNumber: '' + status: Active + modifiedDate: '2023-04-04T16:32:20Z' + sourceModifiedDate: '2022-06-15T11:38:29' + defaultCurrency: CAD + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 77 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/suppliers?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/suppliers + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/data/suppliers?page=2&pageSize=2 + Wave: + value: + results: + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0Nzk0 + supplierName: Computer Shop + contactName: '' + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-11-16T18:15:24Z' + sourceModifiedDate: '2020-04-07T13:28:02Z' + defaultCurrency: GBP + - id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0NzQx + supplierName: Flour Mill + contactName: '' + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-11-16T18:15:24Z' + sourceModifiedDate: '2020-04-07T13:12:40Z' + defaultCurrency: GBP + pageNumber: 1 + pageSize: 2 + totalResults: 9 + _links: + current: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers?page=1&pageSize=2 + self: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers + next: + href: /companies/0b22b59d-b4e5-4c35-b03f-88bbbcb41256/data/suppliers?page=2&pageSize=2 + Xero: + value: + results: + - id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + supplierName: 24 Locks + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + - id: bab779bc-c5fb-42cb-a888-953e8309711c + supplierName: 7-Eleven + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 48 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers + next: + href: /companies/5ced9667-a310-443a-a711-958d36377141/data/suppliers?page=2&pageSize=2 + Zoho Books: + value: + results: + - id: '104957000001494001' + supplierName: Acme Corporation + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-09-16T13:09:56' + defaultCurrency: GBP + - id: '104957000000648001' + supplierName: Cool company + contactName: Dre + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-06-10T09:07:16' + defaultCurrency: CAD + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/data/suppliers?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List suppliers* endpoint returns a list of [suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) for a given company's connection.\n\n[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-suppliers + x-speakeasy-group: accounts-payable.suppliers + '/companies/{companyId}/data/suppliers/{supplierId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/accountingSupplierId' + get: + tags: + - Accounts payable + summary: Get supplier + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingSupplier' + examples: + Clear Books: + value: + id: owQ2Gqgj9f + supplierName: Abshire - Kshlerin + contactName: Faye Hansen + emailAddress: hello@Abshire-Kshlerin.info + phone: 01338 858162 + addresses: + - type: Delivery + line1: Suite 431 + line2: 289 Giles Lake + city: Cesarmouth + region: Northern Ireland + country: United Kingdom + postalCode: BG40 9GP + registrationNumber: VYL1XZXR + taxNumber: '1396267523.0914588' + status: Active + modifiedDate: '2023-04-26T12:38:17Z' + sourceModifiedDate: '1660-11-28T23:18:00' + defaultCurrency: GBP + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: 78623f13-931e-eb11-bbf8-0022481b3585 + supplierName: '' + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: GB + postalCode: '' + taxNumber: '' + status: Active + modifiedDate: '2023-03-27T14:21:12Z' + sourceModifiedDate: '2020-11-04T11:44:22Z' + defaultCurrency: GBP + metadata: + isDeleted: false + Exact (Netherlands): + value: + id: 3150917c-1d92-4d77-9018-31b5c4758ca9 + supplierName: Abe + contactName: Kelly's Contact Name + emailAddress: sales@kellysupplies.com + phone: 07999 999999 + addresses: + - type: Billing + line1: Unit 51 + city: Bakersfield + region: California + country: US + postalCode: '933081' + registrationNumber: '8409314368' + status: Active + modifiedDate: '2022-10-26T13:32:05Z' + sourceModifiedDate: '2022-07-15T12:01:15Z' + defaultCurrency: EUR + Exact (UK): + value: + id: 0185fea2-0298-445b-909a-0db685118a9e + supplierName: a + addresses: + - type: Billing + country: GB + status: Active + modifiedDate: '2022-10-26T13:33:13Z' + sourceModifiedDate: '2017-08-02T10:58:54Z' + defaultCurrency: GBP + FreeAgent: + value: + id: '11526230' + supplierName: '-' + contactName: Test 1 + addresses: + - type: Billing + line1: 1 Place House + line2: '' + city: London + country: United Kingdom + postalCode: WC1X 1AH + status: Active + modifiedDate: '2023-04-25T14:19:08Z' + sourceModifiedDate: '2023-04-17T06:02:46' + metadata: + isDeleted: false + FreshBooks: + value: + id: api vendor + supplierName: api vendor + addresses: [] + status: Active + modifiedDate: '2023-03-24T16:07:25Z' + metadata: + isDeleted: false + KashFlow: + value: + id: '6202387' + supplierName: Dell + contactName: '' + emailAddress: '' + phone: '' + addresses: [] + taxNumber: '' + status: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + sourceModifiedDate: '2017-05-09T00:00:00' + Oracle NetSuite: + value: + id: '779' + supplierName: Test Vendor + contactName: Test Vendor + emailAddress: '' + phone: '' + addresses: [] + status: Active + modifiedDate: '2023-01-30T14:47:02Z' + sourceModifiedDate: '2022-02-04T14:24:43' + defaultCurrency: GBP + QuickBooks Desktop: + value: + id: A60000-1197760912 + supplierName: A Cheung Limited + contactName: Angela Cheung + emailAddress: AC@CheungLimited.com + phone: 510 555 5723 + addresses: + - type: Billing + line1: 'A Cheung Limited, Angela Cheung' + line2: 3818 Bear Rd. West + city: Berkeley + region: CA + postalCode: '94688' + status: Active + modifiedDate: '2023-04-26T09:09:03Z' + sourceModifiedDate: '2023-12-16T05:06:44' + defaultCurrency: GBP + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '41' + supplierName: AI Support + contactName: AI Support + addresses: + - type: Billing + line1: test + region: string + country: Djibouti + status: Active + modifiedDate: '2023-01-18T11:02:36Z' + sourceModifiedDate: '2022-12-07T10:48:18Z' + defaultCurrency: GBP + QuickBooks Online Sandbox: + value: + id: '129' + supplierName: Ally Johnson + contactName: Miss Smith + phone: 0728 38474 + addresses: + - type: Billing + line1: 100 London Road + line2: Angel + city: London + region: Greater London + country: England + postalCode: EC1M + status: Active + modifiedDate: '2023-04-26T09:35:55Z' + sourceModifiedDate: '2023-04-13T01:51:08Z' + defaultCurrency: GBP + metadata: + isDeleted: false + Sage 200cloud: + value: + id: '776' + supplierName: Aaren + contactName: '' + emailAddress: '' + phone: '' + addresses: + - type: Unknown + line1: '' + line2: '' + city: '' + region: '' + country: Great Britain + postalCode: '' + taxNumber: '' + status: Archived + modifiedDate: '2022-10-14T09:35:58Z' + defaultCurrency: GBP + metadata: + isDeleted: true + Sage 50 (UK): + value: + id: CON001 + supplierName: Concept Stationery Supplies + contactName: Mark Ramsay + emailAddress: newbusinessadvice@sage.com + phone: 0191 643 4343 + addresses: + - type: Delivery + line1: 66 New Street + line2: Ridgeway + city: Newcastle Upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + - type: Unknown + line1: 66 New Street + line2: Ridgeway + city: Newcastle upon Tyne + region: '' + country: GB + postalCode: NE1 4GF + taxNumber: GB988 3453 23 + status: Active + modifiedDate: '2023-03-30T14:42:38Z' + sourceModifiedDate: '2022-11-25T09:43:54Z' + defaultCurrency: GBP + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: 65179671e9ef424caff8b9006cd111c8 + supplierName: 5555 Abdul's Test Name + contactName: Main Contact + addresses: + - type: Billing + country: United Kingdom (GB) + status: Active + modifiedDate: '2022-10-24T14:52:54Z' + sourceModifiedDate: '2020-02-25T17:23:33Z' + defaultCurrency: GBP + Sage Intacct: + value: + id: '3' + supplierName: ADP + contactName: 'Jones, William' + phone: 214-760-9491 + addresses: + - type: Unknown + line1: 208 S Akard St + line2: '' + city: Dallas + region: TX + country: United States + postalCode: '75265' + registrationNumber: '' + taxNumber: 85-3678274 + status: Active + modifiedDate: '2023-04-04T16:32:20Z' + sourceModifiedDate: '2023-02-16T09:48:27' + defaultCurrency: USD + metadata: + isDeleted: false + Wave: + value: + id: QnVzaW5lc3M6ZTI0OGQyZDctMWE5Ni00YTk4LWFkOTEtMDdlMGYyMmNhNmE2O1ZlbmRvcjo2NjA0Nzk0 + supplierName: Computer Shop + contactName: '' + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-11-16T18:15:24Z' + sourceModifiedDate: '2020-04-07T13:28:02Z' + defaultCurrency: GBP + Xero: + value: + id: e4c9d0e2-c285-4e85-b579-6d28b180c730 + supplierName: 24 Locks + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-02-17T18:03:42' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000001494001' + supplierName: Acme Corporation + emailAddress: '' + addresses: [] + status: Active + modifiedDate: '2022-10-03T08:40:37Z' + sourceModifiedDate: '2022-09-16T13:09:56' + defaultCurrency: GBP + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get supplier* endpoint returns a single supplier for a given supplierId. + + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-supplier + x-speakeasy-group: accounts-payable.suppliers + '/companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingSupplierId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Attachments' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: List supplier attachments + description: | + The *List supplier attachments* endpoint returns a list of attachments available to download for given `supplierId`. + + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + operationId: list-accounting-supplier-attachments + x-speakeasy-group: accounts-payable.suppliers + '/companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments/{attachmentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingSupplierId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAttachment' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Get supplier attachment + description: | + The *Get supplier attachment* endpoint returns a specific attachment for a given `supplierId` and `attachmentId`. + + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + operationId: get-accounting-supplier-attachment + x-speakeasy-group: accounts-payable.suppliers + '/companies/{companyId}/connections/{connectionId}/data/suppliers/{supplierId}/attachments/{attachmentId}/download': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingSupplierId' + - $ref: '#/components/parameters/attachmentId' + get: + tags: + - Accounts payable + responses: + '200': + description: Success + content: + application/octet-stream: + schema: + title: Data + type: string + format: binary + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Download supplier attachment + description: | + The *Download supplier attachment* endpoint downloads a specific attachment for a given `supplierId` and `attachmentId`. + + [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + operationId: download-accounting-supplier-attachment + x-speakeasy-group: accounts-payable.suppliers + '/companies/{companyId}/connections/{connectionId}/data/transfers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Transactions + summary: List transfers + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingTransfers' + examples: + Clear Books: + value: + results: + - id: 0bd2f801-6f02-44d6-a2ab-5431553d16f9 + description: depositing 16531.08 into Current Account + contactRef: + id: e4baf949-cb1d-4341-8452-200a93baa3fa + dataType: customers + date: '2022-04-25T07:20:00' + from: + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + dataType: bankAccounts + currency: GBP + amount: 16531.08 + status: Unknown + to: + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + dataType: bankAccounts + currency: GBP + amount: 16531.08 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: + - id: fc253cca-0dfe-46e8-b75f-c7fb3db760b2 + dataType: directIncomes + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2022-04-25T07:20:00' + metadata: + isDeleted: false + - id: 78373000-29e1-4ef4-a2e6-9b573ed656e4 + description: depositing 188.33 into Current Account + contactRef: + id: 51f03576-f6b0-40d5-9fba-81a490411c03 + dataType: customers + date: '2022-04-25T07:20:00' + from: + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + dataType: bankAccounts + currency: GBP + amount: 188.33 + status: Unknown + to: + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + dataType: bankAccounts + currency: GBP + amount: 188.33 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: + - id: 38e8c917-0afc-4583-8ffe-1b53ad601197 + dataType: directIncomes + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2022-04-25T07:20:00' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 357 + _links: + current: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/transfers?page=1&pageSize=2 + self: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/transfers + next: + href: /companies/354a121b-855f-4d25-90ad-0905b498c1c0/connections/57b731ba-1d45-4386-ba58-2a1ca0234624/data/transfers?page=2&pageSize=2 + Dynamics 365 Business Central: + value: + results: + - id: G00001 + date: '2020-11-26T00:00:00' + from: + accountRef: + id: cf1417b3-89d1-ea11-bbaa-000d3a2b9185 + dataType: bankAccounts + currency: GBP + amount: 20 + status: Unknown + to: + accountRef: + id: ce1417b3-89d1-ea11-bbaa-000d3a2b9185 + dataType: bankAccounts + currency: GBP + amount: 20 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-03-27T14:21:26' + sourceModifiedDate: '2020-11-26T12:16:44Z' + metadata: + isDeleted: false + - id: TST-001 + date: '2022-10-25T00:00:00' + from: + accountRef: + id: 8277672c-b8e6-ec11-82f8-0022481a77f0 + dataType: bankAccounts + currency: USD + amount: 3.6 + status: Unknown + to: + accountRef: + id: 8982e7d8-cb19-eb11-bbf9-0022481ad2f4 + dataType: bankAccounts + currency: GBP + amount: 2.34 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-03-27T14:21:26' + sourceModifiedDate: '2022-10-25T15:47:48Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 10 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/transfers?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/transfers + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/transfers?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '307335275' + description: Transfer from Savings Account to Freeagent Test12 + date: '2018-06-14T00:00:00' + from: + accountRef: + id: '532100' + dataType: bankAccounts + currency: GBP + amount: 0.69 + status: Unknown + to: + accountRef: + id: '708504' + dataType: bankAccounts + currency: GBP + amount: 0.69 + status: Unknown + trackingCategoryRefs: + - id: '761' + depositedRecordRefs: [] + modifiedDate: '2023-04-25T14:21:36' + sourceModifiedDate: '2022-03-23T15:55:58Z' + metadata: + isDeleted: false + - id: '308682395' + description: Transfer from Business Current Account to Nic Test11 + date: '2019-12-23T00:00:00' + from: + accountRef: + id: '469976' + dataType: bankAccounts + currency: GBP + amount: 250 + status: Unknown + to: + accountRef: + id: '691393' + dataType: bankAccounts + currency: GBP + amount: 250 + status: Unknown + trackingCategoryRefs: + - id: '761' + depositedRecordRefs: [] + modifiedDate: '2023-04-25T14:21:36' + sourceModifiedDate: '2022-03-31T16:09:27Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 99 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/transfers?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/transfers + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/transfers?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: 2-1 + contactRef: + id: '417' + dataType: customers + date: '2021-03-10T00:00:00' + from: + accountRef: + id: '122' + dataType: bankAccounts + currency: GBP + amount: 90 + status: Unknown + to: + accountRef: + id: '513' + dataType: bankAccounts + currency: GBP + amount: 90 + status: Unknown + trackingCategoryRefs: + - id: location-1 + depositedRecordRefs: + - id: '428' + dataType: payments + modifiedDate: '2022-09-20T08:16:26' + sourceModifiedDate: '2022-04-28T13:36:47' + - id: 2-11822 + contactRef: + id: '417' + dataType: customers + date: '2022-04-28T00:00:00' + from: + accountRef: + id: '513' + dataType: bankAccounts + currency: GBP + amount: 1200 + status: Unknown + to: + accountRef: + id: '122' + dataType: bankAccounts + currency: GBP + amount: 1200 + status: Unknown + trackingCategoryRefs: + - id: location-1 + depositedRecordRefs: + - id: '7526' + dataType: payments + modifiedDate: '2022-09-20T08:16:26' + sourceModifiedDate: '2022-04-28T14:14:33' + pageNumber: 1 + pageSize: 2 + totalResults: 47 + _links: + current: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/connections/5f07dcfb-23c0-49e6-895c-4498ea728ff3/data/transfers?page=1&pageSize=2 + self: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/connections/5f07dcfb-23c0-49e6-895c-4498ea728ff3/data/transfers + next: + href: /companies/973341cc-ca0a-4a88-88de-e5954157818b/connections/5f07dcfb-23c0-49e6-895c-4498ea728ff3/data/transfers?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 4B1-933288922 + description: Funds Transfer + date: '2024-10-14T00:00:00' + from: + accountRef: + id: 30000-933270541 + dataType: bankAccounts + currency: GBP + amount: 15000 + status: Unknown + to: + accountRef: + id: 20000-933270541 + dataType: bankAccounts + currency: GBP + amount: 15000 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:13:45' + sourceModifiedDate: '2023-12-16T05:03:58' + metadata: + isDeleted: false + - id: C2A-933780606 + description: Funds Transfer + date: '2024-11-25T00:00:00' + from: + accountRef: + id: 20000-933270541 + dataType: bankAccounts + currency: GBP + amount: 42300 + status: Unknown + to: + accountRef: + id: 30000-933270541 + dataType: bankAccounts + currency: GBP + amount: 42300 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:13:45' + sourceModifiedDate: '2023-12-16T05:04:07' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/transfers?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/transfers + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/transfers?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '646' + date: '2020-08-21T00:00:00' + from: + accountRef: + id: '102' + dataType: bankAccounts + currency: GBP + amount: 73.41 + status: Unknown + to: + accountRef: + id: '108' + dataType: bankAccounts + currency: GBP + amount: 73.41 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:36:33' + sourceModifiedDate: '2020-08-26T11:41:20Z' + metadata: + isDeleted: false + - id: '678' + date: '2020-08-22T00:00:00' + from: + accountRef: + id: '124' + dataType: bankAccounts + currency: GBP + amount: 66.66 + status: Unknown + to: + accountRef: + id: '109' + dataType: bankAccounts + currency: GBP + amount: 66.66 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:36:33' + sourceModifiedDate: '2020-08-29T00:01:20Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 442 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/transfers?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/transfers + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/transfers?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '1881' + date: '2020-08-29T00:00:00' + from: + accountRef: + id: '60' + dataType: bankAccounts + currency: GBP + amount: 86.19 + status: Unknown + to: + accountRef: + id: '61' + dataType: bankAccounts + currency: GBP + amount: 86.19 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-01-18T11:03:00' + sourceModifiedDate: '2020-09-03T11:19:54Z' + - id: '1885' + date: '2020-09-02T00:00:00' + from: + accountRef: + id: '60' + dataType: bankAccounts + currency: GBP + amount: 45.73 + status: Unknown + to: + accountRef: + id: '61' + dataType: bankAccounts + currency: GBP + amount: 45.73 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-01-18T11:03:00' + sourceModifiedDate: '2020-09-03T11:23:44Z' + pageNumber: 1 + pageSize: 2 + totalResults: 18 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/transfers?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/transfers + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/transfers?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 434bce57215a11e8b45c025132dab352 + description: Some cheque + date: '2018-03-06T00:00:00' + from: + accountRef: + id: 9a3f0ed6267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 1000 + status: Unknown + to: + accountRef: + id: 9a2c3770267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 1000 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2022-10-24T14:54:11' + sourceModifiedDate: '2018-03-06T16:20:19Z' + - id: 73d909a4215a11e8b45c025132dab352 + description: Some cash + date: '2018-03-06T00:00:00' + from: + accountRef: + id: 9a3f0ed6267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 465 + status: Unknown + to: + accountRef: + id: 9a2c3770267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 465 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2022-10-24T14:54:11' + sourceModifiedDate: '2018-03-06T16:21:40Z' + pageNumber: 1 + pageSize: 2 + totalResults: 646 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/transfers?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/transfers + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/transfers?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: '4844' + description: Description + date: '2022-03-10T00:00:00' + from: + accountRef: + id: 'CHECKINGACCOUNT:12' + dataType: bankAccounts + currency: ZAR + amount: 418.27 + status: Unknown + to: + accountRef: + id: 'CHECKINGACCOUNT:9' + dataType: bankAccounts + currency: CAD + amount: 35.45 + status: Unknown + trackingCategoryRefs: + - id: LOCATION-10 + name: South Africa + depositedRecordRefs: [] + modifiedDate: '2023-02-23T14:18:48' + sourceModifiedDate: '2022-03-10T12:38:23' + metadata: + isDeleted: false + - id: '18828' + description: From bank account '700_CHK' to bank account 'Test Savings Account' + date: '2022-10-05T00:00:00' + from: + accountRef: + id: 'CHECKINGACCOUNT:12' + dataType: bankAccounts + currency: ZAR + amount: 4040.62 + status: Unknown + to: + accountRef: + id: 'SAVINGSACCOUNT:17' + dataType: bankAccounts + currency: GBP + amount: 200 + status: Unknown + trackingCategoryRefs: + - id: LOCATION-10 + name: South Africa + depositedRecordRefs: [] + modifiedDate: '2023-02-23T14:18:48' + sourceModifiedDate: '2022-10-05T15:28:15' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/connections/d891700f-d906-4e57-998a-0cf03d2a05d3/data/transfers?page=1&pageSize=2 + self: + href: /companies/b53cfc9f-1a00-4a20-936f-34e8efbe07c5/connections/d891700f-d906-4e57-998a-0cf03d2a05d3/data/transfers + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List transfers* endpoint returns a list of [transfers](https://docs.codat.io/lending-api#/schemas/Transfer) for a given company's connection.\n\n[Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + operationId: list-accounting-transfers + x-speakeasy-group: transactions.transfers + '/companies/{companyId}/connections/{connectionId}/data/transfers/{transferId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: transferId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a transfer. + get: + tags: + - Transactions + summary: Get transfer + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingTransfer' + examples: + Clear Books: + value: + id: 0bd2f801-6f02-44d6-a2ab-5431553d16f9 + description: depositing 16531.08 into Current Account + contactRef: + id: e4baf949-cb1d-4341-8452-200a93baa3fa + dataType: customers + date: '2022-04-25T07:20:00' + from: + accountRef: + id: ff8fdc4c-2aad-4ec1-9430-6bd201832eb3 + dataType: bankAccounts + currency: GBP + amount: 16531.08 + status: Unknown + to: + accountRef: + id: dbcaf288-2b39-4b95-8ab3-42202ab15918 + dataType: bankAccounts + currency: GBP + amount: 16531.08 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: + - id: fc253cca-0dfe-46e8-b75f-c7fb3db760b2 + dataType: directIncomes + modifiedDate: '2023-04-26T12:38:18' + sourceModifiedDate: '2022-04-25T07:20:00' + metadata: + isDeleted: false + Dynamics 365 Business Central: + value: + id: G00001 + date: '2020-11-26T00:00:00' + from: + accountRef: + id: cf1417b3-89d1-ea11-bbaa-000d3a2b9185 + dataType: bankAccounts + currency: GBP + amount: 20 + status: Unknown + to: + accountRef: + id: ce1417b3-89d1-ea11-bbaa-000d3a2b9185 + dataType: bankAccounts + currency: GBP + amount: 20 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-03-27T14:21:26' + sourceModifiedDate: '2020-11-26T12:16:44Z' + metadata: + isDeleted: false + FreeAgent: + value: + id: '307335275' + description: Transfer from Savings Account to Freeagent Test12 + date: '2018-06-14T00:00:00' + from: + accountRef: + id: '532100' + dataType: bankAccounts + currency: GBP + amount: 0.69 + status: Unknown + to: + accountRef: + id: '708504' + dataType: bankAccounts + currency: GBP + amount: 0.69 + status: Unknown + trackingCategoryRefs: + - id: '761' + depositedRecordRefs: [] + modifiedDate: '2023-04-25T14:21:36' + sourceModifiedDate: '2022-03-23T15:55:58Z' + metadata: + isDeleted: false + Oracle NetSuite: + value: + id: 2-1 + contactRef: + id: '417' + dataType: customers + date: '2021-03-10T00:00:00' + from: + accountRef: + id: '122' + dataType: bankAccounts + currency: GBP + amount: 90 + status: Unknown + to: + accountRef: + id: '513' + dataType: bankAccounts + currency: GBP + amount: 90 + status: Unknown + trackingCategoryRefs: + - id: location-1 + depositedRecordRefs: + - id: '428' + dataType: payments + modifiedDate: '2022-09-20T08:16:26' + sourceModifiedDate: '2022-04-28T13:36:47' + QuickBooks Desktop: + value: + id: 4B1-933288922 + description: Funds Transfer + date: '2024-10-14T00:00:00' + from: + accountRef: + id: 30000-933270541 + dataType: bankAccounts + currency: GBP + amount: 15000 + status: Unknown + to: + accountRef: + id: 20000-933270541 + dataType: bankAccounts + currency: GBP + amount: 15000 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:13:45' + sourceModifiedDate: '2023-12-16T05:03:58' + metadata: + isDeleted: false + QuickBooks Online Sandbox: + value: + id: '646' + date: '2020-08-21T00:00:00' + from: + accountRef: + id: '102' + dataType: bankAccounts + currency: GBP + amount: 73.41 + status: Unknown + to: + accountRef: + id: '108' + dataType: bankAccounts + currency: GBP + amount: 73.41 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-04-26T09:36:33' + sourceModifiedDate: '2020-08-26T11:41:20Z' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '1881' + date: '2020-08-29T00:00:00' + from: + accountRef: + id: '60' + dataType: bankAccounts + currency: GBP + amount: 86.19 + status: Unknown + to: + accountRef: + id: '61' + dataType: bankAccounts + currency: GBP + amount: 86.19 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2023-01-18T11:03:00' + sourceModifiedDate: '2020-09-03T11:19:54Z' + Sage Business Cloud Accounting: + value: + id: 434bce57215a11e8b45c025132dab352 + description: Some cheque + date: '2018-03-06T00:00:00' + from: + accountRef: + id: 9a3f0ed6267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 1000 + status: Unknown + to: + accountRef: + id: 9a2c3770267a11e797950a57719b2edb + dataType: bankAccounts + currency: GBP + amount: 1000 + status: Unknown + trackingCategoryRefs: [] + depositedRecordRefs: [] + modifiedDate: '2022-10-24T14:54:11' + sourceModifiedDate: '2018-03-06T16:20:19Z' + Sage Intacct: + value: + id: '4844' + description: Description + date: '2022-03-10T00:00:00' + from: + accountRef: + id: 'CHECKINGACCOUNT:12' + dataType: bankAccounts + currency: ZAR + amount: 418.27 + status: Unknown + to: + accountRef: + id: 'CHECKINGACCOUNT:9' + dataType: bankAccounts + currency: CAD + amount: 35.45 + status: Unknown + trackingCategoryRefs: + - id: LOCATION-10 + name: South Africa + depositedRecordRefs: [] + modifiedDate: '2023-02-23T14:18:48' + sourceModifiedDate: '2022-03-10T12:38:23' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get transfer* endpoint returns a single transfer for a given transferId. + + [Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-accounting-transfer + x-speakeasy-group: transactions.transfers + '/companies/{companyId}/connections/{connectionId}/data/bankAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + x-internal: true + tags: + - Accounting bank data + summary: List bank accounts + operationId: list-accounting-bank-accounts + x-speakeasy-group: accounting-bank-data.accounts + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBankAccounts' + examples: + Dynamics 365 Business Central: + value: + results: + - id: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + accountName: '55' + accountType: Unknown + nominalCode: '10500' + sortCode: '' + accountNumber: '' + iBan: '' + currency: GBP + balance: -352.03 + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2023-02-07T00:00:00' + overdraftLimit: 0 + metadata: + isDeleted: false + - id: 47020f80-60e6-ec11-82f8-0022481a77f0 + accountName: '555' + accountType: Unknown + nominalCode: '40300' + sortCode: '' + accountNumber: '' + iBan: '' + currency: PLN + balance: 661.79 + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2022-06-07T00:00:00' + overdraftLimit: 0 + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 28 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts + next: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts?page=2&pageSize=2 + FreeAgent: + value: + results: + - id: '738783' + accountName: \w3fw + accountType: Debit + sortCode: '236972' + accountNumber: A06268209 + currency: GBP + balance: -10484.65 + availableBalance: -10484.65 + modifiedDate: '2023-04-25T14:19:12Z' + metadata: + isDeleted: false + - id: '738778' + accountName: 2e2bna45hy\ + accountType: Debit + sortCode: '236972' + accountNumber: D01825250 + currency: GBP + balance: -114.4 + availableBalance: -114.4 + modifiedDate: '2023-04-25T14:19:12Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 82 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts?page=2&pageSize=2 + KashFlow: + value: + results: + - id: '765768' + accountName: 16th Account + accountType: Unknown + nominalCode: '70700' + currency: GBP + balance: 326 + availableBalance: 326 + modifiedDate: '2022-09-30T10:29:16Z' + - id: '765766' + accountName: 1a1a + accountType: Unknown + nominalCode: '70600' + currency: GBP + balance: 0 + availableBalance: 0 + modifiedDate: '2022-09-30T10:29:16Z' + pageNumber: 1 + pageSize: 2 + totalResults: 56 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts + next: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts?page=2&pageSize=2 + Oracle NetSuite: + value: + results: + - id: '825' + accountName: Codat Europe Bank + accountType: Debit + nominalCode: '111111122222111' + currency: GBP + balance: 558.22 + modifiedDate: '2023-05-02T13:24:36Z' + sourceModifiedDate: '2022-07-15T11:34:02' + metadata: + isDeleted: false + - id: '826' + accountName: Codat Europe Bank USD + accountType: Debit + nominalCode: '1133221133' + currency: USD + modifiedDate: '2023-05-02T13:24:36Z' + sourceModifiedDate: '2021-03-26T10:31:40' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/connections/79f8313e-210a-4dc8-b69f-ba7e5004dda7/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/connections/79f8313e-210a-4dc8-b69f-ba7e5004dda7/data/bankAccounts + next: + href: /companies/d5074b08-6a34-4b06-a742-236edf5dc4f1/connections/79f8313e-210a-4dc8-b69f-ba7e5004dda7/data/bankAccounts?page=2&pageSize=2 + QuickBooks Desktop: + value: + results: + - id: 20000-933270541 + accountName: Checking + accountType: Unknown + nominalCode: '10100' + currency: GBP + balance: 46954.1 + availableBalance: 46954.1 + modifiedDate: '2023-04-26T09:12:37Z' + sourceModifiedDate: '2023-12-16T05:06:45' + metadata: + isDeleted: false + - id: 550001-1071509830 + accountName: Petty Cash + accountType: Unknown + nominalCode: '10400' + currency: GBP + balance: 500 + availableBalance: 500 + modifiedDate: '2023-04-26T09:12:37Z' + sourceModifiedDate: '2023-12-16T05:06:45' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts?page=2&pageSize=2 + QuickBooks Online Sandbox: + value: + results: + - id: '164' + accountName: '00' + accountType: Debit + nominalCode: '123567' + currency: GBP + balance: 0 + availableBalance: 0 + modifiedDate: '2023-04-26T09:35:57Z' + sourceModifiedDate: '2022-07-20T14:11:28Z' + metadata: + isDeleted: false + - id: '163' + accountName: '11' + accountType: Debit + currency: GBP + balance: 0 + availableBalance: 0 + modifiedDate: '2023-04-26T09:35:57Z' + sourceModifiedDate: '2022-07-20T14:11:28Z' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 57 + _links: + current: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/bankAccounts + next: + href: /companies/5a7f3597-36e1-4216-86fe-289ad36088a6/connections/1f9f6013-f8a5-4278-8a47-3ab7fdb6c24c/data/bankAccounts?page=2&pageSize=2 + QuickBooks Online: + value: + results: + - id: '202' + accountName: \aa + accountType: Debit + currency: GBP + balance: 123 + availableBalance: 123 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2022-11-11T14:15:13Z' + - id: '193' + accountName: 1 year ago + accountType: Debit + currency: GBP + balance: 5300.02 + availableBalance: 5300.02 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2023-01-18T06:05:12Z' + pageNumber: 1 + pageSize: 2 + totalResults: 140 + _links: + current: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/bankAccounts + next: + href: /companies/10818b5e-6e6a-4ed4-a1c5-3e3efe626e87/connections/9e28a776-f4be-425b-8a3d-ad49956de2c9/data/bankAccounts?page=2&pageSize=2 + Sage 50 (UK): + value: + results: + - id: '1200' + accountName: Bank Current Account + accountType: Unknown + nominalCode: '1200' + sortCode: 23-34-34 + accountNumber: '003234234' + iBan: '' + currency: GBP + balance: -20091.04 + availableBalance: -20091.04 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:25:48' + overdraftLimit: 120000 + institution: Lloyds Bank PLC + metadata: + isDeleted: false + - id: '1210' + accountName: Bank Deposit Account + accountType: Unknown + nominalCode: '1210' + sortCode: 45-45-45 + accountNumber: 9/00474345 + iBan: '' + currency: GBP + balance: 3510 + availableBalance: 3510 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:25:48' + overdraftLimit: 0 + institution: Halifax Building Society + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts?page=2&pageSize=2 + Sage Business Cloud Accounting: + value: + results: + - id: 154d05abe9f24c4babe0f6a741dec1b9 + accountName: Abdi Internet Bank + accountType: Unknown + nominalCode: '1560' + sortCode: '010101' + accountNumber: '11111' + currency: GBP + balance: 49.61 + availableBalance: 49.61 + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-27T10:53:26Z' + - id: 565ce07212bc492c8c2d04f43f9f67e3 + accountName: Abdi Live Test + accountType: Unknown + nominalCode: '147852' + sortCode: '123456' + accountNumber: '1234567' + currency: GBP + balance: -225830.75 + availableBalance: -225830.75 + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-28T14:00:20Z' + pageNumber: 1 + pageSize: 2 + totalResults: 45 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts + next: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts?page=2&pageSize=2 + Sage Intacct: + value: + results: + - id: 'CREDITCARD:55' + accountName: CoT Credit Card + accountType: Credit + nominalCode: '10021' + currency: GBP + modifiedDate: '2023-04-04T16:31:46Z' + sourceModifiedDate: '2023-03-27T14:11:48' + metadata: + isDeleted: false + - id: 'CREDITCARD:58' + accountName: Cot Credit Card 2 + accountType: Credit + nominalCode: '11112' + currency: GBP + modifiedDate: '2023-04-04T16:31:46Z' + sourceModifiedDate: '2023-03-27T14:15:11' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 14 + _links: + current: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts + next: + href: /companies/df02b289-cb16-4964-ac4d-9fd60b04538e/connections/8f457d9c-1142-4241-a07e-71d1ee2e3052/data/bankAccounts?page=2&pageSize=2 + Xero: + value: + results: + - id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + accountName: Business Bank Account + accountType: Debit + sortCode: '990404' + accountNumber: '987654321' + currency: GBP + balance: 6681.79 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-03-15T20:35:07' + metadata: + isDeleted: false + - id: a8d6fb1a-8c5d-4683-90ce-bf9d28fc62ba + accountName: Business Savings Account + accountType: Debit + sortCode: '890303' + accountNumber: '876543210' + currency: GBP + balance: 0 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-03-15T20:36:06' + metadata: + isDeleted: false + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts + Zoho Books: + value: + results: + - id: '104957000000060010' + accountName: Abdi Test + accountType: Unknown + sortCode: '112233' + accountNumber: xxxx5678 + currency: GBP + balance: 69858.44 + modifiedDate: '2022-10-03T08:40:38Z' + institution: Test Bank + - id: '104957000000065002' + accountName: Abdi Test 2 + accountType: Unknown + sortCode: '' + accountNumber: '' + currency: AED + balance: 98.03 + modifiedDate: '2022-10-03T08:40:38Z' + institution: '' + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts?page=1&pageSize=2 + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts + next: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List bank accounts* endpoint returns a list of [bank accounts](https://docs.codat.io/lending-api#/schemas/BankAccount) for a given company's connection.\n\n[Bank accounts](https://docs.codat.io/lending-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/lending-api#/operations/refresh-company-data).\n " + '/companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingAccountId' + get: + x-internal: true + tags: + - Accounting bank data + summary: Get bank account + operationId: get-accounting-bank-account + x-speakeasy-group: accounting-bank-data.accounts + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBankAccount' + examples: + Dynamics 365 Business Central: + value: + id: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + accountName: '55' + accountType: Unknown + nominalCode: '10500' + sortCode: '' + accountNumber: '' + iBan: '' + currency: GBP + balance: -352.03 + modifiedDate: '2023-03-27T14:21:10Z' + sourceModifiedDate: '2023-02-07T00:00:00' + overdraftLimit: 0 + metadata: + isDeleted: false + FreeAgent: + value: + id: '738783' + accountName: \w3fw + accountType: Debit + sortCode: '236972' + accountNumber: A06268209 + currency: GBP + balance: -10484.65 + availableBalance: -10484.65 + modifiedDate: '2023-04-25T14:19:12Z' + metadata: + isDeleted: false + KashFlow: + value: + id: '765768' + accountName: 16th Account + accountType: Unknown + nominalCode: '70700' + currency: GBP + balance: 326 + availableBalance: 326 + modifiedDate: '2022-09-30T10:29:16Z' + QuickBooks Desktop: + value: + id: 20000-933270541 + accountName: Checking + accountType: Unknown + nominalCode: '10100' + currency: GBP + balance: 46954.1 + availableBalance: 46954.1 + modifiedDate: '2023-04-26T09:12:37Z' + sourceModifiedDate: '2023-12-16T05:06:45' + metadata: + isDeleted: false + Sage 50 (UK): + value: + id: '1200' + accountName: Bank Current Account + accountType: Unknown + nominalCode: '1200' + sortCode: 23-34-34 + accountNumber: '003234234' + iBan: '' + currency: GBP + balance: -20091.04 + availableBalance: -20091.04 + modifiedDate: '2023-03-30T14:42:37Z' + sourceModifiedDate: '2022-11-25T09:25:48' + overdraftLimit: 120000 + institution: Lloyds Bank PLC + metadata: + isDeleted: false + Sage Business Cloud Accounting: + value: + id: 154d05abe9f24c4babe0f6a741dec1b9 + accountName: Abdi Internet Bank + accountType: Unknown + nominalCode: '1560' + sortCode: '010101' + accountNumber: '11111' + currency: GBP + balance: 49.61 + availableBalance: 49.61 + modifiedDate: '2022-10-24T14:52:53Z' + sourceModifiedDate: '2020-01-27T10:53:26Z' + Xero: + value: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + accountName: Business Bank Account + accountType: Debit + sortCode: '990404' + accountNumber: '987654321' + currency: GBP + balance: 6681.79 + modifiedDate: '2023-03-15T20:36:09Z' + sourceModifiedDate: '2023-03-15T20:35:07' + metadata: + isDeleted: false + Zoho Books: + value: + id: '104957000000060010' + accountName: Abdi Test + accountType: Unknown + sortCode: '112233' + accountNumber: xxxx5678 + currency: GBP + balance: 69858.44 + modifiedDate: '2022-10-03T08:40:38Z' + institution: Test Bank + Oracle NetSuite: + value: + id: '825' + accountName: Codat Europe Bank + accountType: Debit + nominalCode: '111111122222111' + currency: GBP + balance: 558.22 + modifiedDate: '2023-05-02T13:24:36Z' + sourceModifiedDate: '2022-07-15T11:34:02' + metadata: + isDeleted: false + QuickBooks Online Sandbox: + value: + id: '164' + accountName: '00' + accountType: Debit + nominalCode: '123567' + currency: GBP + balance: 0 + availableBalance: 0 + modifiedDate: '2023-04-26T09:35:57Z' + sourceModifiedDate: '2022-07-20T14:11:28Z' + metadata: + isDeleted: false + QuickBooks Online: + value: + id: '202' + accountName: \aa + accountType: Debit + currency: GBP + balance: 123 + availableBalance: 123 + modifiedDate: '2023-01-18T11:02:37Z' + sourceModifiedDate: '2022-11-11T14:15:13Z' + Sage Intacct: + value: + id: 'CREDITCARD:55' + accountName: CoT Credit Card + accountType: Credit + nominalCode: '10021' + currency: GBP + modifiedDate: '2023-04-04T16:31:46Z' + sourceModifiedDate: '2023-03-27T14:11:48' + metadata: + isDeleted: false + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get bank account* endpoint returns a single account for a given accountId. + + [Bank accounts](https://docs.codat.io/lending-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/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/bankAccounts/{accountId}/bankTransactions': + get: + x-internal: true + tags: + - Accounting bank data + summary: List bank account transactions + description: | + The *List account bank transactions* endpoint returns a list of [bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) for a given company's connection. + + [Bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: list-accounting-bank-account-transactions + x-speakeasy-name-override: list-transactions + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingAccountId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBankTransactions' + examples: + Dynamics 365 Business Central: + value: + results: + - id: 07c891b4-f67a-ed11-9989-0022481ae525 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2022-11-17T00:00:00' + description: Share Capital + reconciled: false + amount: 1 + balance: 1 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 5ced3895-f77a-ed11-9989-0022481b6241 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2022-11-17T00:00:00' + description: Share Capital + reconciled: false + amount: 1 + balance: 2 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: cd12966b-8871-ed11-8c34-6045bd0c6935 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2022-12-02T00:00:00' + description: '' + reconciled: false + amount: -19 + balance: -17 + transactionType: Other + modifiedDate: '2023-03-27T14:21:19Z' + - id: b13392b6-95a0-ed11-9a88-6045bdd16279 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: '' + reconciled: false + amount: -30 + balance: -72 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: b3696a16-1fa2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: 'Income, Services' + reconciled: false + amount: -10 + balance: -122 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: b73392b6-95a0-ed11-9a88-6045bdd16279 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: Child + reconciled: false + amount: -40 + balance: -112 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: befdd569-22a2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: Child Child + reconciled: false + amount: -13 + balance: -160 + transactionType: Other + modifiedDate: '2023-03-27T14:21:19Z' + - id: cb71c33a-22a2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: 'Income, Services' + reconciled: false + amount: -25 + balance: -147 + transactionType: Other + modifiedDate: '2023-03-27T14:21:19Z' + - id: e7ec12c9-94a0-ed11-9a88-6045bdd16279 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: Child Child + reconciled: false + amount: -10 + balance: -27 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: fef7a026-95a0-ed11-9a88-6045bdd16279 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-01-30T00:00:00' + description: '' + reconciled: false + amount: -15 + balance: -42 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 20869cb1-39a2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-01T00:00:00' + description: Accounts Payable + reconciled: false + amount: -14 + balance: -184 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 8c298754-20a2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-01T00:00:00' + description: '' + reconciled: false + amount: -10 + balance: -170 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 935d5578-3ca2-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-01T00:00:00' + description: '' + reconciled: false + amount: -17 + balance: -201 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 935f4303-e3a2-ed11-9a88-002248010b7e + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-01T00:00:00' + description: '' + reconciled: false + amount: -17 + balance: -239 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: d8ceb342-dba2-ed11-9a88-002248010b7e + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-01T00:00:00' + description: '' + reconciled: false + amount: -21 + balance: -222 + transactionType: Other + modifiedDate: '2023-03-27T14:21:19Z' + - id: 15719c0c-22a6-ed11-9a88-002248010b7e + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: -20 + balance: -292.69 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 213d027d-b1a3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: -9.35 + balance: -265.19 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 273d027d-b1a3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: Account no cat Balance Sheet + reconciled: false + amount: -7.5 + balance: -272.69 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 978c4a27-e0a2-ed11-9a88-002248010b7e + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: 2.16 + balance: -236.84 + transactionType: Other + modifiedDate: '2023-03-27T14:21:19Z' + - id: a80f63ae-b0a3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: -7.01 + balance: -262.85 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: ad0f63ae-b0a3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: Account no cat Balance Sheet + reconciled: false + amount: 7.01 + balance: -255.84 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: b5de7b74-afa3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: -4.91 + balance: -260.75 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: bbde7b74-afa3-ed11-9a88-000d3ad59051 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: 4.91 + balance: -255.84 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: f9540bf4-e5a2-ed11-9a88-000d3ad5d945 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-02T00:00:00' + description: '' + reconciled: false + amount: -19 + balance: -255.84 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: feca50d8-22a6-ed11-9a88-002248010b7e + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-06T00:00:00' + description: '' + reconciled: false + amount: -20 + balance: -312.69 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 4777d7ec-cfa6-ed11-9a88-000d3a7fb2e5 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-07T00:00:00' + description: '' + reconciled: false + amount: -2.34 + balance: -315.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 38b632de-7aac-ed11-9a88-002248410639 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-09T00:00:00' + description: Invalid VAT Posting Setup + reconciled: false + amount: -10 + balance: -315.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: ffc0b740-68a8-ed11-9a88-6045bdd12fc1 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-09T00:00:00' + description: '' + reconciled: false + amount: 10 + balance: -305.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 95f27455-7cac-ed11-9a88-002248410639 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-14T00:00:00' + description: '' + reconciled: false + amount: -10 + balance: -325.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 0d6b1378-acae-ed11-9a88-6045bdd16279 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-16T00:00:00' + description: Bank Account Line + reconciled: false + amount: -12 + balance: -337.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 978da9f7-baae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: Bank + reconciled: false + amount: 6 + balance: -342.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: dd34e6eb-b6ae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: G/L + reconciled: false + amount: -1 + balance: -338.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: e234e6eb-b6ae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: Customer + reconciled: false + amount: 2 + balance: -336.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: e734e6eb-b6ae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: Vendor + reconciled: false + amount: -3 + balance: -339.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: ed34e6eb-b6ae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: Bank + reconciled: false + amount: -4 + balance: -343.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: f234e6eb-b6ae-ed11-9a88-6045bdc1c1f3 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-18T00:00:00' + description: Employee + reconciled: false + amount: -5 + balance: -348.03 + transactionType: Payment + modifiedDate: '2023-03-27T14:21:19Z' + - id: 39de1293-d3b1-ed11-9a88-6045bd0f94d6 + accountId: c9a41bc7-6e5b-ed11-8c34-0022481b8b5b + clearedOnDate: '2023-02-21T00:00:00' + description: '' + reconciled: false + amount: -10 + balance: -352.03 + transactionType: Credit + modifiedDate: '2023-03-27T14:21:19Z' + pageNumber: 1 + pageSize: 100 + totalResults: 37 + _links: + current: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts/c9a41bc7-6e5b-ed11-8c34-0022481b8b5b/bankTransactions + self: + href: /companies/d6849caf-c146-41be-8335-b73346e3bd84/connections/60acb117-5cf5-4745-b069-491551da4066/data/bankAccounts/c9a41bc7-6e5b-ed11-8c34-0022481b8b5b/bankTransactions + FreeAgent: + value: + results: + - id: '261197890' + accountId: '738783' + clearedOnDate: '2020-10-28T00:00:00' + description: Invoice receipt against 1762 + reconciled: true + amount: 111 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2020-10-28T16:27:10Z' + - id: '290878530' + accountId: '738783' + clearedOnDate: '2021-04-23T00:00:00' + description: Invoice receipt against 1980 + reconciled: true + amount: 10 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2021-04-27T04:55:42Z' + - id: '290825614' + accountId: '738783' + clearedOnDate: '2021-04-26T00:00:00' + description: Invoice receipt against 1976 + reconciled: true + amount: 10 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2021-04-26T14:05:15Z' + - id: '290878531' + accountId: '738783' + clearedOnDate: '2021-04-26T00:00:00' + description: Invoice receipt against 1981 + reconciled: true + amount: 20 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2021-04-27T04:55:44Z' + - id: '291227300' + accountId: '738783' + clearedOnDate: '2021-04-28T00:00:00' + description: Invoice receipt against 2002 + reconciled: true + amount: 20 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2021-04-28T13:43:56Z' + - id: '291242296' + accountId: '738783' + clearedOnDate: '2021-04-28T00:00:00' + description: Invoice receipt against 2012 + reconciled: true + amount: 40 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2021-04-28T16:14:16Z' + - id: '346437532' + accountId: '738783' + clearedOnDate: '2022-03-21T00:00:00' + description: Invoice receipt against 2304 + reconciled: true + amount: 1 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2022-03-21T14:59:40Z' + - id: '346444438' + accountId: '738783' + clearedOnDate: '2022-03-21T00:00:00' + description: Invoice receipt against 2304 + reconciled: true + amount: 1 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2022-03-21T15:37:54Z' + - id: '346444989' + accountId: '738783' + clearedOnDate: '2022-03-21T00:00:00' + description: Invoice receipt against 2304 + reconciled: true + amount: 1 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2022-03-21T15:41:22Z' + - id: '346457774' + accountId: '738783' + clearedOnDate: '2022-03-21T00:00:00' + description: Credit Note refund against 2313 + reconciled: true + amount: -1 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2022-03-21T17:07:50Z' + - id: '346458196' + accountId: '738783' + clearedOnDate: '2022-03-21T00:00:00' + description: Invoice receipt against 2311 + reconciled: true + amount: 1 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2022-03-21T17:14:15Z' + - id: '414441841' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'MCDONALDS - ROYSTON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -12.78 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441842' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'HERMES PARCELNET LTD T/A - 08445437147 - Card Ending: 2327//OTHER/' + reconciled: false + amount: -7.98 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441845' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'TRAVELODGE GB0000 - THAME - Card Ending: 4999//OTHER/' + reconciled: false + amount: -648.63 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441847' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'TRAVELODGE GB0000 - THAME - Card Ending: 4999//OTHER/' + reconciled: false + amount: -324.31 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441849' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'RUGBY, PRET A MANGER - RUGBY - Card Ending: 9271//OTHER/' + reconciled: false + amount: -11.45 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441851' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'Just Eat - London - Card Ending: 9271//OTHER/' + reconciled: false + amount: -22.52 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441852' + accountId: '738783' + clearedOnDate: '2022-12-20T00:00:00' + description: 'CN TAR TAROM SA-MOBILP - ORAS OTOPENI - Card Ending: 4999//OTHER/' + reconciled: false + amount: -340.13 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441854' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'MOTO RUGBY SERVICES - RUGBY - Card Ending: 9271//OTHER/' + reconciled: false + amount: -126.12 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441855' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'POMANDA.COM - 138 HOLBORN, - Card Ending: 2327//OTHER/' + reconciled: false + amount: -9.99 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441856' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'RYANAIR 224BEZ3YM - LONDON - Card Ending: 4999//OTHER/' + reconciled: false + amount: -267.97 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441857' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'TESCO STORES 5956 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -9.35 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441859' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'SPOTIFY - LONDON - Card Ending: 4999//OTHER/' + reconciled: false + amount: -16.99 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441860' + accountId: '738783' + clearedOnDate: '2022-12-21T00:00:00' + description: 'Revive My Device - London - Card Ending: 5913//OTHER/' + reconciled: false + amount: -149 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441861' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'DELIVEROO - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -39.36 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441862' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'UPS LTD - FELTHAM - Card Ending: 2327//OTHER/' + reconciled: false + amount: -2.4 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:33Z' + - id: '414441863' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'Amazon.co.uk*1N0N04VK4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -17.76 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441864' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'TESCO STORES 5956 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -10.65 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441865' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'GATHER & GATHER 3401 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -16.75 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441866' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'GATHER & GATHER 3401 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -4.55 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441867' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'TRAVELODGE GB0937 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -10.75 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441868' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'DELIVEROO - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -34.2 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441869' + accountId: '738783' + clearedOnDate: '2022-12-22T00:00:00' + description: 'TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/' + reconciled: false + amount: -2.8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441870' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'SIDS DIY - LONDON E1 - Card Ending: 9271//OTHER/' + reconciled: false + amount: -5.99 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441871' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'RESOLUTION GB LTD - WHITCHURCH - Card Ending: 2327//OTHER/' + reconciled: false + amount: -368.72 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441872' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'GATHER & GATHER 3401 - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -6.15 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441874' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'HERMES PARCELNET LTD T/A - 08445437147 - Card Ending: 2327//OTHER/' + reconciled: false + amount: -5.34 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441875' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'Refund: SCREWFIX DIR LTD - WHITECHAP1983 - Card Ending: 9271//OTHER/' + reconciled: false + amount: 6.8 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441876' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'Refund: SCREWFIX DIR LTD - WHITECHAP1983 - Card Ending: 9271//OTHER/' + reconciled: false + amount: 12.49 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441877' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'SCREWFIX DIR LTD - WHITECHAP1983 - Card Ending: 9271//OTHER/' + reconciled: false + amount: -6.5 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441878' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'SCREWFIX DIR LTD - WHITECHAP1983 - Card Ending: 9271//OTHER/' + reconciled: false + amount: -27.15 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441879' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'GOODMANS FIELD - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441880' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'GOODMANS FIELD - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -25.7 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441881' + accountId: '738783' + clearedOnDate: '2022-12-23T00:00:00' + description: 'CREAMLINE DAIRIES ONLINE - MANCHESTER - Card Ending: 2327//OTHER/' + reconciled: false + amount: -50 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:34Z' + - id: '414441883' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'AIRBNB * HMYDEXRY4N - 203-318-1111 - Card Ending: 5913//OTHER/' + reconciled: false + amount: -388.24 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441884' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'UPS LTD - FELTHAM - Card Ending: 2327//OTHER/' + reconciled: false + amount: -9.35 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441886' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 9271//OTHER/' + reconciled: false + amount: -11.9 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441889' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 9271//OTHER/' + reconciled: false + amount: -6.84 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441891' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'WELCOME BREAK - NEWPORT PAGNE - Card Ending: 9271//OTHER/' + reconciled: false + amount: -102.23 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441892' + accountId: '738783' + clearedOnDate: '2022-12-24T00:00:00' + description: 'SUBWAY 63582 London Gatew - Mill Hill, Lo - Card Ending: 9271//OTHER/' + reconciled: false + amount: -15.38 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441893' + accountId: '738783' + clearedOnDate: '2022-12-26T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -40.65 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441894' + accountId: '738783' + clearedOnDate: '2022-12-26T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -2 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441895' + accountId: '738783' + clearedOnDate: '2022-12-26T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -34.06 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441897' + accountId: '738783' + clearedOnDate: '2022-12-26T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -2 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441901' + accountId: '738783' + clearedOnDate: '2022-12-28T00:00:00' + description: 'Tesla - West Drayton - Card Ending: 1332//OTHER/' + reconciled: false + amount: -9.99 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441904' + accountId: '738783' + clearedOnDate: '2022-12-28T00:00:00' + description: 'Box Deansgate - Manchester - Card Ending: 0614//OTHER/' + reconciled: false + amount: -20.65 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441906' + accountId: '738783' + clearedOnDate: '2022-12-28T00:00:00' + description: 'MANCHESTER UNITED KIOSK - MANCHESTER - Card Ending: 0614//OTHER/' + reconciled: false + amount: -26.5 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441908' + accountId: '738783' + clearedOnDate: '2022-12-29T00:00:00' + description: 'TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/' + reconciled: false + amount: -2.8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441909' + accountId: '738783' + clearedOnDate: '2022-12-31T00:00:00' + description: 'TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/' + reconciled: false + amount: -1.65 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441910' + accountId: '738783' + clearedOnDate: '2023-01-01T00:00:00' + description: 'UBER* TRIP - LONDON - Card Ending: 1332//OTHER/' + reconciled: false + amount: -2 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441911' + accountId: '738783' + clearedOnDate: '2023-01-01T00:00:00' + description: 'UBER* TRIP - LONDON - Card Ending: 1332//OTHER/' + reconciled: false + amount: -11.95 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:35Z' + - id: '414441912' + accountId: '738783' + clearedOnDate: '2023-01-02T00:00:00' + description: 'UBER* TRIP - LONDON - Card Ending: 9271//OTHER/' + reconciled: false + amount: -13.68 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441913' + accountId: '738783' + clearedOnDate: '2023-01-02T00:00:00' + description: 'WWW.KASHFLOW.COM - DATCHET - Card Ending: 1332//OTHER/' + reconciled: false + amount: -22.8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441914' + accountId: '738783' + clearedOnDate: '2023-01-02T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -9.14 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441915' + accountId: '738783' + clearedOnDate: '2023-01-02T00:00:00' + description: 'GOOGLE*GSUITE ISOMI.CO - DUBLIN 2 - Card Ending: 1332//OTHER/' + reconciled: false + amount: -216.2 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441916' + accountId: '738783' + clearedOnDate: '2023-01-03T00:00:00' + description: 'Refund: AMZ*quickpickdeals - amazon.co.uk - Card Ending: 4999//OTHER/' + reconciled: false + amount: 10.97 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441917' + accountId: '738783' + clearedOnDate: '2023-01-04T00:00:00' + description: Finance Charge//OTHER/ + reconciled: false + amount: -0.41 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441918' + accountId: '738783' + clearedOnDate: '2023-01-04T00:00:00' + description: 'WWW.KASHFLOW.COM - DATCHET - Card Ending: 1332//OTHER/' + reconciled: false + amount: -22.8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441919' + accountId: '738783' + clearedOnDate: '2023-01-04T00:00:00' + description: 'ACCU.CO.UK - HUDDERSFIELD - Card Ending: 2327//OTHER/' + reconciled: false + amount: -86.34 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441920' + accountId: '738783' + clearedOnDate: '2023-01-04T00:00:00' + description: 'ASDA GROCERIES ONLINE - INTERNET - Card Ending: 2327//OTHER/' + reconciled: false + amount: -6.5 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441922' + accountId: '738783' + clearedOnDate: '2023-01-04T00:00:00' + description: 'AMAZON PRIME*164AU3UZ4 AM - AMZN.CO.UK/PM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -96 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441924' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*162DC7II4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -44.62 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441926' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'trainline - +443332022222 - Card Ending: 5913//OTHER/' + reconciled: false + amount: -65.46 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441931' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'VITAL PARTS LTD - MAIDSTONE - Card Ending: 2327//OTHER/' + reconciled: false + amount: -124.35 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441934' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*168E49IU4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -2.52 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441935' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'ASDA GROCERIES ONLINE - INTERNET - Card Ending: 2327//OTHER/' + reconciled: false + amount: -108.16 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441936' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Refund: ASDA GROCERIES ONLINE - INTERNET - Card Ending: 2327//OTHER/' + reconciled: false + amount: 22.96 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441937' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*1H31B0CO4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -20.52 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:36Z' + - id: '414441939' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*1H4GR4CH4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -13.69 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441941' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*162V47WY4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -16.83 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441945' + accountId: '738783' + clearedOnDate: '2023-01-05T00:00:00' + description: 'Amazon.co.uk*160J00WI4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -17.68 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441946' + accountId: '738783' + clearedOnDate: '2023-01-06T00:00:00' + description: 'Amazon.co.uk*1692Y9YY4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -29.74 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441947' + accountId: '738783' + clearedOnDate: '2023-01-06T00:00:00' + description: 'Amazon.co.uk*166I62Y14 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -29.74 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441948' + accountId: '738783' + clearedOnDate: '2023-01-06T00:00:00' + description: 'GMELIUS GROWTH - MEYRIN - Card Ending: 5913//OTHER/' + reconciled: false + amount: -121.3 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441949' + accountId: '738783' + clearedOnDate: '2023-01-07T00:00:00' + description: 'ACCU.CO.UK - HUDDERSFIELD - Card Ending: 2327//OTHER/' + reconciled: false + amount: -116.34 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441950' + accountId: '738783' + clearedOnDate: '2023-01-07T00:00:00' + description: 'AMZNMktplace - amazon.co.uk - Card Ending: 2327//OTHER/' + reconciled: false + amount: -66.79 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441951' + accountId: '738783' + clearedOnDate: '2023-01-07T00:00:00' + description: 'TOOLSTATION UK - NORTHAMPTON - Card Ending: 2327//OTHER/' + reconciled: false + amount: -77.88 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441952' + accountId: '738783' + clearedOnDate: '2023-01-07T00:00:00' + description: 'SHELL CHESTER - CHESTER - Card Ending: 9271//OTHER/' + reconciled: false + amount: -112.24 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441953' + accountId: '738783' + clearedOnDate: '2023-01-08T00:00:00' + description: 'BRITISH A 1252150515112 - LONDON - Card Ending: 4999//OTHER/' + reconciled: false + amount: -450.85 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441954' + accountId: '738783' + clearedOnDate: '2023-01-08T00:00:00' + description: 'BRITISH A 1254217966962 - LONDON - Card Ending: 4999//OTHER/' + reconciled: false + amount: -65 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441955' + accountId: '738783' + clearedOnDate: '2023-01-08T00:00:00' + description: 'TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/' + reconciled: false + amount: -3.3 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441956' + accountId: '738783' + clearedOnDate: '2023-01-09T00:00:00' + description: 'Amazon.co.uk*1H97Y6TL4 - AMAZON.CO.UK - Card Ending: 2327//OTHER/' + reconciled: false + amount: -17.45 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441957' + accountId: '738783' + clearedOnDate: '2023-01-09T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -15.03 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441959' + accountId: '738783' + clearedOnDate: '2023-01-09T00:00:00' + description: 'UBER *TRIP - HELP.UBER.COM - Card Ending: 1332//OTHER/' + reconciled: false + amount: -16.43 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441960' + accountId: '738783' + clearedOnDate: '2023-01-09T00:00:00' + description: Payment made (BACS)//OTHER/ + reconciled: false + amount: 5000 + transactionType: Credit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:37Z' + - id: '414441961' + accountId: '738783' + clearedOnDate: '2023-01-10T00:00:00' + description: 'AMZNMktplace - amazon.co.uk - Card Ending: 2327//OTHER/' + reconciled: false + amount: -32.57 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:38Z' + - id: '414441962' + accountId: '738783' + clearedOnDate: '2023-01-10T00:00:00' + description: 'TESCO STORES - LONDON - Card Ending: 5913//OTHER/' + reconciled: false + amount: -3.9 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:38Z' + - id: '414441963' + accountId: '738783' + clearedOnDate: '2023-01-10T00:00:00' + description: 'VICTORIA INN - PECKHAM - Card Ending: 5913//OTHER/' + reconciled: false + amount: -15.5 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:38Z' + - id: '414441965' + accountId: '738783' + clearedOnDate: '2023-01-10T00:00:00' + description: 'TFL TRAVEL CH - TFL.GOV.UK/CP - Card Ending: 5913//OTHER/' + reconciled: false + amount: -7.7 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:38Z' + - id: '414441967' + accountId: '738783' + clearedOnDate: '2023-01-10T00:00:00' + description: 'PRET A MANGER - 326 - Card Ending: 5913//OTHER/' + reconciled: false + amount: -13.8 + transactionType: Debit + modifiedDate: '2023-04-25T14:21:41Z' + sourceModifiedDate: '2023-02-08T09:05:38Z' + pageNumber: 1 + pageSize: 100 + totalResults: 153 + _links: + current: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts/738783/bankTransactions + self: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts/738783/bankTransactions + next: + href: /companies/071ad738-68f3-4561-afd0-69bab9df0803/connections/4fd7c69f-ecc1-45f5-83f2-42ed3391e386/data/bankAccounts/738783/bankTransactions?page=2&pageSize=100 + KashFlow: + value: + results: + - id: '765768:137014109' + accountId: '765768' + clearedOnDate: '2020-04-28T00:00:00' + description: FIRST Transaction + reconciled: false + amount: 100 + transactionType: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + - id: '765768:137014143' + accountId: '765768' + clearedOnDate: '2020-04-28T00:00:00' + description: SECOND Transaction + reconciled: false + amount: 120 + transactionType: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + - id: '765768:93269803' + accountId: '765768' + clearedOnDate: '2020-04-28T00:00:00' + description: 'KF00021:' + reconciled: false + amount: -5 + transactionType: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + - id: '765768:141203309' + accountId: '765768' + clearedOnDate: '2020-06-18T00:00:00' + description: 'INV #33: Customer overpayment' + reconciled: false + amount: 110 + transactionType: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + - id: '765768:144653342' + accountId: '765768' + clearedOnDate: '2020-10-23T00:00:00' + description: '' + reconciled: false + amount: 1 + transactionType: Unknown + modifiedDate: '2022-09-30T10:29:15Z' + pageNumber: 1 + pageSize: 100 + totalResults: 5 + _links: + current: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts/765768/bankTransactions + self: + href: /companies/3a707a99-89da-4b16-a5d6-595333a16352/connections/ecab4f64-1a04-4c53-a343-bfd879f41f67/data/bankAccounts/765768/bankTransactions + QuickBooks Desktop: + value: + results: + - id: D7B-933784104 + accountId: 20000-933270541 + clearedOnDate: '2022-12-01T00:00:00' + description: '' + reconciled: false + amount: -1200 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:10' + - id: DFA-933785132 + accountId: 20000-933270541 + clearedOnDate: '2022-12-05T00:00:00' + description: '' + reconciled: false + amount: -35 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:11' + - id: E2E-933785785 + accountId: 20000-933270541 + clearedOnDate: '2022-12-10T00:00:00' + description: '' + reconciled: false + amount: -197.59 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:11' + - id: 536B-1197755199 + accountId: 20000-933270541 + clearedOnDate: '2022-12-20T00:00:00' + description: '' + reconciled: false + amount: -2100 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:47' + - id: 5C18-1197711471-to + accountId: 20000-933270541 + clearedOnDate: '2022-12-31T00:00:00' + description: Opening Balance - Bank Balance - Checking Account + reconciled: false + amount: 27874.62 + transactionType: Other + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:06' + - id: 3A09-1071529982 + accountId: 20000-933270541 + clearedOnDate: '2023-01-11T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:58' + - id: 95C6-1197729008 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: 941 Deposit for December 2005 Payyroll + reconciled: false + amount: -3495.82 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:19' + - id: 95CA-1197729081 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: FUTA Payment - 4 Qrt 2005 + reconciled: false + amount: -100 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:19' + - id: 95D0-1197729222 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: State Unemployment and Disability - 4th Quarter 2005 + reconciled: false + amount: -208.09 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:19' + - id: 95D4-1197729376 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: Worker's Compensation - 4th Quarter 2005 + reconciled: false + amount: -1214.31 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:19' + - id: 9C06-1181931827 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: Deposit + reconciled: false + amount: 1228.18 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:23' + - id: 9E3A-1182063799 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: '' + reconciled: false + amount: -308.34 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: A293-1197953458 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: '' + reconciled: false + amount: -12362.89 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2AB-1197953786 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: '' + reconciled: false + amount: -9521 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A33E-1197955762 + accountId: 20000-933270541 + clearedOnDate: '2023-01-15T00:00:00' + description: ABCD 11-234567 + reconciled: false + amount: -3146.88 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 6992-1197775718 + accountId: 20000-933270541 + clearedOnDate: '2023-01-17T00:00:00' + description: Deposit + reconciled: false + amount: 15281.67 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:11' + - id: 3E5D-1071498699 + accountId: 20000-933270541 + clearedOnDate: '2023-01-21T00:00:00' + description: 786-35 + reconciled: false + amount: -712.56 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:09' + - id: 699D-1197775731 + accountId: 20000-933270541 + clearedOnDate: '2023-01-25T00:00:00' + description: Deposit + reconciled: false + amount: 31474.25 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:11' + - id: 53D-933354764 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:00' + - id: 9E3D-1182131998 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: '' + reconciled: false + amount: -205 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9E42-1182131999 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: '' + reconciled: false + amount: -532 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9E47-1182131999 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: '' + reconciled: false + amount: -623 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9E4C-1182131999 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: '' + reconciled: false + amount: -13759 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9ED6-1182133365 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: Fuel + reconciled: false + amount: -138 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F2D-1197948760 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: Monthly Vehicle Repairs and Maintenance + reconciled: false + amount: -218 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F96-1197949640 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -123.67 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: A2CD-1197955250 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: Pmt# 1 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: F29-933787474 + accountId: 20000-933270541 + clearedOnDate: '2023-01-31T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:13' + - id: 698D-1197775698 + accountId: 20000-933270541 + clearedOnDate: '2023-02-02T00:00:00' + description: Deposit + reconciled: false + amount: 1040 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:11' + - id: 69A8-1197775740 + accountId: 20000-933270541 + clearedOnDate: '2023-02-09T00:00:00' + description: Deposit + reconciled: false + amount: 271.53 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:11' + - id: 3A10-1071529997 + accountId: 20000-933270541 + clearedOnDate: '2023-02-11T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:58' + - id: A0BD-1197950967 + accountId: 20000-933270541 + clearedOnDate: '2023-02-15T00:00:00' + description: '' + reconciled: false + amount: -268.39 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2AF-1197953842 + accountId: 20000-933270541 + clearedOnDate: '2023-02-15T00:00:00' + description: '' + reconciled: false + amount: -4050.98 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A343-1197955826 + accountId: 20000-933270541 + clearedOnDate: '2023-02-15T00:00:00' + description: ABCD 11-234567 + reconciled: false + amount: -1466.32 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 9C0B-1181931843 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Deposit + reconciled: false + amount: 25471.56 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:23' + - id: 9E63-1182132109 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: For Vetter Basement Remodel + reconciled: false + amount: -2050 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9ED9-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Fuel + reconciled: false + amount: -142 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F33-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -222 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F99-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -125.89 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FBD-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A052-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A081-1197950831 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2D1-1197955271 + accountId: 20000-933270541 + clearedOnDate: '2023-02-28T00:00:00' + description: Pmt# 2 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 3A17-1071530007 + accountId: 20000-933270541 + clearedOnDate: '2023-03-11T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:58' + - id: 9C38-1182054225 + accountId: 20000-933270541 + clearedOnDate: '2023-03-13T00:00:00' + description: '' + reconciled: false + amount: -7500 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:24' + - id: A296-1197953484 + accountId: 20000-933270541 + clearedOnDate: '2023-03-15T00:00:00' + description: '' + reconciled: false + amount: -1600 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A346-1197955854 + accountId: 20000-933270541 + clearedOnDate: '2023-03-15T00:00:00' + description: ABCD 11-234567 + reconciled: false + amount: -83.6 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 9C10-1181931855 + accountId: 20000-933270541 + clearedOnDate: '2023-03-20T00:00:00' + description: Deposit + reconciled: false + amount: 6278.8 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:23' + - id: 9E72-1182132247 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: '' + reconciled: false + amount: -435 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:30' + - id: 9EDC-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Fuel + reconciled: false + amount: -127 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F36-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -232 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F7B-1197949443 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Payment - Quarterly Office Maintenance Contract + reconciled: false + amount: -450 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F9C-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -389.2 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FC0-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A056-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A084-1197950832 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2D5-1197955280 + accountId: 20000-933270541 + clearedOnDate: '2023-03-31T00:00:00' + description: Pmt# 3 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 3A1E-1071530019 + accountId: 20000-933270541 + clearedOnDate: '2023-04-12T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:58' + - id: 4271-1071523732 + accountId: 20000-933270541 + clearedOnDate: '2023-04-17T00:00:00' + description: '' + reconciled: false + amount: -714 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:32' + - id: 3E98-1071499056 + accountId: 20000-933270541 + clearedOnDate: '2023-04-19T00:00:00' + description: 786-35 + reconciled: false + amount: -712.56 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:11' + - id: 9C68-1182054440 + accountId: 20000-933270541 + clearedOnDate: '2023-04-20T00:00:00' + description: Deposit + reconciled: false + amount: 16500 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:24' + - id: 9EDF-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Fuel + reconciled: false + amount: -162 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F39-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -192 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F9F-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -120.93 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FC3-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A05A-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A087-1197950832 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2D9-1197955286 + accountId: 20000-933270541 + clearedOnDate: '2023-04-30T00:00:00' + description: Pmt# 4 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 9C86-1182054823 + accountId: 20000-933270541 + clearedOnDate: '2023-05-01T00:00:00' + description: '' + reconciled: false + amount: -7500 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:24' + - id: 3A25-1071530029 + accountId: 20000-933270541 + clearedOnDate: '2023-05-13T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:59' + - id: A0C0-1197950991 + accountId: 20000-933270541 + clearedOnDate: '2023-05-15T00:00:00' + description: '' + reconciled: false + amount: -950.23 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A299-1197953515 + accountId: 20000-933270541 + clearedOnDate: '2023-05-15T00:00:00' + description: '' + reconciled: false + amount: -1400 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A349-1197955899 + accountId: 20000-933270541 + clearedOnDate: '2023-05-15T00:00:00' + description: ABCD 11-234567 + reconciled: false + amount: -318.02 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 9CB8-1182055085 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Deposit + reconciled: false + amount: 16500 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:25' + - id: 9EE2-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Fuel + reconciled: false + amount: -143 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F3C-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -232 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FA2-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -128.03 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FC6-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A05E-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A08A-1197950832 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2DD-1197955294 + accountId: 20000-933270541 + clearedOnDate: '2023-05-31T00:00:00' + description: Pmt# 5 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 9CBD-1182055262 + accountId: 20000-933270541 + clearedOnDate: '2023-06-06T00:00:00' + description: '' + reconciled: false + amount: -5275 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:25' + - id: 3A2C-1071530042 + accountId: 20000-933270541 + clearedOnDate: '2023-06-10T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:59' + - id: 5356-1197761596 + accountId: 20000-933270541 + clearedOnDate: '2023-06-16T00:00:00' + description: '' + reconciled: false + amount: -1786 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:46' + - id: 9EE5-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Fuel + reconciled: false + amount: -157 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F3F-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -186 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9F7E-1197949458 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Payment - Quarterly Office Maintenance Contract + reconciled: false + amount: -450 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FA5-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -135.02 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FC9-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A062-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A08D-1197950832 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Checking Account Service Charge + reconciled: false + amount: -12.5 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: A2E1-1197955306 + accountId: 20000-933270541 + clearedOnDate: '2023-06-30T00:00:00' + description: Pmt# 6 + reconciled: false + amount: -2710.9 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:36' + - id: 3A33-1071530066 + accountId: 20000-933270541 + clearedOnDate: '2023-07-11T00:00:00' + description: Monthly Truck Payment + reconciled: false + amount: -532.97 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:04:59' + - id: 3E67-1071498733 + accountId: 20000-933270541 + clearedOnDate: '2023-07-19T00:00:00' + description: 786-35 + reconciled: false + amount: -712.56 + transactionType: Unknown + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:05:09' + - id: A0C3-1197951027 + accountId: 20000-933270541 + clearedOnDate: '2023-07-23T00:00:00' + description: '' + reconciled: false + amount: -239.29 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:35' + - id: 9EE8-1182133383 + accountId: 20000-933270541 + clearedOnDate: '2023-07-31T00:00:00' + description: Fuel + reconciled: false + amount: -126 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:32' + - id: 9F42-1197948806 + accountId: 20000-933270541 + clearedOnDate: '2023-07-31T00:00:00' + description: Monthly Vechiicle Repairs and Maintenance + reconciled: false + amount: -126 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FA8-1197949656 + accountId: 20000-933270541 + clearedOnDate: '2023-07-31T00:00:00' + description: 'Acct #560-82645-99C' + reconciled: false + amount: -128.03 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:33' + - id: 9FCC-1197949852 + accountId: 20000-933270541 + clearedOnDate: '2023-07-31T00:00:00' + description: Monthly Water - Flat Rate Plan + reconciled: false + amount: -24 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + - id: A066-1197950680 + accountId: 20000-933270541 + clearedOnDate: '2023-07-31T00:00:00' + description: Flat Rate Phone and Long Distance Bundle + reconciled: false + amount: -80 + transactionType: Payment + modifiedDate: '2023-04-26T09:07:14Z' + sourceModifiedDate: '2023-12-16T05:06:34' + pageNumber: 1 + pageSize: 100 + totalResults: 495 + _links: + current: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts/20000-933270541/bankTransactions + self: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts/20000-933270541/bankTransactions + next: + href: /companies/fc72ba08-af13-4474-b28a-01dcfa6cfb51/connections/2c26b4da-97d4-4ba9-baad-1e18b49b96ac/data/bankAccounts/20000-933270541/bankTransactions?page=2&pageSize=100 + Sage 50 (UK): + value: + results: + - id: '73' + accountId: '1200' + clearedOnDate: '2021-01-29T00:00:00' + description: DD/STO + reconciled: false + amount: -162 + balance: -10164.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '52' + accountId: '1200' + clearedOnDate: '2021-01-30T00:00:00' + description: '568953' + reconciled: false + amount: -1497.58 + balance: -10302.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '53' + accountId: '1200' + clearedOnDate: '2021-01-30T00:00:00' + description: '5897532' + reconciled: false + amount: 500 + balance: -9802.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '54' + accountId: '1200' + clearedOnDate: '2021-01-30T00:00:00' + description: TRANS + reconciled: false + amount: -250 + balance: -10052.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '58' + accountId: '1200' + clearedOnDate: '2021-01-30T00:00:00' + description: VOID + reconciled: false + amount: 50 + balance: -10002.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '50' + accountId: '1200' + clearedOnDate: '2021-01-31T00:00:00' + description: TRANS + reconciled: false + amount: -500 + balance: -8804.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '85' + accountId: '1200' + clearedOnDate: '2021-01-31T00:00:00' + description: '6565689' + reconciled: false + amount: -1800 + balance: -11964.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '97' + accountId: '1200' + clearedOnDate: '2021-01-31T00:00:00' + description: Salary + reconciled: false + amount: -5932.29 + balance: -17896.83 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1183' + accountId: '1200' + clearedOnDate: '2021-09-01T00:00:00' + description: DD/STO + reconciled: false + amount: -162 + balance: 11299.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1184' + accountId: '1200' + clearedOnDate: '2021-09-15T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 10099.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1185' + accountId: '1200' + clearedOnDate: '2021-09-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 9949.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1186' + accountId: '1200' + clearedOnDate: '2021-09-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 9944.36 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1187' + accountId: '1200' + clearedOnDate: '2021-10-13T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 8744.36 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1188' + accountId: '1200' + clearedOnDate: '2021-10-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 8594.36 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1189' + accountId: '1200' + clearedOnDate: '2021-10-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 8588.81 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1190' + accountId: '1200' + clearedOnDate: '2021-11-10T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 7388.81 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1191' + accountId: '1200' + clearedOnDate: '2021-11-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 7238.81 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1192' + accountId: '1200' + clearedOnDate: '2021-11-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 7233.26 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1193' + accountId: '1200' + clearedOnDate: '2021-12-08T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 6033.26 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1194' + accountId: '1200' + clearedOnDate: '2021-12-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 5883.26 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1195' + accountId: '1200' + clearedOnDate: '2021-12-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 5877.71 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '24' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: O/Bal + reconciled: true + amount: -6511.96 + balance: -6511.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '26' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '56956' + reconciled: false + amount: 55 + balance: -6456.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '27' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '656678' + reconciled: false + amount: -150 + balance: -6606.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '28' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '656679' + reconciled: false + amount: -352 + balance: -6958.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '29' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '656680' + reconciled: false + amount: -550 + balance: -7508.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '30' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '656681' + reconciled: false + amount: -250 + balance: -7758.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '31' + accountId: '1200' + clearedOnDate: '2021-12-31T00:00:00' + description: '656869' + reconciled: false + amount: -546 + balance: -8304.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1196' + accountId: '1200' + clearedOnDate: '2022-01-01T00:00:00' + description: DD/STO + reconciled: false + amount: -162 + balance: 5715.71 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1197' + accountId: '1200' + clearedOnDate: '2022-01-05T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 4515.71 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1198' + accountId: '1200' + clearedOnDate: '2022-01-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 4365.71 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1199' + accountId: '1200' + clearedOnDate: '2022-01-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 4360.16 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '255' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: (BACS) + reconciled: false + amount: -370.71 + balance: -18267.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '256' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100001' + reconciled: false + amount: -256.36 + balance: -18523.9 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '257' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100002' + reconciled: false + amount: -25.5 + balance: -18549.4 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '258' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100003' + reconciled: false + amount: -1977.58 + balance: -20526.98 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '259' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100004' + reconciled: false + amount: -599.03 + balance: -21126.01 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '260' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100005' + reconciled: false + amount: -7141.98 + balance: -28267.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '261' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100006' + reconciled: false + amount: -150.96 + balance: -28418.95 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '262' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100007' + reconciled: false + amount: -63 + balance: -28481.95 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '263' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100008' + reconciled: false + amount: -35.01 + balance: -28516.96 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '264' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '100009' + reconciled: false + amount: -1659.34 + balance: -30176.3 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '265' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '4353454' + reconciled: false + amount: 1432.17 + balance: -28744.13 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '266' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 2684.26 + balance: -26059.87 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '267' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 1204.57 + balance: -24855.3 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '268' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 1140.78 + balance: -23714.52 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '269' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 4372 + balance: -19342.52 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '270' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 1946.18 + balance: -17396.34 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '271' + accountId: '1200' + clearedOnDate: '2022-01-29T00:00:00' + description: '' + reconciled: false + amount: 11123.33 + balance: -6273.01 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1200' + accountId: '1200' + clearedOnDate: '2022-02-02T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 3160.16 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '300' + accountId: '1200' + clearedOnDate: '2022-02-03T00:00:00' + description: TRANS + reconciled: false + amount: -500 + balance: -16588.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1201' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 3010.16 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1202' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 3004.61 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '276' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Credit + reconciled: false + amount: -500 + balance: -6773.01 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '279' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: '' + reconciled: false + amount: -58.75 + balance: -6831.76 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '280' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: TRANS + reconciled: false + amount: -1400 + balance: -8231.76 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '282' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: TRANS + reconciled: false + amount: -12600 + balance: -20831.76 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '286' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: TRANS + reconciled: false + amount: 6500 + balance: -14331.76 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '287' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: PAYE + reconciled: false + amount: -1256.33 + balance: -15588.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '288' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Deposit + reconciled: false + amount: -500 + balance: -16088.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '314' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: DD/STO + reconciled: false + amount: -162 + balance: -16750.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '315' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: -17950.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '325' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Loan + reconciled: false + amount: -150 + balance: -18100.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '326' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Loan + reconciled: false + amount: -5.55 + balance: -18105.64 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '328' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Returned + reconciled: false + amount: 103.4 + balance: -18002.24 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '331' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: Salary + reconciled: false + amount: -5932.29 + balance: -23934.53 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '523' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: '' + reconciled: false + amount: 6556.33 + balance: -17378.2 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '525' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: '' + reconciled: false + amount: 3350.33 + balance: -14027.87 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '526' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: (BACS) + reconciled: false + amount: -435.14 + balance: -14463.01 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '529' + accountId: '1200' + clearedOnDate: '2022-02-28T00:00:00' + description: '12324' + reconciled: false + amount: -8561.48 + balance: -23024.49 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '532' + accountId: '1200' + clearedOnDate: '2022-03-01T00:00:00' + description: VOID + reconciled: false + amount: 352.5 + balance: -22671.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '534' + accountId: '1200' + clearedOnDate: '2022-03-01T00:00:00' + description: SED + reconciled: false + amount: 55 + balance: -22616.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1203' + accountId: '1200' + clearedOnDate: '2022-03-02T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: 1804.61 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '821' + accountId: '1200' + clearedOnDate: '2022-03-10T00:00:00' + description: '' + reconciled: false + amount: 1908.89 + balance: -14370.08 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '820' + accountId: '1200' + clearedOnDate: '2022-03-20T00:00:00' + description: '776' + reconciled: false + amount: 9057.34 + balance: -16278.97 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '606' + accountId: '1200' + clearedOnDate: '2022-03-24T00:00:00' + description: Deposit + reconciled: false + amount: -150 + balance: -22370.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '607' + accountId: '1200' + clearedOnDate: '2022-03-25T00:00:00' + description: '44555' + reconciled: false + amount: 100 + balance: -22270.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '823' + accountId: '1200' + clearedOnDate: '2022-03-25T00:00:00' + description: '' + reconciled: false + amount: 1770.15 + balance: -12229.5 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '578' + accountId: '1200' + clearedOnDate: '2022-03-27T00:00:00' + description: '456' + reconciled: false + amount: -15 + balance: -22084.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '608' + accountId: '1200' + clearedOnDate: '2022-03-27T00:00:00' + description: CREDIT + reconciled: false + amount: -100 + balance: -22370.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '824' + accountId: '1200' + clearedOnDate: '2022-03-27T00:00:00' + description: '' + reconciled: false + amount: 1025.86 + balance: -11203.64 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1204' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: 1654.61 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '1205' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: 1649.06 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '546' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -162 + balance: -22778.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '547' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -1200 + balance: -23978.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '548' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -150 + balance: -24128.99 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '549' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: DD/STO + reconciled: false + amount: -5.55 + balance: -24134.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '555' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: VOID + reconciled: false + amount: 50 + balance: -24084.54 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '560' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: REFUND + reconciled: false + amount: 64.63 + balance: -24019.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '562' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: TRANS + reconciled: false + amount: 2000 + balance: -22019.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '563' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: TRANS + reconciled: false + amount: -50 + balance: -22069.91 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '584' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: CREDIT + reconciled: false + amount: -70.31 + balance: -22155.22 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '589' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: VOID + reconciled: false + amount: 30 + balance: -22125.22 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '596' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: REFUND + reconciled: false + amount: 35.01 + balance: -22090.21 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '597' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: PAYE + reconciled: false + amount: -2070.23 + balance: -24160.44 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '598' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: NI + reconciled: false + amount: -1003.49 + balance: -25163.93 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '604' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: TRANS + reconciled: false + amount: 3000 + balance: -22163.93 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '605' + accountId: '1200' + clearedOnDate: '2022-03-28T00:00:00' + description: '225' + reconciled: false + amount: -56.16 + balance: -22220.09 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '612' + accountId: '1200' + clearedOnDate: '2022-03-29T00:00:00' + description: NI + reconciled: false + amount: -1003.49 + balance: -29305.87 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + - id: '614' + accountId: '1200' + clearedOnDate: '2022-03-29T00:00:00' + description: Sales + reconciled: false + amount: 179.2 + balance: -29126.67 + transactionType: Credit + modifiedDate: '2023-03-30T14:42:44Z' + sourceModifiedDate: '2022-11-25T09:43:54' + pageNumber: 1 + pageSize: 100 + totalResults: 179 + _links: + current: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts/1200/bankTransactions + self: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts/1200/bankTransactions + next: + href: /companies/cf5f2a47-2990-4221-bae6-0c19c86ac304/connections/8ee4910f-4fc1-47e6-89b1-5931fb33d8f7/data/bankAccounts/1200/bankTransactions?page=2&pageSize=100 + Sage Business Cloud Accounting: + value: + results: + - id: 26b727ca84734e3c8e245011bd04dbf1 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-02-05T00:00:00' + description: string Supplier Payment + reconciled: false + amount: -5 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-02-07T11:35:39Z' + - id: 508f3fd4403e45cb903b362a4ae55344 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-02-05T00:00:00' + description: string Supplier Payment + reconciled: false + amount: -3.86 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-02-10T10:51:43Z' + - id: 52e58431005e44328af44116e0433230 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-02-05T00:00:00' + description: string Supplier Payment + reconciled: false + amount: -3.85 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-02-07T14:36:01Z' + - id: f3255e4b79c5427ba5b963d0e26cecfc + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-02-05T00:00:00' + description: string Supplier Payment + reconciled: false + amount: -3.86 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-02-07T14:19:24Z' + - id: a00e1ce357cc4064b9cce8abe1b15110 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-04-21T00:00:00' + description: Cash Deposit Bank Transfer + reconciled: false + amount: 1000 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-04-21T21:03:25Z' + - id: a7d26740129945c3a76209020fbb7fd1 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2020-11-25T00:00:00' + description: Bank Transfer + reconciled: false + amount: -40 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2020-11-25T19:35:03Z' + - id: 829f45112347471cbf99b0d9afe08113 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-07-02T00:00:00' + description: Made from codat api Customer Receipt + reconciled: false + amount: 10 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-07-02T13:14:57Z' + - id: 786f769ae88a4fa898e25e2cbff43be3 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-07-20T00:00:00' + description: Supplier payment AD Supplier Payment + reconciled: false + amount: -2400 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-07-22T14:12:38Z' + - id: abb5995867c546c2b32097d515dcef2a + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-07-21T00:00:00' + description: Payment Customer Receipt + reconciled: false + amount: 12 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-07-21T14:09:59Z' + - id: 943f3bd6eacc4071807d89895fe03ef4 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-08-17T00:00:00' + description: Ref5565 Other Receipt + reconciled: false + amount: 50 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-08-17T11:58:37Z' + - id: 039e6bb20b6e44d690601e4dd04a5b21 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-09-22T00:00:00' + description: Note 1 Customer Receipt + reconciled: false + amount: 1080 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-09-22T14:22:57Z' + - id: 1a62f54358e74ba4a71dd733f2b08ba4 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-09-27T00:00:00' + description: Note 2 Customer Receipt + reconciled: false + amount: 1080 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-09-27T14:04:05Z' + - id: a79ebcf0710d415baad6b588eb28307b + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2021-12-01T00:00:00' + description: Payment Customer Receipt + reconciled: false + amount: 33 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2021-12-01T13:03:00Z' + - id: 4b691b78b6cd43c9a64d75aeb29e4d11 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-07-19T00:00:00' + description: Bank Transfer + reconciled: false + amount: -10 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2022-07-19T08:51:52Z' + - id: 7b1f2f55f39042838d5f7226aa92386f + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-07-19T00:00:00' + description: Bank Transfer + reconciled: false + amount: -1415 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2022-07-19T13:15:26Z' + - id: 87eca750292b4cfea216e13bb22923c6 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-07-19T00:00:00' + description: Bank Transfer + reconciled: false + amount: -10 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2022-07-19T13:01:47Z' + - id: a48474f83d214637a700e76e24446086 + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-07-19T00:00:00' + description: Bank Transfer + reconciled: false + amount: -10 + transactionType: Credit + modifiedDate: '2022-10-24T15:31:14Z' + sourceModifiedDate: '2022-07-19T13:10:42Z' + - id: cc1fc960e05c40c1968314efe1175b9f + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-09-14T00:00:00' + description: string Customer Receipt + reconciled: false + amount: 69 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:15Z' + sourceModifiedDate: '2022-09-14T16:20:09Z' + - id: e600eb7549b74d96bdca18b9cc60f39d + accountId: 154d05abe9f24c4babe0f6a741dec1b9 + clearedOnDate: '2022-09-14T00:00:00' + description: Customer Receipt + reconciled: false + amount: 60 + transactionType: Debit + modifiedDate: '2022-10-24T15:31:15Z' + sourceModifiedDate: '2022-09-14T16:12:03Z' + pageNumber: 1 + pageSize: 100 + totalResults: 19 + _links: + current: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts/154d05abe9f24c4babe0f6a741dec1b9/bankTransactions + self: + href: /companies/390083e2-351b-407c-a3be-55081c36c182/connections/37916fb7-b4b8-4a78-8872-1751e20ee0cd/data/bankAccounts/154d05abe9f24c4babe0f6a741dec1b9/bankTransactions + Xero: + value: + results: + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2021-12-20T00:00:00' + description: DD + counterparty: DIISR + reconciled: true + amount: -7267.2 + balance: -3136.22 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-02-17T00:00:00' + description: DD + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -5703.42 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-02-17T00:00:00' + description: INV0010 + counterparty: MADDOX PUBLISHING GP + reconciled: true + amount: 4200 + balance: -6203.42 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-02-17T00:00:00' + description: DD + counterparty: DIISR + reconciled: true + amount: -7267.2 + balance: -10403.42 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-02-19T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -95.5 + balance: -5798.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-03-19T00:00:00' + description: DD + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -5298.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-03-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -97 + balance: -5395.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-04-19T00:00:00' + description: INV-0003 + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -4895.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-04-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -92 + balance: -4987.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-05-21T00:00:00' + description: INV-0004 + counterparty: Ridgeway University + reconciled: true + amount: 1000 + balance: -3987.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-05-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -89 + balance: -4076.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-06-19T00:00:00' + description: INV-005 + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -3576.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-06-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -91 + balance: -3667.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-07-20T00:00:00' + description: INV-006 + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -3167.92 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-07-22T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -96.25 + balance: -3264.17 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-08-19T00:00:00' + description: INV-007 + counterparty: Ridgeway University + reconciled: true + amount: 1500 + balance: -1764.17 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-08-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -100.6 + balance: -1864.77 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-09-19T00:00:00' + description: INV-008 + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: -1364.77 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-09-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -105.75 + balance: -1470.52 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-10-19T00:00:00' + description: INV-009 + counterparty: Ridgeway University + reconciled: true + amount: 1200 + balance: -270.52 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-10-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -106.5 + balance: -377.02 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-20T00:00:00' + description: INV-0010 + counterparty: Ridgeway University + reconciled: true + amount: 500 + balance: 122.98 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-21T00:00:00' + description: DD + counterparty: PowerDirect + reconciled: true + amount: -119.08 + balance: 3.9 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-22T00:00:00' + description: Monthly a/c fee + counterparty: Ridgeway Banking Corporation + reconciled: true + amount: -15 + balance: -11.1 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: FP089876 + counterparty: FastPay + reconciled: true + amount: -3126.17 + balance: -1591.58 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: Subs DD + counterparty: Xero + reconciled: true + amount: -56.35 + balance: -89.16 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: '0015' + counterparty: Rex Media Group + reconciled: true + amount: 541.25 + balance: 1534.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: INV-0014 + counterparty: Port & Philip Freight + reconciled: true + amount: 541.25 + balance: 993.34 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: '' + counterparty: Office Supplies Company + reconciled: true + amount: -21.71 + balance: -32.81 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-23T00:00:00' + description: INV-0013 + counterparty: Young Brothers + reconciled: true + amount: 541.25 + balance: 452.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-11-24T00:00:00' + description: INV0012 + counterparty: Hamilton Smith + reconciled: true + amount: 541.25 + balance: -1050.33 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-01T00:00:00' + description: '' + counterparty: Woolworths Oaktown + reconciled: true + amount: -65.2 + balance: -1115.53 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-02T00:00:00' + description: '' + counterparty: Berry Brew Cafe + reconciled: true + amount: -15.6 + balance: -1131.13 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-09T00:00:00' + description: AR-0019 + counterparty: Bank West + reconciled: true + amount: 1500 + balance: 368.87 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-11T00:00:00' + description: CHQ 6543-000409 + counterparty: Melrose Parking Services + reconciled: true + amount: -148.5 + balance: 220.37 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-16T00:00:00' + description: '' + counterparty: Espresso 31 Ltd + reconciled: true + amount: -16 + balance: 204.37 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-19T00:00:00' + description: '' + counterparty: Brunswick Flower Suppliers T/A Brunswick Petals + reconciled: true + amount: -50 + balance: 154.37 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-20T00:00:00' + description: AR-0011 + counterparty: Ridgeway University + reconciled: true + amount: 2500 + balance: 2583.57 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-20T00:00:00' + description: '' + counterparty: Mobil + reconciled: true + amount: -70.8 + balance: 83.57 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-23T00:00:00' + description: '' + counterparty: PC Complete + reconciled: true + amount: -1463.88 + balance: 1449.49 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-23T00:00:00' + description: AR-0018 + counterparty: City Agency + reconciled: true + amount: 329.8 + balance: 2913.37 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-23T00:00:00' + description: Bank Fee + counterparty: Ridgeway Banking Corporation + reconciled: true + amount: -15 + balance: 1434.49 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-23T00:00:00' + description: '' + counterparty: Truxton Property Management + reconciled: true + amount: -1181.25 + balance: 253.24 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2022-12-29T00:00:00' + description: FP101897 + counterparty: FastPay + reconciled: false + amount: -1223.91 + balance: -970.67 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-19T00:00:00' + description: '' + counterparty: Net Connect + reconciled: true + amount: -98.32 + balance: -1177.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-19T00:00:00' + description: '' + counterparty: Power Direct + reconciled: true + amount: -108.6 + balance: -1079.27 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-19T00:00:00' + description: AR-0020 + counterparty: Ridgeway University + reconciled: true + amount: 6187.5 + balance: 5009.91 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-20T00:00:00' + description: '' + counterparty: Truxton Property Management + reconciled: true + amount: -1181.25 + balance: 3828.66 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-20T00:00:00' + description: '' + counterparty: Swantston Security + reconciled: true + amount: -59.54 + balance: 3769.12 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-21T00:00:00' + description: '' + counterparty: Xero + reconciled: true + amount: -56.35 + balance: 3712.77 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-22T00:00:00' + description: INV0022 + counterparty: Petrie McLoud + reconciled: true + amount: 1407.25 + balance: 5120.02 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-23T00:00:00' + description: '0024' + counterparty: Boom FM + reconciled: true + amount: 1000 + balance: 6120.02 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-24T00:00:00' + description: CHQ 6543-000410 + counterparty: Melrose Parking + reconciled: true + amount: -148.5 + balance: 5971.52 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-25T00:00:00' + description: 0027-Part + counterparty: DIISR + reconciled: true + amount: 579.37 + balance: 6550.89 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-26T00:00:00' + description: Inv 0029 + counterparty: Hamilton Smith + reconciled: true + amount: 541.25 + balance: 7092.14 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-26T00:00:00' + description: INV0032 + counterparty: Rex Media Group + reconciled: true + amount: 541.25 + balance: 8715.89 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-26T00:00:00' + description: '0030' + counterparty: Young Brothers Transport + reconciled: true + amount: 541.25 + balance: 7633.39 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-26T00:00:00' + description: INV-0031 + counterparty: Port & Philip Freight Limited + reconciled: true + amount: 541.25 + balance: 8174.64 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-27T00:00:00' + description: Eft + counterparty: Woolworths Oaktown + reconciled: true + amount: -34.1 + balance: 8681.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-28T00:00:00' + description: 033-Full + counterparty: DIISR + reconciled: true + amount: 250 + balance: 8931.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-30T00:00:00' + description: Eft + counterparty: Office Supplies Company + reconciled: true + amount: -49.2 + balance: 8882.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-01-31T00:00:00' + description: '' + counterparty: Berry Brew + reconciled: true + amount: -22 + balance: 8860.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-01T00:00:00' + description: CHQ 6543-000411 + counterparty: 24 Locks + reconciled: true + amount: -69.5 + balance: 8791.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-02T00:00:00' + description: 08-4123 + counterparty: Hoyt Productions Ltd + reconciled: true + amount: -5953.75 + balance: 2837.34 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-03T00:00:00' + description: '' + counterparty: Carlton Functions + reconciled: true + amount: -1500 + balance: 1337.34 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-06T00:00:00' + description: Exps + counterparty: O.Greenville + reconciled: true + amount: -29.5 + balance: 1307.84 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-07T00:00:00' + description: Rent + counterparty: Truxton Property Management + reconciled: false + amount: -1181.25 + balance: 6314.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-07T00:00:00' + description: INV-0035 + counterparty: Ridgeway University + reconciled: false + amount: 6187.5 + balance: 7495.34 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-08T00:00:00' + description: 0017-Part + counterparty: City Limousines + reconciled: false + amount: 100 + balance: 1914.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-08T00:00:00' + description: DEPOSIT ADV + counterparty: Jakaranda Maple Systems + reconciled: false + amount: 2000 + balance: 3914.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-08T00:00:00' + description: 0195 0210 + counterparty: SMART Agency + reconciled: false + amount: -4500 + balance: 1814.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-09T00:00:00' + description: Eft + counterparty: Cooper Street Bakery + reconciled: false + amount: -15.75 + balance: 3898.34 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-10T00:00:00' + description: '' + counterparty: 7-Eleven + reconciled: false + amount: -15.5 + balance: 3882.84 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-11T00:00:00' + description: '' + counterparty: Swanston Security + reconciled: false + amount: -59.55 + balance: 3811.39 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-11T00:00:00' + description: '' + counterparty: Cooper Street Bakery + reconciled: false + amount: -11.9 + balance: 3870.94 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-12T00:00:00' + description: '' + counterparty: Whitcoulls + reconciled: false + amount: -29.8 + balance: 4769.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-12T00:00:00' + description: '' + counterparty: e-Bank Dep + reconciled: false + amount: 1000 + balance: 4811.39 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-12T00:00:00' + description: '' + counterparty: Central City Parking + reconciled: false + amount: -12 + balance: 4799.39 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-13T00:00:00' + description: '' + counterparty: Central City Parking + reconciled: false + amount: -12 + balance: 4757.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-13T00:00:00' + description: Sub 092201 + counterparty: Wilson Online Periodicals + reconciled: false + amount: -49.9 + balance: 4588.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-13T00:00:00' + description: Reg 8018922 + counterparty: ACL Conferences + reconciled: false + amount: -85 + balance: 4672.59 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-13T00:00:00' + description: '' + counterparty: New World + reconciled: false + amount: -34.6 + balance: 4637.99 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-14T00:00:00' + description: Sublet RM2031 + counterparty: Majestic Contracting + reconciled: false + amount: 450 + balance: 6526.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-14T00:00:00' + description: '' + counterparty: Central City Parking + reconciled: false + amount: -12 + balance: 4576.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-14T00:00:00' + description: '' + counterparty: e-Bank Dep + reconciled: false + amount: 1500 + balance: 6076.09 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-15T00:00:00' + description: '' + counterparty: Central City Parking + reconciled: false + amount: -12 + balance: 6499.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-15T00:00:00' + description: CR 092201 + counterparty: Wilson Online Periodicals + reconciled: false + amount: 35 + balance: 6534.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-15T00:00:00' + description: '' + counterparty: Parkside Kiosk + reconciled: false + amount: -14.3 + balance: 6511.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-16T00:00:00' + description: '' + counterparty: e-Bank Dep + reconciled: false + amount: 200 + balance: 6712.29 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-16T00:00:00' + description: '' + counterparty: Parkside Kiosk + reconciled: false + amount: -10.5 + balance: 6512.29 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-16T00:00:00' + description: Fee + counterparty: Ridgeway Banking Corporation + reconciled: false + amount: -15 + balance: 6697.29 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-16T00:00:00' + description: '' + counterparty: 7-Eleven + reconciled: false + amount: -15.5 + balance: 6681.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + clearedOnDate: '2023-02-16T00:00:00' + description: '' + counterparty: Central City Parking + reconciled: false + amount: -12 + balance: 6522.79 + transactionType: Unknown + modifiedDate: '2023-03-15T20:37:10Z' + pageNumber: 1 + pageSize: 100 + totalResults: 93 + _links: + current: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts/bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4/bankTransactions + self: + href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts/bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4/bankTransactions + Zoho Books: + value: + results: + - id: 104957000000060010-104957000000070175 + accountId: '104957000000060010' + clearedOnDate: '2020-02-06T00:00:00' + description: '' + reconciled: false + amount: 9001 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000060014 + accountId: '104957000000060010' + clearedOnDate: '2020-02-12T00:00:00' + description: '' + reconciled: false + amount: 10000 + transactionType: Dep + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000067014 + accountId: '104957000000060010' + clearedOnDate: '2020-02-14T00:00:00' + description: '' + reconciled: false + amount: 9001 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000070035 + accountId: '104957000000060010' + clearedOnDate: '2020-02-17T00:00:00' + description: '' + reconciled: false + amount: 11980 + transactionType: Debit + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000070055 + accountId: '104957000000060010' + clearedOnDate: '2020-02-17T00:00:00' + description: '' + reconciled: false + amount: -20 + transactionType: Payment + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000070097 + accountId: '104957000000060010' + clearedOnDate: '2020-02-17T00:00:00' + description: '' + reconciled: false + amount: 10789.21 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000097011 + accountId: '104957000000060010' + clearedOnDate: '2020-02-26T00:00:00' + description: '' + reconciled: false + amount: 10000 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000099013 + accountId: '104957000000060010' + clearedOnDate: '2020-02-27T00:00:00' + description: '' + reconciled: false + amount: -72 + transactionType: Payment + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000099053 + accountId: '104957000000060010' + clearedOnDate: '2020-02-27T00:00:00' + description: '' + reconciled: false + amount: 10 + transactionType: Debit + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000137017 + accountId: '104957000000060010' + clearedOnDate: '2020-05-19T00:00:00' + description: '' + reconciled: false + amount: 9000 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000336002 + accountId: '104957000000060010' + clearedOnDate: '2020-12-01T00:00:00' + description: '' + reconciled: false + amount: -20 + transactionType: Xfer + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000000336020 + accountId: '104957000000060010' + clearedOnDate: '2020-12-01T00:00:00' + description: '' + reconciled: false + amount: 1.79 + transactionType: Xfer + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001706009 + accountId: '104957000000060010' + clearedOnDate: '2021-04-12T00:00:00' + description: '' + reconciled: false + amount: 200 + transactionType: Cash + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001469026 + accountId: '104957000000060010' + clearedOnDate: '2022-05-12T00:00:00' + description: '' + reconciled: false + amount: -50 + transactionType: Credit + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001480001 + accountId: '104957000000060010' + clearedOnDate: '2022-05-13T00:00:00' + description: '' + reconciled: false + amount: 18.98 + transactionType: Debit + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001480045 + accountId: '104957000000060010' + clearedOnDate: '2022-05-13T00:00:00' + description: '' + reconciled: false + amount: -20 + transactionType: Credit + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001633002 + accountId: '104957000000060010' + clearedOnDate: '2022-07-27T00:00:00' + description: '' + reconciled: false + amount: 26 + transactionType: Other + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001652007 + accountId: '104957000000060010' + clearedOnDate: '2022-08-08T00:00:00' + description: '' + reconciled: false + amount: 11.75 + transactionType: Other + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001689069 + accountId: '104957000000060010' + clearedOnDate: '2022-08-24T00:00:00' + description: '' + reconciled: false + amount: -2.89 + transactionType: Payment + modifiedDate: '2022-10-03T08:40:40Z' + - id: 104957000000060010-104957000001689125 + accountId: '104957000000060010' + clearedOnDate: '2022-08-25T00:00:00' + description: '' + reconciled: false + amount: 3.6 + transactionType: Debit + modifiedDate: '2022-10-03T08:40:40Z' + pageNumber: 1 + pageSize: 100 + totalResults: 20 + _links: + current: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts/104957000000060010/bankTransactions + self: + href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts/104957000000060010/bankTransactions + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/agedDebtor/available': + parameters: + - $ref: '#/components/parameters/companyId' + get: + x-internal: true + tags: + - Accounts receivable + summary: Aged debtors report available + description: Indicates whether the aged debtors report is available for the company. + operationId: is-aged-debtors-report-available + responses: + '200': + description: OK + content: + application/json: + schema: + type: boolean + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + x-speakeasy-name-override: is-aged-debtors-available + x-speakeasy-group: accounts-receivable.reports + '/companies/{companyId}/reports/agedDebtor': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts receivable + parameters: + - $ref: '#/components/parameters/accountingReportDate' + - $ref: '#/components/parameters/accountingNumberOfPeriods' + - $ref: '#/components/parameters/accountingPeriodLengthDays' + summary: Aged debtors report + description: Returns aged debtors report for company that shows the total outstanding balance due from customers to the business over time. + operationId: get-accounting-aged-debtors-report + x-speakeasy-name-override: get-aged-debtors + x-speakeasy-group: accounts-receivable.reports + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAgedDebtorReport' + examples: + Clear Books: + value: + generated: '2023-05-02T16:05:21.4959955Z' + reportDate: '2023-05-02T16:05:21.4459444Z' + data: + - customerId: c8180244-74ac-40cf-a5df-6d83661c44d7 + customerName: Arjun Kuvalis + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3367.71 + details: + - name: CreditNotes + amount: -3367.71 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 6d162ee4-47b4-46c6-a2e6-aa9edd0fe6b0 + customerName: 'Breitenberg, Emard and Schiller' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -4299.26 + details: + - name: Invoices + amount: 0 + - name: CreditNotes + amount: -4299.26 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 981d56a7-cf63-4ed2-b8db-2eba2c0aeb5a + customerName: Collins - Anderson + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -14959.84 + details: + - name: CreditNotes + amount: -14959.84 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 773.94 + details: + - name: Invoices + amount: 773.94 + - customerId: d3739e0f-5a70-465b-9dfe-deb8efac0cd3 + customerName: Damien Schneider + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2817.59 + details: + - name: CreditNotes + amount: -2817.59 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 10652b76-2a9a-43ba-a892-fb4f369fe1ef + customerName: Franco Labadie + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1541.52 + details: + - name: CreditNotes + amount: -1541.52 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 03b7f9fd-40e0-4c71-9f93-58e867233bcb + customerName: Harvey Predovic + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -14312.59 + details: + - name: CreditNotes + amount: -14312.59 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 158.76 + details: + - name: Invoices + amount: 158.76 + - customerId: bbea9634-7a60-4c3f-97cd-70e481ec2cce + customerName: Jenkins Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -32818.36 + details: + - name: CreditNotes + amount: -32818.36 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 431.71 + details: + - name: Invoices + amount: 431.71 + - customerId: d65ac505-072c-49ec-be3c-3cb74228966d + customerName: Jensen Steuber + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -9766.18 + details: + - name: Invoices + amount: 0 + - name: CreditNotes + amount: -9766.18 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1273.16 + details: + - name: Invoices + amount: 1273.16 + - customerId: a82042f1-a005-4ca5-bfd3-5bc237123aa5 + customerName: Keara Leffler + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2595.66 + details: + - name: CreditNotes + amount: -2595.66 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1397.98 + details: + - name: Invoices + amount: 1397.98 + - customerId: f67eab14-12f1-432f-af73-81ebf6ec8ddc + customerName: Neoma Kreiger + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3047.62 + details: + - name: CreditNotes + amount: -3047.62 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 2d6a5c2d-80dc-4aac-8909-ddfb3cb24437 + customerName: Newton Zieme + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -225.44 + details: + - name: CreditNotes + amount: -225.44 + - name: Invoices + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 976a2402-0908-46d9-9121-a93005d29c01 + customerName: Norbert Tillman + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -537.61 + details: + - name: CreditNotes + amount: -537.61 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 453ddfc0-49ce-4f66-a815-dae734be885c + customerName: Ralph Wilderman + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2538.49 + details: + - name: CreditNotes + amount: -2538.49 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: 51f03576-f6b0-40d5-9fba-81a490411c03 + customerName: Raul Johns + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -4403.5 + details: + - name: CreditNotes + amount: -4403.5 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3477.81 + details: + - name: Invoices + amount: 3477.81 + - customerId: 84539fde-118f-48ed-978d-0aa50c7ec223 + customerName: Rodger Feest + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1456.66 + details: + - name: CreditNotes + amount: -1456.66 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7366.21 + details: + - name: Invoices + amount: 7366.21 + - customerId: dc75136b-b504-49c5-be35-04e1d2771e1e + customerName: Vincenzo Wolff + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -80.97 + details: + - name: CreditNotes + amount: -80.97 + - name: Invoices + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + Dynamics 365 Business Central: + value: + generated: '2023-05-02T16:05:20.8918448Z' + reportDate: '2023-05-02T16:05:20.8411594Z' + data: + - customerId: 8ddfa6bf-0c60-eb11-89fa-00224800af18 + customerName: Abdi Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -80 + details: + - name: CreditNotes + amount: -80 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -257.28 + details: + - name: Payments + amount: -300 + - name: Invoices + amount: 42.72 + - customerId: b41217b3-89d1-ea11-bbaa-000d3a2b9185 + customerName: Adatum Corporation + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1558.56 + details: + - name: CreditNotes + amount: -1558.56 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 33200.76 + details: + - name: Invoices + amount: 34782.32 + - name: Payments + amount: -1581.56 + - currency: HKD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 8554.46 + details: + - name: Invoices + amount: 8554.46 + - customerId: ba1217b3-89d1-ea11-bbaa-000d3a2b9185 + customerName: Alpine Ski House + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7503.08 + details: + - name: Invoices + amount: 7503.08 + - customerId: f5860a8e-4b5a-eb11-89fa-00224800af18 + customerName: CustomerQA + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 349.68 + details: + - name: Invoices + amount: 349.68 + - customerId: feef29a2-1d59-ed11-8c36-002248c5e6c0 + customerName: DP Test Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 332.2 + details: + - name: Invoices + amount: 427.2 + - name: Payments + amount: -95 + - customerId: 264d74d4-3218-ed11-90eb-000d3a873415 + customerName: Eliana + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -779.28 + details: + - name: CreditNotes + amount: -779.28 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1905 + details: + - name: Invoices + amount: 1905 + - customerId: 99faf6fb-5209-eb11-bbf6-0022481ad2e8 + customerName: QA Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4923.48 + details: + - name: Invoices + amount: 4923.48 + - customerId: bc1217b3-89d1-ea11-bbaa-000d3a2b9185 + customerName: Relecloud + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10559.04 + details: + - name: Invoices + amount: 10559.04 + - customerId: b81217b3-89d1-ea11-bbaa-000d3a2b9185 + customerName: School of Fine Art + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 33438.88 + details: + - name: Invoices + amount: 34811.2 + - name: Payments + amount: -1372.32 + - customerId: dc3f4f1b-3c54-ed11-9470-002248c5e18c + customerName: Test no payment terms + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Invoices + amount: 10 + - customerId: 9e55a119-064e-ed11-946f-0022481b84d7 + customerName: Test Push + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 126 + details: + - name: Invoices + amount: 126 + - customerId: b30ca600-074e-ed11-946f-0022481b84d7 + customerName: Test Push + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 116 + details: + - name: Invoices + amount: 116 + - customerId: b61217b3-89d1-ea11-bbaa-000d3a2b9185 + customerName: Trey Researches + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -24 + details: + - name: CreditNotes + amount: -24 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2663.38 + details: + - name: Payments + amount: 10 + - name: Invoices + amount: 2653.38 + - customerId: d93ceb37-b805-ec11-86bc-0022481a45c2 + customerName: Vegan Bakeshop + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -18.67 + details: + - name: Payments + amount: -18.67 + FreshBooks: + value: + generated: '2023-05-02T16:05:20.6173310Z' + reportDate: '2023-05-02T16:05:20.5039554Z' + data: + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -1 + details: + - name: Payments + amount: -1 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -5 + details: + - name: Payments + amount: -5 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -500 + details: + - name: Payments + amount: -500 + - name: Invoices + amount: 0 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -100 + details: + - name: Payments + amount: -100 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -49 + details: + - name: Payments + amount: -49 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: Payments + amount: -10 + - agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 100 + details: + - name: Invoices + amount: 100 + - customerId: '602174' + customerName: ab1 + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 222.71 + details: + - name: Invoices + amount: 222.71 + - currency: AED + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -5 + details: + - name: Payments + amount: -5 + - customerId: '511657' + customerName: Bob's Stationary + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -2060.2 + details: + - name: Payments + amount: -2083.83 + - name: Invoices + amount: 23.63 + - customerId: '581145' + customerName: CanadaCo + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -132.15 + details: + - name: Payments + amount: -160.9 + - name: Invoices + amount: 28.75 + - currency: CNY + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2.88 + details: + - name: Invoices + amount: 2.88 + - customerId: '578409' + customerName: company1 + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -1031.45 + details: + - name: Invoices + amount: 144 + - name: Payments + amount: -1175.45 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -100.29 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -100.29 + - customerId: '669531' + customerName: P + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 24.98 + details: + - name: Invoices + amount: 24.98 + - customerId: '515655' + customerName: Parent company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -2898.25 + details: + - name: Payments + amount: -2898.25 + - name: Invoices + amount: 0 + - customerId: '511669' + customerName: Pens International + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 516.3 + details: + - name: Payments + amount: 0 + - name: Invoices + amount: 516.3 + - customerId: '582461' + customerName: QA Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -76 + details: + - name: Invoices + amount: 20 + - name: Payments + amount: -96 + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -1.15 + details: + - name: Payments + amount: -1.15 + - customerId: '511661' + customerName: Sarah's Office Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -10 + - customerId: '572047' + customerName: SRS Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 141.25 + details: + - name: Invoices + amount: 141.25 + - customerId: '536295' + customerName: Test company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -144.46 + details: + - name: Invoices + amount: 7.64 + - name: Payments + amount: -152.1 + - customerId: '512927' + customerName: Wood Turnerss + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 48442.07 + details: + - name: Invoices + amount: 51089.28 + - name: Payments + amount: -2647.21 + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -10 + - currency: CAD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 192.28 + details: + - name: Invoices + amount: 1186.28 + - name: Payments + amount: -994 + KashFlow: + value: + generated: '2023-05-02T16:05:20.3727270Z' + reportDate: '2023-05-02T16:05:20.3123550Z' + data: + - customerId: '88459410' + customerName: Diogo Sousa + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 482.57 + details: + - name: Invoices + amount: 482.57 + - customerId: '86810130' + customerName: Maria Gomez + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -216 + details: + - name: Invoices + amount: -216 + - customerId: '86832299' + customerName: Mr French Person + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5 + details: + - name: Invoices + amount: 5 + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5 + details: + - name: Invoices + amount: 5 + - customerId: '69946501' + customerName: Peter Lord + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3 + details: + - name: Invoices + amount: 3 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -46 + details: + - name: CreditNotes + amount: -46 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 55661.49 + details: + - name: Invoices + amount: 55911.49 + - name: Payments + amount: -250 + - customerId: '88353693' + customerName: Test Customer updated + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4771.03 + details: + - name: Invoices + amount: 4771.03 + - customerId: '69952389' + customerName: Things Limited + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -42.42 + details: + - name: CreditNotes + amount: -42.42 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6385 + details: + - name: Invoices + amount: 6385 + MYOB AccountRight and Essentials: + value: + generated: '2023-05-02T16:05:21.0942911Z' + reportDate: '2023-05-02T16:05:20.8602315Z' + data: [] + Oracle NetSuite: + value: + generated: '2023-05-02T16:05:20.0339587Z' + reportDate: '2023-05-02T16:05:19.8669114Z' + data: [] + QuickBooks Desktop: + value: + generated: '2023-05-02T16:05:19.9204890Z' + reportDate: '2023-05-02T16:05:19.8723073Z' + data: + - customerId: 1F0000-933272658 + customerName: 'Jacobsen, Doug' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 7991.52 + details: + - name: Invoices + amount: 7991.52 + - name: Payments + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: 6F0000-1071510646 + customerName: 'Morgenthaler, Jenny' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -271.53 + details: + - name: Payments + amount: -271.53 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + QuickBooks Online: + value: + generated: '2023-05-02T16:05:21.0640297Z' + reportDate: '2023-05-02T16:05:20.9965545Z' + data: + - customerId: '67' + customerName: Abercrombie International Group + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -837.11 + details: + - name: CreditNotes + amount: -837.11 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 55512.84 + details: + - name: Invoices + amount: 55578.69 + - name: Payments + amount: -65.85 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Payments + amount: 10 + - customerId: '4' + customerName: Cathy's Consulting Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -905.8 + details: + - name: Invoices + amount: 314.2 + - name: Payments + amount: -1220 + - customerId: '20' + customerName: Chadha's Consultants + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -75 + details: + - name: Payments + amount: -75 + - customerId: '7' + customerName: Clement's Cleaners + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 24 + details: + - name: Invoices + amount: 24 + - customerId: '301' + customerName: Codat Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -650.27 + details: + - name: Invoices + amount: 15 + - name: CreditNotes + amount: -469.52 + - name: Payments + amount: -195.75 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 266.49 + details: + - name: Invoices + amount: 210.01 + - name: Payments + amount: 56.48 + - customerId: '305' + customerName: Codat Customer (USD) + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: + - name: Payments + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 121.5 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: 121.5 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Payments + amount: 10 + - customerId: '136' + customerName: Customer Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 13.37 + details: + - name: Payments + amount: 13.37 + - customerId: '218' + customerName: Diego Trantow + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 11.65 + details: + - name: Payments + amount: 11.65 + - customerId: '8' + customerName: Ecker Designs + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2273 + details: + - name: Invoices + amount: 2273 + - customerId: '59' + customerName: Ecker Holiday event + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3206779 + details: + - name: Invoices + amount: 3206779 + - customerId: '13' + customerName: Himateja Madala + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -100 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -100 + - customerId: '11' + customerName: Ho Engineering Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Invoices + amount: 10 + - customerId: '114' + customerName: huw default not included + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 116.4 + details: + - name: Invoices + amount: 116.4 + - customerId: '117' + customerName: Huw's Test Push customer2 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -521.4 + details: + - name: CreditNotes + amount: -521.4 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1120.6 + details: + - name: Invoices + amount: 1232.2 + - name: Payments + amount: -111.6 + - customerId: '306' + customerName: J Codat + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 32.1 + details: + - name: Invoices + amount: 176.1 + - name: Payments + amount: -144 + - customerId: '15' + customerName: Jen Zaccarella + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4800 + details: + - name: Invoices + amount: 4800 + - customerId: '307' + customerName: Jo Codat 2 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 112.6 + details: + - name: Invoices + amount: 143.96 + - name: Payments + amount: 58.14 + - name: CreditNotes + amount: -89.5 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: '119' + customerName: John Smith 1 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 160 + details: + - name: Invoices + amount: 160 + - customerId: '16' + customerName: Jordan Burgess + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1098 + details: + - name: CreditNotes + amount: -1098 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -60 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -60 + - customerId: '83' + customerName: Kay's Bake Shop + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 8508.37 + details: + - name: Invoices + amount: 8717.33 + - name: Payments + amount: -208.96 + - customerId: '1' + customerName: Ko International Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3586.2 + details: + - name: CreditNotes + amount: -3586.2 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 11291.4 + details: + - name: Invoices + amount: 11474.05 + - name: Payments + amount: -182.65 + - customerId: '91' + customerName: Mr Huw Test + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2311.27 + details: + - name: CreditNotes + amount: -2311.27 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2292.91 + details: + - name: Invoices + amount: 2290.91 + - name: Payments + amount: 2 + - customerId: '55' + customerName: Oxon Insurance - Holiday Party + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10800 + details: + - name: Payments + amount: -10800 + - customerId: '70' + customerName: Project X + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 50 + details: + - name: Invoices + amount: 50 + - customerId: '281' + customerName: Renee O'Connell + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12.75 + details: + - name: Payments + amount: 12.75 + - customerId: '118' + customerName: RSP + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 100 + details: + - name: Payments + amount: 100 + - customerId: '76' + customerName: TestPushCustomer5 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1320 + details: + - name: Invoices + amount: 1320 + - customerId: '77' + customerName: TestPushCustomer6 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1848 + details: + - name: Invoices + amount: 1848 + - customerId: '79' + customerName: TestPushCustomer7 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -25 + details: + - name: Payments + amount: -25 + - customerId: '84' + customerName: Vegan Cake Shop + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -86.4 + details: + - name: CreditNotes + amount: -116.4 + - name: Payments + amount: 30 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -206460.15 + details: + - name: Invoices + amount: 5145.29 + - name: Payments + amount: -211605.44 + - customerId: '60' + customerName: Whitehead - Employee celebration + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1100 + details: + - name: CreditNotes + amount: -1100 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: '5' + customerName: Whitehead and Sons + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 754.4 + details: + - name: Invoices + amount: 754.4 + - customerId: '3' + customerName: Yeung's Architects + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -600 + details: + - name: CreditNotes + amount: -600 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 20035.25 + details: + - name: Invoices + amount: 20604.49 + - name: Payments + amount: -569.24 + Sage 200cloud: + value: + generated: '2023-05-02T16:05:20.5553019Z' + reportDate: '2023-05-02T16:05:20.4958267Z' + data: + - customerId: A1D001 + customerName: A1 Design Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -378 + details: + - name: CreditNotes + amount: -378 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4504.07 + details: + - name: Invoices + amount: 4505.07 + - name: Payments + amount: -1 + - customerId: A1D002 + customerName: A2 Design Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -66 + details: + - name: CreditNotes + amount: -66 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 540 + details: + - name: Invoices + amount: 540 + - customerId: A1D003 + customerName: A2 Design Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -24.71 + details: + - name: CreditNotes + amount: -24.71 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 16606.32 + details: + - name: Invoices + amount: 16606.32 + - customerId: ABS001 + customerName: ABS Garages Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -177.14 + details: + - name: CreditNotes + amount: -177.14 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4345.3 + details: + - name: Invoices + amount: 4845.3 + - name: Payments + amount: -500 + - customerId: USA1 + customerName: American Sales + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 100 + details: + - name: Invoices + amount: 100 + - customerId: BBS001 + customerName: Bobs Building Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -103.16 + details: + - name: CreditNotes + amount: -103.16 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4284.77 + details: + - name: Invoices + amount: 4309.77 + - name: Payments + amount: -25 + - customerId: BRO001 + customerName: Bronson Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 786.48 + details: + - name: Invoices + amount: 852 + - name: Payments + amount: -65.52 + - customerId: BUS001 + customerName: Business Exhibitions + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2274.62 + details: + - name: Invoices + amount: 2374.62 + - name: Payments + amount: -100 + - customerId: CASH001 + customerName: Cash and Credit Card Sales + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 324.5 + details: + - name: Invoices + amount: 324.5 + - customerId: COM001 + customerName: Compton Packaging + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4571.04 + details: + - name: Invoices + amount: 4571.04 + - customerId: CGS001 + customerName: County Golf Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2028.03 + details: + - name: Invoices + amount: 2028.03 + - customerId: STU001 + customerName: Edward Stuart + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2341.25 + details: + - name: Invoices + amount: 2341.25 + - customerId: FGL001 + customerName: F G Landscape & Design + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 11260.26 + details: + - name: Invoices + amount: 11260.26 + - customerId: BRI001 + customerName: Fred Briant + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 536.67 + details: + - name: Invoices + amount: 656.67 + - name: Payments + amount: -120 + - customerId: GRA001 + customerName: Graham Electonics + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4149.09 + details: + - name: Invoices + amount: 4149.09 + - customerId: HAU001 + customerName: Hausser GMBH + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2082.96 + details: + - name: Invoices + amount: 2082.96 + - customerId: JSS001 + customerName: John Smith Studios + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1228.34 + details: + - name: Invoices + amount: 1228.34 + - customerId: KIN001 + customerName: Kinghorn & French + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9254.03 + details: + - name: Invoices + amount: 9254.03 + - customerId: MAC001 + customerName: Macolm Hall Associates + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6927.26 + details: + - name: Invoices + amount: 6927.26 + - customerId: 1A2B3C + customerName: Maria Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 69.12 + details: + - name: Invoices + amount: 69.12 + - customerId: MIB001 + customerName: Mikes Insurance Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3597.16 + details: + - name: Invoices + amount: 3597.16 + - customerId: MIL001 + customerName: Mile Road Health Centre + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5644.12 + details: + - name: Invoices + amount: 6644.12 + - name: Payments + amount: -1000 + - customerId: MOR001 + customerName: Morley Solicitors + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 392.67 + details: + - name: Invoices + amount: 1767.67 + - name: Payments + amount: -1375 + - customerId: PAT001 + customerName: Patterson & Graham Garages + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 915.24 + details: + - name: Invoices + amount: 915.24 + - customerId: YOU001 + customerName: Peter Young + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -168 + details: + - name: CreditNotes + amount: -168 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2106.84 + details: + - name: Invoices + amount: 2106.84 + - customerId: PIC001 + customerName: Picture Frame Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 546.12 + details: + - name: Invoices + amount: 1413.9 + - name: Payments + amount: -867.78 + - customerId: RSP001 + customerName: Richard Sanderson-Pope + agedCurrencyOutstanding: + - currency: JPY + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -29210 + details: + - name: CreditNotes + amount: -29210 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 623907.28 + details: + - name: Invoices + amount: 624053.94 + - name: Payments + amount: -146.66 + - customerId: ROB001 + customerName: Robertson Joinery + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4550.2 + details: + - name: Invoices + amount: 4550.2 + - customerId: SDE001 + customerName: S D Enterprises + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 15339.68 + details: + - name: Invoices + amount: 15339.68 + - customerId: STE001 + customerName: Stevenson & Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1562.75 + details: + - name: Invoices + amount: 1562.75 + - customerId: SWA001 + customerName: Swan Leisure Centre + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -16.68 + details: + - name: CreditNotes + amount: -16.68 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1615.51 + details: + - name: Invoices + amount: 1615.51 + - customerId: '0001' + customerName: Test Customer01 + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -366.71 + details: + - name: CreditNotes + amount: -366.71 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 900.22 + details: + - name: Invoices + amount: 913.38 + - name: Payments + amount: -13.16 + - customerId: TESTSUPP + customerName: Test supplier for testing purposes 1234567891234567891234567 + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 149.61 + details: + - name: Invoices + amount: 149.61 + - customerId: SHO001 + customerName: The Show Lodge + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7148.07 + details: + - name: Invoices + amount: 7148.07 + - customerId: VID001 + customerName: The Video Rental Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2041.66 + details: + - name: Invoices + amount: 2041.66 + Sage 50 (UK): + value: + generated: '2023-05-02T16:05:19.8072734Z' + reportDate: '2023-05-02T16:05:19.7472225Z' + data: + - customerId: A1D001 + customerName: A1 Design Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -5.37 + details: + - name: Invoices + amount: -5.37 + - customerId: ABS001 + customerName: ABS Garages Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2454.97 + details: + - name: Invoices + amount: 2454.97 + - customerId: BBS001 + customerName: Bobs Building Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4309.77 + details: + - name: Invoices + amount: 4309.77 + - customerId: BUS001 + customerName: Business Exhibitions + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2066.61 + details: + - name: Invoices + amount: 2166.61 + - name: Payments + amount: -100 + - customerId: CASH001 + customerName: Cash and Credit Card Sales + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -0.01 + details: + - name: Invoices + amount: -0.01 + - customerId: COM001 + customerName: Compton Packaging + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2749.02 + details: + - name: Invoices + amount: 2749.02 + - customerId: CGS001 + customerName: County Golf Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2028.03 + details: + - name: Invoices + amount: 2028.03 + - customerId: STU001 + customerName: Edward Stuart + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2341.25 + details: + - name: Invoices + amount: 2341.25 + - customerId: FGL001 + customerName: F G Landscape & Design + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 11256.18 + details: + - name: Invoices + amount: 11256.18 + - customerId: GRA001 + customerName: Graham Electonics + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4149.08 + details: + - name: Invoices + amount: 4149.08 + - customerId: HAU001 + customerName: Hausser GMBH + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1965.96 + details: + - name: Invoices + amount: 1965.96 + - customerId: JSS001 + customerName: John Smith Studios + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 977.09 + details: + - name: Invoices + amount: 977.09 + - customerId: KIN001 + customerName: Kinghorn & French + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7398.33 + details: + - name: Invoices + amount: 7398.33 + - customerId: MAC001 + customerName: Macolm Hall Associates + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6916.46 + details: + - name: Invoices + amount: 6916.46 + - customerId: MIB001 + customerName: Mikes Insurance Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3525.26 + details: + - name: Invoices + amount: 3525.26 + - customerId: MIL001 + customerName: Mile Road Health Centre + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2307.84 + details: + - name: Invoices + amount: 3307.84 + - name: Payments + amount: -1000 + - customerId: MOR001 + customerName: Morley Solicitors + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 370.27 + details: + - name: Invoices + amount: 1745.27 + - name: Payments + amount: -1375 + - customerId: PAT001 + customerName: Patterson & Graham Garages + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 915.24 + details: + - name: Invoices + amount: 915.24 + - customerId: YOU001 + customerName: Peter Young + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2115.77 + details: + - name: Invoices + amount: 2115.77 + - customerId: PIC001 + customerName: Picture Frame Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 268.93 + details: + - name: Invoices + amount: 1136.71 + - name: Payments + amount: -867.78 + - customerId: ROB001 + customerName: Robertson Joinery + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4530.98 + details: + - name: Invoices + amount: 4530.98 + - customerId: SDE001 + customerName: S D Enterprises + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 15339.68 + details: + - name: Invoices + amount: 15339.68 + - customerId: STE002 + customerName: Steven Stephenson + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 8.35 + details: + - name: Invoices + amount: 8.35 + - customerId: STE001 + customerName: Stevenson & Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1562.75 + details: + - name: Invoices + amount: 1562.75 + - customerId: SWA001 + customerName: Swan Leisure Centre + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -16.68 + details: + - name: CreditNotes + amount: -16.68 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1615.51 + details: + - name: Invoices + amount: 1615.51 + - customerId: SHO001 + customerName: The Show Lodge + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7305.77 + details: + - name: Invoices + amount: 7305.77 + - customerId: VID001 + customerName: The Video Rental Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2041.64 + details: + - name: Invoices + amount: 2041.64 + Sage Business Cloud Accounting: + value: + generated: '2023-05-02T16:05:20.9416221Z' + reportDate: '2023-05-02T16:05:20.7435694Z' + data: + - customerId: 260f6a3f94a243738f2d5e08496a41a8 + customerName: 100 test name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -60 + details: + - name: CreditNotes + amount: -60 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1471 + details: + - name: Invoices + amount: 1891 + - name: Payments + amount: -420 + - customerId: 860dd9f1ad9346ba85117aedfa19cc72 + customerName: 100 test name DS + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1065 + details: + - name: Invoices + amount: 1080 + - name: Payments + amount: -15 + - customerId: 395d26ee8ab44f8b861b468caf63b00d + customerName: 222 Abdul's Test Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -120 + details: + - name: CreditNotes + amount: -120 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2443.8 + details: + - name: Invoices + amount: 2759.8 + - name: Payments + amount: -316 + - customerId: 013cf04960924a0da800f019369c3262 + customerName: 333 Abdul's Test Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -0.66 + details: + - name: Invoices + amount: 9.34 + - name: Payments + amount: -10 + - customerId: 4ba77efb904e4380accc242b1526ac2c + customerName: 333 Abdul's Test Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10 + details: + - name: CreditNotes + amount: -10 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 65 + details: + - name: Invoices + amount: 65 + - customerId: 18e45991fe6440ad8e8b5ecf9a2e7e09 + customerName: 444 Abdul's Test Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -2 + details: + - name: Invoices + amount: 48 + - name: Payments + amount: -50 + - customerId: 23ca7ffaa2b54360937531dde804c9aa + customerName: aaa + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -22 + details: + - name: CreditNotes + amount: -22 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -62 + details: + - name: Invoices + amount: 7 + - name: Payments + amount: -69 + - customerId: 2b93da6ce4af4dc99520eafd28768457 + customerName: Abdul Al-haj + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 288 + details: + - name: Invoices + amount: 288 + - customerId: 460af92dd82a4a61b6ce1d18245789b3 + customerName: Abdul Al-haj + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 48 + details: + - name: Invoices + amount: 48 + - customerId: b8bd7e0dfdd64d39abaaf2dcd1c48b49 + customerName: Abdul Al-haj + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -119.99 + details: + - name: CreditNotes + amount: -119.99 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: aa37b59417024d2494f01ba23d92a2ef + customerName: Abe The Engineer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1562 + details: + - name: CreditNotes + amount: -1562 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1337 + details: + - name: Invoices + amount: 1362 + - name: Payments + amount: -25 + - customerId: df65eaa6789111e8aaa5027d54329956 + customerName: Baguettes Ltd + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -844.99 + details: + - name: CreditNotes + amount: -844.99 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 616726.02 + details: + - name: Invoices + amount: 617888.74 + - name: Payments + amount: -1162.72 + - customerId: 2916114b3b6942a7b08f1bcc971f5bf9 + customerName: c.taylor@codat.io + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1.2 + details: + - name: Invoices + amount: 1.2 + - customerId: 0556b365ef4e42068fff775f847c0330 + customerName: Customer 71 (AUD) + agedCurrencyOutstanding: + - currency: AUD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -701 + details: + - name: Payments + amount: -701 + - customerId: 145dee01b49c4359a052682f234007e3 + customerName: Customer Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: Payments + amount: -10 + - customerId: 76f656dfbafa4cec823f1e2e43ea1a8e + customerName: Customer Test 59 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: Payments + amount: -10 + - customerId: a11e6776ca9a4e16af3425982de25a22 + customerName: Debs Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5279.2 + details: + - name: Invoices + amount: 5279.2 + - customerId: cc80e0fb747e4ddaab743d778d04ec4a + customerName: Debs US Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 15111 + details: + - name: Invoices + amount: 15111 + - customerId: adb9cae8b34e446da3d53305b299168b + customerName: Fo Shizzle + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 300 + details: + - name: Invoices + amount: 300 + - customerId: cc745370213545f6bd4129a7502f19fb + customerName: Grace Lo + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -1150 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -1150 + - customerId: 3b17c5ae9caf4b88a4a9e33a83fa321d + customerName: Hello + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12 + details: + - name: Invoices + amount: 12 + - customerId: 979c5156ea0e45d9a9ea7b9d54775138 + customerName: J Customer FR + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -52795 + details: + - name: CreditNotes + amount: -52795 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 134045 + details: + - name: Invoices + amount: 134045 + - customerId: 99d52ca7060341a698a664d1737663c5 + customerName: J Customer UK + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -265 + details: + - name: CreditNotes + amount: -265 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 15 + details: + - name: Invoices + amount: 30 + - name: Payments + amount: -15 + - customerId: f40870d5b704407481be14f780122d4f + customerName: J Customer US + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -161570 + details: + - name: CreditNotes + amount: -161570 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 181372 + details: + - name: Invoices + amount: 181372 + - customerId: 50a66e9756d2416d946419948bcf3631 + customerName: J Customer ZA + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10 + details: + - name: CreditNotes + amount: -10 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: 0328dd6b109a4a6cbcb3d1a73f1d541b + customerName: James Arroyo + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -719 + details: + - name: Invoices + amount: 178 + - name: Payments + amount: -897 + - customerId: bca2a47d7b4549c79b0c092d26b6661c + customerName: Jay Farm + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 25.01 + details: + - name: Invoices + amount: 25.01 + - customerId: 6477be6d012b4d48b4c160c098645c1c + customerName: Jo's Bake Shop + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -37.8 + details: + - name: CreditNotes + amount: -37.8 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 22.25 + details: + - name: Invoices + amount: 48 + - name: Payments + amount: -25.75 + - customerId: 097305a078ba473c884d2519ab290e57 + customerName: John QuickEntry Test + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 396 + details: + - name: Invoices + amount: 396 + - customerId: eac978a7622e4ef8b8d3af661f0cfdd3 + customerName: John Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 200 + details: + - name: Invoices + amount: 200 + - customerId: 3cc3148bbd8111e8bad90617b3da4b8a + customerName: John's Test Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1081.2 + details: + - name: CreditNotes + amount: -1081.2 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3379 + details: + - name: Invoices + amount: 3479 + - name: Payments + amount: -100 + - customerId: f66deccde15843ef80a82daad887146b + customerName: Kiran testing 2 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 48 + details: + - name: Invoices + amount: 48 + - customerId: 6e921696a21a45c891ff4716a18e7649 + customerName: M Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 900 + details: + - name: Invoices + amount: 900 + - customerId: bbb0582a0d054f5db268e570b50b4d6c + customerName: Mark Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 40 + details: + - name: Invoices + amount: 40 + - customerId: 440ba2199c07426a93e8edc1beb09791 + customerName: Matt Ager test EUR customer + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -8159.78 + details: + - name: CreditNotes + amount: -8159.78 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6016.67 + details: + - name: Invoices + amount: 6022.98 + - name: Payments + amount: -6.31 + - customerId: d430ed86b05645d7af0a630dae5d11d2 + customerName: Matthew Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 240 + details: + - name: Invoices + amount: 240 + - customerId: 9e8c3d82a2164ad29e29ab3a09ddf382 + customerName: Morv Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 300 + details: + - name: Invoices + amount: 300 + - customerId: fbdd38adb5b4441ebb200b83700d7ea5 + customerName: My Shop Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -384 + details: + - name: CreditNotes + amount: -384 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 398 + details: + - name: Invoices + amount: 398 + - customerId: 4b4cc40d998f47c3bec92fc088dcf327 + customerName: Nicoletta Carchia + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 90 + details: + - name: Invoices + amount: 90 + - customerId: ed070b1768bb4dd295e2a544a74c8ec0 + customerName: Paige Burlingham + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -48 + details: + - name: CreditNotes + amount: -48 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 48 + details: + - name: Invoices + amount: 48 + - customerId: 84709d3f01a4462eb7f1527718f525f4 + customerName: SageOneCustomer.BusinessName + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1085 + details: + - name: CreditNotes + amount: -1085 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: 90c438274d0b43759407da704394c104 + customerName: Test Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -16.2 + details: + - name: CreditNotes + amount: -16.2 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1137.2 + details: + - name: Invoices + amount: 1137.2 + - customerId: 762e6895c1ff43f988f35fb507e20dd9 + customerName: Test Custiomer 2 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -615 + details: + - name: CreditNotes + amount: -615 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2178.25 + details: + - name: Invoices + amount: 2178.25 + - customerId: 7b9c18af4b66454b9f7e9409eb7da123 + customerName: Test Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1200 + details: + - name: Invoices + amount: 1200 + - customerId: 4ccf5c5fa14046ecb591e0620d87ea2e + customerName: Test Customer 3 + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -50 + details: + - name: CreditNotes + amount: -50 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 499971 + details: + - name: Invoices + amount: 499971 + - customerId: f4ff85ba33dd11e797950a57719b2edb + customerName: Widgets Limited + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -23206.12 + details: + - name: CreditNotes + amount: -23206.12 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 733824.64 + details: + - name: Invoices + amount: 739536.49 + - name: Payments + amount: -5711.85 + Sage Intacct: + value: + generated: '2023-05-02T16:05:22.6557479Z' + reportDate: '2023-05-02T16:05:22.6081858Z' + data: + - customerId: '6' + customerName: AG Insurance + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 180 + details: + - name: Invoices + amount: 180 + - customerId: '531' + customerName: Shoprite + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -150 + details: + - name: Payments + amount: -150 + Xero: + value: + generated: '2023-05-02T16:05:20.0730291Z' + reportDate: '2023-05-02T16:05:20.0102278Z' + data: + - customerId: 305ca5cf-497d-4fee-a161-cdb30e6be989 + customerName: Basket Case + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 914.55 + details: + - name: Invoices + amount: 914.55 + - customerId: 362819c9-f285-4d09-ac95-26327863adac + customerName: Bayside Club + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3434 + details: + - name: Invoices + amount: 3434 + - customerId: 9ce626d2-14ea-463c-9fff-6785ab5f9bfb + customerName: Boom FM + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1623.75 + details: + - name: Invoices + amount: 1623.75 + - customerId: c523e12f-8b74-4d3a-bbd8-32d7a2f598b4 + customerName: City Limousines + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1169.95 + details: + - name: Invoices + amount: 1169.95 + - customerId: 1262c350-fe0f-40ec-aeff-41c95b4a45af + customerName: DIISR - Small Business Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4470.63 + details: + - name: Invoices + amount: 4470.63 + - customerId: 94cb6d7b-5291-49f3-a0bc-fc0c01e68575 + customerName: Marine Systems + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 396 + details: + - name: Invoices + amount: 396 + - customerId: 847933f0-7c35-4e5b-b884-5f9df64c8e4b + customerName: Port & Philip Freight + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2245 + details: + - name: Invoices + amount: 2245 + - customerId: a871a956-05b5-4e2a-9419-7aeb478ca647 + customerName: Ridgeway University + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6187.5 + details: + - name: Invoices + amount: 6187.5 + Zoho Books: + value: + generated: '2023-05-02T16:05:23.2078272Z' + reportDate: '2023-05-02T16:05:23.1573589Z' + data: + - customerId: '104957000000054050' + customerName: 'Doe, John' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10567 + details: + - name: CreditNotes + amount: -10567 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 38965 + details: + - name: Invoices + amount: 39865 + - name: Payments + amount: -900 + - customerId: '104957000000634160' + customerName: Dr. Jekyll + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -110 + details: + - name: CreditNotes + amount: -110 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: '104957000000080010' + customerName: Max Mustermann + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -68 + details: + - name: Invoices + amount: 0 + - name: Payments + amount: -68 + - customerId: '104957000000277089' + customerName: Miss. No Contact Persons + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10 + details: + - name: CreditNotes + amount: -10 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Invoices + amount: 0 + - customerId: '104957000000054080' + customerName: Ms. Jane Doe + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -465 + details: + - name: CreditNotes + amount: -465 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - customerId: '104957000000277001' + customerName: 'Sousa, Diogo' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9001 + details: + - name: Invoices + amount: 9001 + - customerId: '104957000000037097' + customerName: Test Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -9001 + details: + - name: CreditNotes + amount: -9001 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3556.98 + details: + - name: Invoices + amount: 4501 + - name: Payments + amount: -944.02 + - customerId: '104957000001497001' + customerName: Will Westrop + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 56 + details: + - name: Invoices + amount: 56 + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/agedCreditor/available': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + summary: Aged creditors report available + description: Indicates whether the aged creditor report is available for the company. + operationId: is-aged-creditors-report-available + x-speakeasy-name-override: is-aged-creditors-available + x-speakeasy-group: accounts-receivable.reports + responses: + '200': + description: OK + content: + application/json: + schema: + type: boolean + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/agedCreditor': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Accounts payable + parameters: + - $ref: '#/components/parameters/accountingReportDate' + - $ref: '#/components/parameters/accountingNumberOfPeriods' + - $ref: '#/components/parameters/accountingPeriodLengthDays' + summary: Aged creditors report + description: Returns aged creditors report for company that shows the total balance owed by a business to its suppliers over time. + operationId: get-accounting-aged-creditors-report + x-speakeasy-name-override: get-aged-creditors + x-speakeasy-group: accounts-receivable.reports + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAgedCreditorReport' + examples: + Clear Books: + value: + generated: '2023-05-02T16:05:21.7545859Z' + reportDate: '2023-05-02T16:05:21.7016767Z' + data: + - supplierId: owQ2Gqgj9f + supplierName: Abshire - Kshlerin + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -78.12 + details: + - name: BillCreditNotes + amount: -78.12 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 375.6 + details: + - name: Bills + amount: 375.6 + - supplierId: FyUkHbZxhn + supplierName: Arjun Kuvalis + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3782.27 + details: + - name: BillCreditNotes + amount: -3782.27 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 8556.1 + details: + - name: Bills + amount: 8556.1 + - supplierId: gxazX5hqx4 + supplierName: Bernier Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 213.19 + details: + - name: Bills + amount: 213.19 + - supplierId: ro8nWYGzlg + supplierName: Botsford - Hickle + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2242.95 + details: + - name: Bills + amount: 0 + - name: BillCreditNotes + amount: -2242.95 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 838.67 + details: + - name: Bills + amount: 838.67 + - supplierId: D4Q4iYwHou + supplierName: 'Breitenberg, Emard and Schiller' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -276.5 + details: + - name: BillCreditNotes + amount: -276.5 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 46060.53 + details: + - name: Bills + amount: 46060.53 + - supplierId: 9436ead6-545e-4e8c-8444-0220047c5a38 + supplierName: Champlin LLC + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 22726.97 + details: + - name: Bills + amount: 22726.97 + - supplierId: O6jExrbN3v + supplierName: Collins - Anderson + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -19.39 + details: + - name: BillCreditNotes + amount: -19.39 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 9d4b61a4-4ce3-4d90-8d6b-66614694dc27 + supplierName: Crona - Adams + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 302.8 + details: + - name: Bills + amount: 302.8 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: ad8f4ee1-7a04-415f-b3dc-365d41d8d4f0 + supplierName: 'Cronin, Kunde and Tremblay' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3271.91 + details: + - name: BillCreditNotes + amount: -3271.91 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3479.78 + details: + - name: Bills + amount: 3479.78 + - supplierId: 8GeHBdBZiZ + supplierName: 'DuBuque, Goyette and Franecki' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -16511.91 + details: + - name: BillCreditNotes + amount: -16511.91 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: XOPP3v2lQu + supplierName: Fisher and Sons + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 238599.9 + details: + - name: Bills + amount: 238599.9 + - supplierId: 0a7b0432-7de3-4e29-bf15-4e7ca0722384 + supplierName: Flatley - Kirlin + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -113.59 + details: + - name: BillCreditNotes + amount: -113.59 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 910.45 + details: + - name: Bills + amount: 910.45 + - supplierId: HrGZeW4I51 + supplierName: 'Frami, Simonis and Krajcik' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2070.59 + details: + - name: BillCreditNotes + amount: -2070.59 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: SFmBGSHLQ3 + supplierName: Gottlieb LLC + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -105.07 + details: + - name: BillCreditNotes + amount: -105.07 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: unNIu8Uyap + supplierName: Hahn and Sons + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -297.78 + details: + - name: BillCreditNotes + amount: -297.78 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2095.75 + details: + - name: Bills + amount: 2095.75 + - supplierId: GTGS3Sx241 + supplierName: Harvey Predovic + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3612.41 + details: + - name: Bills + amount: 3612.41 + - supplierId: w07H3CBm5P + supplierName: 'Hayes, Predovic and Ruecker' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -11662.51 + details: + - name: BillCreditNotes + amount: -11662.51 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 393776.18 + details: + - name: Bills + amount: 393776.18 + - supplierId: 92144542-2227-409e-8f5b-fc73260e670b + supplierName: 'Hettinger, Schmitt and Will' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 3433.54 + details: + - name: Bills + amount: 3433.54 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: rpLhEYz0ML + supplierName: Hickle - Buckridge + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -7484.88 + details: + - name: BillCreditNotes + amount: -7484.88 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: d2056eb9-649e-4808-8f96-d8ea4dac71fe + supplierName: Hodkiewicz Group + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -6627.16 + details: + - name: BillCreditNotes + amount: -6627.16 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 18266.27 + details: + - name: Bills + amount: 18266.27 + - supplierId: s3WcvMyVdR + supplierName: Howe - Ruecker + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4042.16 + details: + - name: Bills + amount: 4042.16 + - supplierId: b60XbI9zhE + supplierName: Jenkins Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -12938.29 + details: + - name: BillCreditNotes + amount: -12938.29 + - name: Bills + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 18360.8 + details: + - name: Bills + amount: 18360.8 + - supplierId: OtXKRTOcQc + supplierName: Jensen Steuber + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 190.16 + details: + - name: Bills + amount: 190.16 + - supplierId: c02bc2f1-631d-4721-aec1-a190d63e8322 + supplierName: Jones - Zulauf + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -69.05 + details: + - name: BillCreditNotes + amount: -69.05 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 51357.36 + details: + - name: Bills + amount: 51357.36 + - supplierId: c02382bd-ff23-4b34-bfd7-8dce15fa7d6a + supplierName: Keara Leffler + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2496.69 + details: + - name: BillCreditNotes + amount: -2496.69 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1519.74 + details: + - name: Bills + amount: 1519.74 + - supplierId: d3tf43eghS + supplierName: Klocko - Keebler + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12367.4 + details: + - name: Bills + amount: 12367.4 + - supplierId: 7GObELDcsE + supplierName: 'Lakin, Schmeler and Kihn' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -318.71 + details: + - name: BillCreditNotes + amount: -318.71 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: gO8p5O3Mvy + supplierName: Lehner Group + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1042.8 + details: + - name: BillCreditNotes + amount: -1042.8 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 62229022-713f-4c64-84f2-63cf6dd11443 + supplierName: Littel - Cole + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -7.5 + details: + - name: BillCreditNotes + amount: -7.5 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 39b32019-c5d0-4db3-ae83-f0a644e614ef + supplierName: Marvin - Schaden + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1611.56 + details: + - name: BillCreditNotes + amount: -1611.56 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 8635b986-048f-424c-985d-912576c004d9 + supplierName: 'Mills, Bechtelar and Wintheiser' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -604.41 + details: + - name: BillCreditNotes + amount: -604.41 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: d2fb1aba-79ac-4840-95d5-6c173c9beaad + supplierName: Morissette LLC + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -55.93 + details: + - name: BillCreditNotes + amount: -55.93 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 27dc0345-aae8-4b69-a903-fed6b0a8778b + supplierName: Newton Zieme + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1546.46 + details: + - name: Bills + amount: 1546.46 + - supplierId: 0d892acd-4b56-4412-80ee-381b8118637b + supplierName: Nicolas - McKenzie + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -186.97 + details: + - name: BillCreditNotes + amount: -186.97 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5131.74 + details: + - name: Bills + amount: 5131.74 + - supplierId: cc283863-960f-42f8-8e38-1e22235e9cfc + supplierName: Nicolas Group + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -6.41 + details: + - name: BillCreditNotes + amount: -6.41 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 9UvJVVmPHO + supplierName: Nienow - Schroeder + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2822.41 + details: + - name: BillCreditNotes + amount: -2822.41 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 1346295c-2970-47a7-8a99-1f935567db02 + supplierName: Polly Crona + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3600.36 + details: + - name: Bills + amount: 3600.36 + - supplierId: 5fcb09bf-ae92-42a1-a69b-57c5f0ebedd9 + supplierName: Raul Johns + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2938.85 + details: + - name: Bills + amount: 0 + - name: BillCreditNotes + amount: -2938.85 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: 4253a13e-638e-4a42-9e61-665a60267a48 + supplierName: 'Robel, Ledner and Stroman' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1106.72 + details: + - name: Bills + amount: 1106.72 + - supplierId: 143ed2c5-2623-465e-a015-5ac12df75aa6 + supplierName: Schulist - Douglas + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -12468.22 + details: + - name: BillCreditNotes + amount: -12468.22 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 39306.44 + details: + - name: Bills + amount: 39306.44 + - supplierId: d770b767-489e-455b-9d32-29c37a1b9d07 + supplierName: Schultz Group + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -517.52 + details: + - name: BillCreditNotes + amount: -517.52 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 98e93284-fcaa-440c-8f86-f36e5df591da + supplierName: Simonis - Ziemann + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -597.01 + details: + - name: BillCreditNotes + amount: -597.01 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: 87e907ed-97f8-4146-b276-fea2a10671bf + supplierName: Sporer and Sons + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -62443.6 + details: + - name: BillCreditNotes + amount: -62443.6 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: 97682025-4e50-449f-8510-6d09d1d0f84b + supplierName: Sporer LLC + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1104.37 + details: + - name: BillCreditNotes + amount: -1104.37 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1050.12 + details: + - name: Bills + amount: 1050.12 + - supplierId: c51351a0-b43f-48c6-8dbb-8417171bda67 + supplierName: Veum - Schiller + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1966.59 + details: + - name: BillCreditNotes + amount: -1966.59 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10234.97 + details: + - name: Bills + amount: 10234.97 + - supplierId: 26f6b56a-4a86-468f-a302-9d60bdc01d91 + supplierName: Vincenzo Wolff + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -23450.31 + details: + - name: BillCreditNotes + amount: -23450.31 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: f589fd05-c5f8-4815-b205-0a9f3f0b3b96 + supplierName: Weber LLC + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -681.79 + details: + - name: BillCreditNotes + amount: -681.79 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10221.45 + details: + - name: Bills + amount: 10221.45 + - supplierId: 1cc8b95c-62ec-415a-ab0e-facf7e7218bf + supplierName: 'Welch, Terry and Hermiston' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1219.54 + details: + - name: Bills + amount: 1219.54 + - supplierId: f6CgWtm1aw + supplierName: Wisoky Group + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 272.67 + details: + - name: Bills + amount: 272.67 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: je5ok1Cam5 + supplierName: 'Wunsch, Kerluke and West' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7238.24 + details: + - name: Bills + amount: 7238.24 + Dynamics 365 Business Central: + value: + generated: '2023-05-02T16:05:21.1349781Z' + reportDate: '2023-05-02T16:05:21.0866594Z' + data: + - supplierId: e89328bd-485a-eb11-89fa-00224800af18 + supplierName: A QA + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -526.8 + details: + - name: BillCreditNotes + amount: -526.8 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 120 + details: + - name: Bills + amount: 120 + - supplierId: be1217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: 'Fabrikam, Inc.' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -65 + details: + - name: BillCreditNotes + amount: -65 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -11904.4 + details: + - name: Bills + amount: 461.6 + - name: BillPayments + amount: -12366 + - currency: PLN + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -15 + details: + - name: BillPayments + amount: -15 + - currency: MAD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5 + details: + - name: Bills + amount: 5 + - supplierId: c01217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: First Up Consultants + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12123.81 + details: + - name: Bills + amount: 12128.81 + - name: BillPayments + amount: -5 + - supplierId: c21217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: Graphic Design Institute + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7514.8 + details: + - name: Bills + amount: 7520.8 + - name: BillPayments + amount: -6 + - supplierId: 4a1b210e-b805-ec11-86bc-0022481a45c2 + supplierName: Kays Farm + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -121 + details: + - name: BillPayments + amount: -121 + - supplierId: c61217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: Nod Publishers + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 13156.74 + details: + - name: Bills + amount: 13156.74 + - supplierId: b864b5ae-4a5a-eb11-89fa-00224800af18 + supplierName: Test Supplier + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3951 + details: + - name: Bills + amount: 3951 + - currency: MAD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 121.45 + details: + - name: Bills + amount: 121.45 + - supplierId: 8b4c95b4-b705-ec11-86bc-0022481a45c2 + supplierName: Vegan Farm + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -5.27 + details: + - name: Bills + amount: 0 + - name: BillPayments + amount: -5.27 + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -11.75 + details: + - name: BillPayments + amount: -11.75 + - supplierId: c41217b3-89d1-ea11-bbaa-000d3a2b9185 + supplierName: Wide World Importers + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 15843.22 + details: + - name: Bills + amount: 15848.22 + - name: BillPayments + amount: -5 + Exact (Netherlands): + value: + generated: '2023-05-02T16:05:19.8312183Z' + reportDate: '2023-05-02T16:05:19.7538301Z' + data: + - supplierId: 3150917c-1d92-4d77-9018-31b5c4758ca9 + supplierName: Abe + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -38.28 + details: + - name: BillCreditNotes + amount: -38.28 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1952.27 + details: + - name: Bills + amount: 1941.58 + - name: BillPayments + amount: 10.69 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Bills + amount: 10 + - supplierId: 5811b467-53eb-4491-8ca1-bc9b7889811b + supplierName: Ann's test supplier 2 + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10000 + details: + - name: BillCreditNotes + amount: -10000 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 117 + details: + - name: Bills + amount: 117 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4997.25 + details: + - name: Bills + amount: 4997.25 + - supplierId: 78afea22-ee21-48c3-84d5-45b9b24768e9 + supplierName: Ann's test supplier 2 + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 110 + details: + - name: Bills + amount: 108 + - name: BillPayments + amount: 2 + - supplierId: 773416a6-b196-487b-ae02-eeb273a86bcd + supplierName: Belastingdienst + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -293.14 + details: + - name: BillCreditNotes + amount: -293.14 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1547.08 + details: + - name: Bills + amount: 1547.08 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 32.17 + details: + - name: Bills + amount: 32.17 + - supplierId: 7017da1f-2d49-4601-abf3-c4e779459976 + supplierName: Bool Test + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 121 + details: + - name: Bills + amount: 121 + - supplierId: f87070e2-bbd7-4383-a7c9-824748c1d70e + supplierName: Exact Software Nederland B.V. + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -65.73 + details: + - name: BillCreditNotes + amount: -65.73 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -83351.62 + details: + - name: BillPayments + amount: -83381.63 + - name: Bills + amount: 30.01 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -8285.73 + details: + - name: BillPayments + amount: -8285.73 + - supplierId: 8cb6745b-4769-4c7a-9d92-bc688c60ca3c + supplierName: iZettle AB (Supplier) + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 19.93 + details: + - name: Bills + amount: 19.93 + - supplierId: 63fadca8-4905-475a-b32a-b4341293bcf4 + supplierName: Kelly's Industrial Supplies + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5 + details: + - name: BillPayments + amount: 5 + - supplierId: acde3236-898e-4e68-b076-4e946defbc5f + supplierName: Matt Ager Test Supplier 1 + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -276 + details: + - name: BillCreditNotes + amount: -276 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 75 + details: + - name: Bills + amount: 105 + - name: BillPayments + amount: -30 + - currency: RUB + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -10 + details: + - name: BillPayments + amount: -10 + - supplierId: 5e6f49b9-6489-4b82-83e7-291d308919bb + supplierName: Mickey Mouse + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -12.1 + details: + - name: BillCreditNotes + amount: -12.1 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 119.97 + details: + - name: Bills + amount: 119.97 + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -7040 + details: + - name: BillCreditNotes + amount: -7040 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 8800 + details: + - name: Bills + amount: 8800 + - supplierId: fc189bfa-f083-438c-bf09-379a0631d4a1 + supplierName: Mickey Mouse + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -0.83 + details: + - name: Bills + amount: -0.83 + - supplierId: 1d2c9f47-a2fc-48e6-a967-71583d764b10 + supplierName: NLSuppliers07 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 25 + details: + - name: Bills + amount: 25 + - supplierId: a1e88d58-caec-4ed6-ad1b-646ebb959c17 + supplierName: supplierrrr + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -55 + details: + - name: BillCreditNotes + amount: -55 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 11084 + details: + - name: Bills + amount: 11084 + - supplierId: cdcdce7b-0330-49fb-8169-0a50e0b74dcc + supplierName: Test NL sup1 + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 13.21 + details: + - name: BillPayments + amount: 13.21 + - supplierId: bad8020a-267f-41fb-9e0f-e93465ee9529 + supplierName: Test supplier + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 718.22 + details: + - name: Bills + amount: 718.22 + - supplierId: 26bc5305-8613-43e4-ab97-522ade34cbba + supplierName: Vandana's Test Supplier + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 403.74 + details: + - name: Bills + amount: 403.74 + Exact (UK): + value: + generated: '2023-05-02T16:05:22.8960035Z' + reportDate: '2023-05-02T16:05:22.8283897Z' + data: + - supplierId: 0185fea2-0298-445b-909a-0db685118a9e + supplierName: a + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10 + details: + - name: BillCreditNotes + amount: -10 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 560.1 + details: + - name: Bills + amount: 660.1 + - name: BillPayments + amount: -100 + - supplierId: 64ae712f-4155-48bb-9fce-98232c51d979 + supplierName: aa + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -400 + details: + - name: BillCreditNotes + amount: -400 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 30 + details: + - name: Bills + amount: 430 + - name: BillPayments + amount: -400 + - supplierId: 5f20075a-a28e-434d-81a6-2db0dc170e87 + supplierName: Abdi 99 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -65 + details: + - name: BillCreditNotes + amount: -65 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 609 + details: + - name: Bills + amount: 258 + - name: BillPayments + amount: 351 + - supplierId: 0d3f8692-4b0a-4bc3-85f2-4cb763306397 + supplierName: Ann's test supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3600 + details: + - name: BillCreditNotes + amount: -3600 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2400 + details: + - name: Bills + amount: 2400 + - supplierId: fc62db43-a6f8-4b65-9d29-15290ec56674 + supplierName: Anna's test supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1717.5 + details: + - name: BillCreditNotes + amount: -1717.5 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2751 + details: + - name: Bills + amount: 2751 + - supplierId: cde51f36-2a06-4eac-9784-c0c967c1e1ed + supplierName: b + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -6 + details: + - name: BillCreditNotes + amount: -6 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: 437c6631-3c5d-4351-b757-6ad4f94bd26e + supplierName: bb + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 220 + details: + - name: Bills + amount: 220 + - supplierId: fe713acb-3c98-423d-8372-68a32aae6232 + supplierName: cc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -60 + details: + - name: BillPayments + amount: -60 + - supplierId: 1c703cce-967c-4476-a86a-32e35341a8f5 + supplierName: Customer Bill Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -100073.4 + details: + - name: BillCreditNotes + amount: -100073.4 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 374.8 + details: + - name: Bills + amount: 373.8 + - name: BillPayments + amount: 1 + - supplierId: 6a4c6a14-d5eb-4427-aae0-c544f67dff7a + supplierName: CustomerAndSupplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2.05 + details: + - name: BillPayments + amount: 2.05 + - supplierId: efb5d438-7d3a-4b77-a254-2d90f76d3f22 + supplierName: dd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 200 + details: + - name: Bills + amount: 200 + - supplierId: 77b652bb-a363-4425-adbd-0206e2ce4639 + supplierName: e + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -72.33 + details: + - name: BillCreditNotes + amount: -72.33 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: a4d5d739-c979-4819-b0ce-666db1ec3a7d + supplierName: Exact Software (UK) Ltd � Exact Online + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 133.6 + details: + - name: Bills + amount: 133.6 + - supplierId: 7c8a9143-7322-48e3-b809-88a038b8a0e0 + supplierName: John Doe + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 192.5 + details: + - name: Bills + amount: 192.5 + - supplierId: a7cad20d-44db-442b-ac1f-90475802d6fb + supplierName: Pencils Pencils Pencils + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1200 + details: + - name: BillCreditNotes + amount: -1200 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3837 + details: + - name: Bills + amount: 3837 + - supplierId: 41302634-76b5-4442-b800-0bb63780e77c + supplierName: Some Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -46.8 + details: + - name: BillCreditNotes + amount: -46.8 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -54537.12 + details: + - name: Bills + amount: 455.73 + - name: BillPayments + amount: -54992.85 + FreeAgent: + value: + generated: '2023-05-02T16:05:23.3560058Z' + reportDate: '2023-05-02T16:05:23.3059155Z' + data: + - supplierId: '10123537' + supplierName: _Test 1 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: + - name: BillPayments + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 791 + details: + - name: Bills + amount: 791 + - currency: QAR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12 + details: + - name: Bills + amount: 12 + - supplierId: '11526230' + supplierName: '-' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -6430 + details: + - name: Bills + amount: 1500 + - name: BillCreditNotes + amount: -7930 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1200 + details: + - name: Bills + amount: 1200 + - supplierId: '9677150' + supplierName: '-' + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5 + details: + - name: Bills + amount: 5 + - supplierId: '8959011' + supplierName: '1' + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -134.3 + details: + - name: BillCreditNotes + amount: -134.3 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 46 + details: + - name: Bills + amount: 46 + - supplierId: '6161941' + supplierName: A & J Fabtech Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -2433.99 + details: + - name: BillCreditNotes + amount: -2433.99 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3431 + details: + - name: Bills + amount: 3431 + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 400 + details: + - name: Bills + amount: 400 + - supplierId: '6161963' + supplierName: ABB Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -10 + details: + - name: BillCreditNotes + amount: -10 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: + - name: Bills + amount: 0 + - supplierId: '9356878' + supplierName: Abdul Al-haj + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12 + details: + - name: Bills + amount: 12 + - supplierId: '8984892' + supplierName: Abraham's Spider Hunting Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 77 + details: + - name: Bills + amount: 77 + - supplierId: '9273150' + supplierName: Best Company + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -456 + details: + - name: BillCreditNotes + amount: -456 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: '6161956' + supplierName: C Allen + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -100 + details: + - name: BillCreditNotes + amount: -100 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 122 + details: + - name: Bills + amount: 122 + - supplierId: '7994567' + supplierName: codat + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Bills + amount: 10 + - supplierId: '5730310' + supplierName: Demo Customer + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 200 + details: + - name: Bills + amount: 200 + - supplierId: '6162169' + supplierName: PricewaterhouseCoopers LLP + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 42 + details: + - name: Bills + amount: 42 + - supplierId: '10672202' + supplierName: Random Org + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -42 + details: + - name: BillCreditNotes + amount: -42 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 130 + details: + - name: Bills + amount: 130 + - supplierId: '8989342' + supplierName: Supplier Hidden + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -500 + details: + - name: BillCreditNotes + amount: -500 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -150 + details: + - name: BillPayments + amount: -150 + - supplierId: '7169654' + supplierName: The Eagle + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -492 + details: + - name: BillCreditNotes + amount: -492 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3523.75 + details: + - name: Bills + amount: 3523.75 + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 301 + details: + - name: Bills + amount: 301 + MYOB AccountRight and Essentials: + value: + generated: '2023-05-02T16:05:21.5229720Z' + reportDate: '2023-05-02T16:05:21.2821865Z' + data: [] + Oracle NetSuite: + value: + generated: '2023-05-02T16:05:20.3296968Z' + reportDate: '2023-05-02T16:05:20.2442587Z' + data: + - supplierId: '779' + supplierName: Test Vendor + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 56 + details: + - name: Bills + amount: 56 + - supplierId: '724' + supplierName: Vendor A.A.A + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 579.55 + details: + - name: Bills + amount: 524 + - name: BillPayments + amount: 55.55 + QuickBooks Desktop: + value: + generated: '2023-05-02T16:05:20.3972104Z' + reportDate: '2023-05-02T16:05:20.3178060Z' + data: + - supplierId: B0000-933272656 + supplierName: Patton Hardware Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: + - name: BillPayments + amount: 0 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5000 + details: + - name: Bills + amount: 5000 + QuickBooks Online: + value: + generated: '2023-05-02T16:05:21.3065432Z' + reportDate: '2023-05-02T16:05:21.2488309Z' + data: + - supplierId: '129' + supplierName: Ally Johnson + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 230.98 + details: + - name: Bills + amount: 276.38 + - name: BillPayments + amount: -45.4 + - supplierId: '88' + supplierName: Andrew Haberbosch + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -16 + details: + - name: BillCreditNotes + amount: -16 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 66.25 + details: + - name: BillPayments + amount: -13.75 + - name: Bills + amount: 80 + - supplierId: '53' + supplierName: Bank of AnyCity + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 63 + details: + - name: Bills + amount: 63 + - supplierId: '282' + supplierName: Becky's Bakery + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 490.5 + details: + - name: BillPayments + amount: -9.5 + - name: Bills + amount: 500 + - supplierId: '24' + supplierName: Brijesh Jain + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -69 + details: + - name: BillCreditNotes + amount: -69 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 52260 + details: + - name: Bills + amount: 52260 + - supplierId: '25' + supplierName: Brittney Hughes + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 70 + details: + - name: Bills + amount: 70 + - supplierId: '26' + supplierName: Burc Gunes + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 33.05 + details: + - name: Bills + amount: 33.05 + - supplierId: '27' + supplierName: Cass Hayden + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1450 + details: + - name: Bills + amount: 1500 + - name: BillPayments + amount: -50 + - supplierId: '51' + supplierName: City Water Co + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7.25 + details: + - name: Bills + amount: 24 + - name: BillPayments + amount: -16.75 + - supplierId: '297' + supplierName: Codat Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -128 + details: + - name: Bills + amount: 0 + - name: BillPayments + amount: -25 + - name: BillCreditNotes + amount: -103 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -328.32 + details: + - name: Bills + amount: 0 + - name: BillPayments + amount: -328.32 + - supplierId: '87' + supplierName: Costco + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -17.85 + details: + - name: BillPayments + amount: -17.85 + - supplierId: '57' + supplierName: Hall's Promo Items + agedCurrencyOutstanding: + - currency: HKD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1041.09 + details: + - name: Bills + amount: 1041.09 + - supplierId: '92' + supplierName: Huw Thomas + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 25292 + details: + - name: Bills + amount: 25302 + - name: BillPayments + amount: -10 + - supplierId: '85' + supplierName: Jay's Farm + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -446.83 + details: + - name: BillCreditNotes + amount: -446.83 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9759.68 + details: + - name: Bills + amount: 9822.46 + - name: BillPayments + amount: -62.78 + - supplierId: '34' + supplierName: Jennifer Hargreaves + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 239.01 + details: + - name: Bills + amount: 239.01 + - supplierId: '37' + supplierName: Kristina Gibson + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1710 + details: + - name: BillCreditNotes + amount: -1710 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 502.38 + details: + - name: Bills + amount: 502.38 + - supplierId: '41' + supplierName: Mark Howard + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 3000 + details: + - name: Bills + amount: 3000 + - supplierId: '23' + supplierName: Mr Andrew Thomas Haberbosch + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -21.2 + details: + - name: BillCreditNotes + amount: -21.2 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 54.09 + details: + - name: Bills + amount: 54.09 + - supplierId: '54' + supplierName: Organization of Outstanding Event Planners + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 390 + details: + - name: Bills + amount: 390 + - supplierId: '47' + supplierName: Sanjeev Kak + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 21 + details: + - name: Bills + amount: 21 + - supplierId: '74' + supplierName: TestPushCustomer3 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 200 + details: + - name: Bills + amount: 200 + - supplierId: '86' + supplierName: Vegan Farm + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -42.76 + details: + - name: BillCreditNotes + amount: -42.76 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1249.3 + details: + - name: BillPayments + amount: -504.24 + - name: Bills + amount: 1753.54 + - supplierId: '58' + supplierName: Venue Rental + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 461 + details: + - name: Bills + amount: 500 + - name: BillPayments + amount: -39 + Sage 200cloud: + value: + generated: '2023-05-02T16:05:20.7939148Z' + reportDate: '2023-05-02T16:05:20.7474542Z' + data: + - supplierId: CON002 + supplierName: Concept Stationery Sub A + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 411.76 + details: + - name: Bills + amount: 782.56 + - name: BillPayments + amount: -370.8 + - supplierId: CON001 + supplierName: Concept Stationery Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -167.1 + details: + - name: BillCreditNotes + amount: -167.1 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5062.78 + details: + - name: Bills + amount: 5111.01 + - name: BillPayments + amount: -48.23 + - supplierId: MCN001 + supplierName: McNally Computer Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 25802.03 + details: + - name: Bills + amount: 25934.03 + - name: BillPayments + amount: -132 + - supplierId: MEA001 + supplierName: Mears Insurance + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -48 + details: + - name: BillCreditNotes + amount: -48 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1368.02 + details: + - name: Bills + amount: 1524 + - name: BillPayments + amount: -155.98 + - supplierId: NEW001 + supplierName: Newtown Builders Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -13.21 + details: + - name: BillCreditNotes + amount: -13.21 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1024.13 + details: + - name: Bills + amount: 1041.61 + - name: BillPayments + amount: -17.48 + - supplierId: QUA001 + supplierName: Quality Motors + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -105.64 + details: + - name: BillCreditNotes + amount: -105.64 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 155.92 + details: + - name: Bills + amount: 155.92 + - supplierId: RSP002 + supplierName: Richard Sanderson-Pope + agedCurrencyOutstanding: + - currency: JPY + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 60000 + details: + - name: Bills + amount: 60000 + - supplierId: SDE001 + supplierName: S D Enterprises + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1130.29 + details: + - name: Bills + amount: 1189.29 + - name: BillPayments + amount: -59 + - supplierId: STU001 + supplierName: Studio Designs + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 562.06 + details: + - name: Bills + amount: 562.06 + - supplierId: SUP002 + supplierName: Superclean + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 2055.3 + details: + - name: Bills + amount: 2055.3 + - supplierId: SUP001 + supplierName: Superior Technologies Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9433.71 + details: + - name: Bills + amount: 9433.71 + - supplierId: THO001 + supplierName: Thompsons Electricals + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -135.13 + details: + - name: BillCreditNotes + amount: -135.13 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 576.04 + details: + - name: Bills + amount: 1091.04 + - name: BillPayments + amount: -515 + - supplierId: UNI001 + supplierName: Unique Systems + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -103.4 + details: + - name: BillCreditNotes + amount: -103.4 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1104.16 + details: + - name: Bills + amount: 1104.16 + - supplierId: WAL001 + supplierName: Wallace Office Equipment + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -70.76 + details: + - name: BillCreditNotes + amount: -70.76 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -55.52 + details: + - name: Bills + amount: 94.48 + - name: BillPayments + amount: -150 + - supplierId: WIS001 + supplierName: Wise Electricals Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -35.01 + details: + - name: BillCreditNotes + amount: -35.01 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -221.75 + details: + - name: Bills + amount: -121.75 + - name: BillPayments + amount: -100 + - supplierId: WIS002 + supplierName: Wiseman Paper Products + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5868.13 + details: + - name: Bills + amount: 5868.13 + Sage 50 (UK): + value: + generated: '2023-05-02T16:05:20.0257207Z' + reportDate: '2023-05-02T16:05:19.9751677Z' + data: + - supplierId: CON001 + supplierName: Concept Stationery Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1644.39 + details: + - name: Bills + amount: 1644.39 + - supplierId: MCN001 + supplierName: McNally Computer Supplies + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 24734.12 + details: + - name: Bills + amount: 24734.12 + - supplierId: NEW001 + supplierName: Newtown Builders Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -0.01 + details: + - name: BillCreditNotes + amount: -0.01 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0.01 + details: + - name: Bills + amount: 0.01 + - supplierId: QUA001 + supplierName: Quality Motors + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -42.63 + details: + - name: BillCreditNotes + amount: -42.63 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 72.85 + details: + - name: Bills + amount: 72.85 + - supplierId: SDE001 + supplierName: S D Enterprises + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 352.5 + details: + - name: Bills + amount: 352.5 + - supplierId: SUP002 + supplierName: Superclean + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1762.5 + details: + - name: Bills + amount: 1762.5 + - supplierId: SUP001 + supplierName: Superior Technologies Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9164.95 + details: + - name: Bills + amount: 9164.95 + - supplierId: THO001 + supplierName: Thompsons Electricals + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -135.13 + details: + - name: BillCreditNotes + amount: -135.13 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 472.24 + details: + - name: Bills + amount: 972.24 + - name: BillPayments + amount: -500 + - supplierId: UNI001 + supplierName: Unique Systems + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -103.4 + details: + - name: BillCreditNotes + amount: -103.4 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 744.16 + details: + - name: Bills + amount: 744.16 + - supplierId: WAL001 + supplierName: Wallace Office Equipment + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -58.76 + details: + - name: BillCreditNotes + amount: -58.76 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -55.52 + details: + - name: Bills + amount: 94.48 + - name: BillPayments + amount: -150 + - supplierId: WIS001 + supplierName: Wise Electricals Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -35.01 + details: + - name: BillCreditNotes + amount: -35.01 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 117.29 + details: + - name: Bills + amount: 117.29 + - supplierId: WIS002 + supplierName: Wiseman Paper Products + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 5868.13 + details: + - name: Bills + amount: 5868.13 + Sage Business Cloud Accounting: + value: + generated: '2023-05-02T16:05:21.3095542Z' + reportDate: '2023-05-02T16:05:21.1514485Z' + data: + - supplierId: 65179671e9ef424caff8b9006cd111c8 + supplierName: 5555 Abdul's Test Name + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -60 + details: + - name: BillCreditNotes + amount: -60 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1548.84 + details: + - name: Bills + amount: 1608.84 + - name: BillPayments + amount: -60 + - supplierId: cf7f44d693904944a6a7cf3de0887964 + supplierName: Abdi Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -841570.32 + details: + - name: BillCreditNotes + amount: -841570.32 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 661901.14 + details: + - name: Bills + amount: 662062.14 + - name: BillPayments + amount: -161 + - supplierId: f82f0f59fbf44416b833562783388ee9 + supplierName: Abe's Spider Hunting Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -38.8 + details: + - name: Bills + amount: 1.2 + - name: BillPayments + amount: -40 + - supplierId: ec716559789111e8aaa5027d54329956 + supplierName: Bagels Limited + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -140.97 + details: + - name: BillCreditNotes + amount: -140.97 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1856307.16 + details: + - name: BillPayments + amount: -213 + - name: Bills + amount: 1856520.16 + - supplierId: b1354c4ae5db4d069acbcf49bee62215 + supplierName: Boyer Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 360000 + details: + - name: Bills + amount: 360000 + - supplierId: 46b3d6acedcb4738a9646dc512562cda + supplierName: callum + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1.2 + details: + - name: Bills + amount: 1.2 + - supplierId: 7e7450fadbb94d09abdaf609a51d05eb + supplierName: Debs UK Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -36 + details: + - name: BillCreditNotes + amount: -36 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1814652 + details: + - name: Bills + amount: 1814652 + - supplierId: bf6fc20701264c899a1ba96365aa9d70 + supplierName: Eliana's + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -105.6 + details: + - name: BillCreditNotes + amount: -105.6 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 26.4 + details: + - name: Bills + amount: 26.4 + - supplierId: 30862a4b2c084a4fa2e640f9ef371e4c + supplierName: Flour Inc + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 60 + details: + - name: Bills + amount: 60 + - supplierId: 390ca10633cb4bf989961491e834b47a + supplierName: Jo Cheese + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 9 + details: + - name: Bills + amount: 9 + - supplierId: b10be78d0e9340a79743c538a0b481d0 + supplierName: M7 Smith + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 65150090 + details: + - name: Bills + amount: 65150090 + - supplierId: 693d3b961e744b02a6a260f4bada75b0 + supplierName: Matt Ager Test EU Supplier + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -6841.33 + details: + - name: BillCreditNotes + amount: -6841.33 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 6841.33 + details: + - name: Bills + amount: 6841.33 + - supplierId: 1edf56c368e14a35a050b3e8336e2272 + supplierName: Mike B Commerce Test + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 300 + details: + - name: Bills + amount: 300 + - supplierId: c6d3fa5bf2634b148d0ee82b6fbb8fe3 + supplierName: my shop supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -120 + details: + - name: BillCreditNotes + amount: -120 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: cdeae2fcbe6447f698d2a59d68e4ad82 + supplierName: Nic Supp + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -36 + details: + - name: BillCreditNotes + amount: -36 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 0 + details: [] + - supplierId: 2e14c8cfee3041a4a5e8a619b336f900 + supplierName: Nic Supplies Ltd + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 30 + details: + - name: Bills + amount: 30 + - supplierId: c41981674176495f927f46ce663d46ac + supplierName: Ninetta Ponting + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -306 + details: + - name: BillPayments + amount: -306 + - supplierId: e2dd680fed99410982673f8fc2722357 + supplierName: Supplier 70 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -70 + details: + - name: BillPayments + amount: -70 + - supplierId: 8d61f7cd3a2f4ceea26ac5bca15e10da + supplierName: Supplier 71 (AUD) + agedCurrencyOutstanding: + - currency: AUD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: -701 + details: + - name: BillPayments + amount: -701 + - supplierId: 7a67caeb261f40259f0948785090af0b + supplierName: supplier test + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 12014.4 + details: + - name: Bills + amount: 12014.4 + - supplierId: d884f637bb3a4e589d640085b31ad6ee + supplierName: Tasty Treats Icecreams + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -454 + details: + - name: BillCreditNotes + amount: -454 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 456 + details: + - name: Bills + amount: 456 + - supplierId: ca430e0d156011e8b45c025132dab352 + supplierName: Test Supplier + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -1152.78 + details: + - name: BillCreditNotes + amount: -1152.78 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 14960.37 + details: + - name: Bills + amount: 15064.41 + - name: BillPayments + amount: -104.04 + - supplierId: 2541e491791c485a96cc480cfde112d6 + supplierName: Test Supplier 2 + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -50 + details: + - name: BillCreditNotes + amount: -50 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 63338524.47 + details: + - name: Bills + amount: 63338524.47 + - supplierId: 877aac191c3c40eda61115eea12641f7 + supplierName: Test Supplier 3 + agedCurrencyOutstanding: + - currency: EUR + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: -3535.61 + details: + - name: BillCreditNotes + amount: -3535.61 + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 50658.58 + details: + - name: Bills + amount: 50658.58 + - supplierId: d98e7afb4ca846dfbb12ca285f95f863 + supplierName: Test Supplier 4 (US) + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 51872949 + details: + - name: Bills + amount: 51872949 + Sage Intacct: + value: + generated: '2023-05-02T16:05:22.9252709Z' + reportDate: '2023-05-02T16:05:22.8758390Z' + data: + - supplierId: '3' + supplierName: ADP + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 487.5 + details: + - name: Bills + amount: 487.5 + - supplierId: '14' + supplierName: Kristofferson Consulting + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 7200 + details: + - name: Bills + amount: 7200 + - supplierId: '7' + supplierName: Lenovo + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 190 + details: + - name: Bills + amount: 190 + - supplierId: '8' + supplierName: Worldwide Commercial + agedCurrencyOutstanding: + - currency: USD + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 10 + details: + - name: Bills + amount: 10 + Xero: + value: + generated: '2023-05-02T16:05:20.3006654Z' + reportDate: '2023-05-02T16:05:20.2587933Z' + data: + - supplierId: 699f0091-b127-4796-9f15-41a2f42abeb2 + supplierName: ABC Furniture + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1200 + details: + - name: Bills + amount: 1200 + - supplierId: 362819c9-f285-4d09-ac95-26327863adac + supplierName: Bayside Club + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 130 + details: + - name: Bills + amount: 130 + - supplierId: 2dc0ef7c-582f-4542-963b-dbdc069e4819 + supplierName: Bayside Wholesale + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 961.21 + details: + - name: Bills + amount: 961.21 + - supplierId: 51cbbfb0-8dc9-41aa-aad6-eb93b3cc40c6 + supplierName: Capital Cab Co + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 242 + details: + - name: Bills + amount: 242 + - supplierId: 3828f379-afa5-4b2a-9000-9c53d75ba1c6 + supplierName: Central Copiers + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 1063.56 + details: + - name: Bills + amount: 1063.56 + - supplierId: 8a593982-291c-4ec3-9a42-3dbccbc6e3c8 + supplierName: MCO Cleaning Services + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 119.08 + details: + - name: Bills + amount: 119.08 + - supplierId: 97cc88ca-f89b-41f0-b8b9-e750b6f2f1d9 + supplierName: Net Connect + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 54.13 + details: + - name: Bills + amount: 54.13 + - supplierId: dec56ceb-65e9-43b3-ac98-7fe09eb37e31 + supplierName: PowerDirect + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 244.45 + details: + - name: Bills + amount: 244.45 + - supplierId: f5a77e82-50e3-4340-a6e0-13d6a482a08a + supplierName: SMART Agency + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 4500 + details: + - name: Bills + amount: 4500 + - supplierId: 3a0d40a2-2698-4cf5-b7b2-30133c632ab6 + supplierName: Swanston Security + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 93.64 + details: + - name: Bills + amount: 93.64 + - supplierId: ac48c67d-3eea-44eb-96b1-9f7a89d9b761 + supplierName: Xero + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 56.35 + details: + - name: Bills + amount: 56.35 + - supplierId: 94a82e91-53da-4f87-a417-63d6a1607ced + supplierName: Young Bros Transport + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2023-04-02T00:00:00.0000000' + toDate: '2023-05-02T00:00:00.0000000' + amount: 0 + details: [] + - fromDate: '0001-01-01T00:00:00.0000000' + toDate: '2023-04-02T00:00:00.0000000' + amount: 125.03 + details: + - name: Bills + amount: 125.03 + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/financials/balanceSheet': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Financial statements + summary: Get balance sheet + description: Gets the latest balance sheet for a company. + operationId: get-accounting-balance-sheet + x-speakeasy-group: financial-statements.balance-sheet + parameters: + - $ref: '#/components/parameters/accountingPeriodLength' + - $ref: '#/components/parameters/accountingPeriodsToCompare' + - $ref: '#/components/parameters/accountingStartMonth' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBalanceSheet' + examples: + Clear Books: + value: + currency: GBP + reports: + - date: '2023-03-31T00:00:00' + assets: + accountId: '' + name: Assets + value: 4643976.27 + items: + - accountId: '' + name: Fixed Assets + value: 3930291.27 + items: + - accountId: 724ca578-8b5d-4bdb-ad45-e3820eee9de9 + name: Office Equipment + value: 2354838.89 + items: [] + - accountId: be3eb911-034b-42de-95db-0d58ac978b7f + name: Computer Equipment + value: 1575452.38 + items: [] + - accountId: '' + name: Current Assets + value: 713685 + items: + - accountId: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + name: Accounts Receivable + value: 66538.63 + items: [] + - accountId: 22de1660-d745-4809-a363-16b134607e66 + name: Prepayments + value: 27250.93 + items: [] + - accountId: e5d7612c-1671-47b4-b733-5db48363fcd0 + name: Inventory + value: 113157.44 + items: [] + - accountId: '' + name: Bank + value: 506738 + items: + - accountId: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + value: 506738 + items: [] + liabilities: + accountId: '' + name: Liabilities + value: 1183797.31 + items: + - accountId: '' + name: Current Liabilities + value: 544797.71 + items: + - accountId: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + name: VAT + value: 27683.3 + items: [] + - accountId: d19852a2-e292-4eb9-a909-9dadb95c0e76 + name: Rounding + value: 0 + items: [] + - accountId: 9be6382f-6b33-402d-b448-0db1dbf67a98 + name: Historical Adjustment + value: 8985.44 + items: [] + - accountId: 53bf27a7-7497-4c61-9887-dfaad5c6d80a + name: Accounts Payable + value: 36981.83 + items: [] + - accountId: 8852a857-aa9d-4706-839f-638e9d6b5a66 + name: Unpaid Expense Claims + value: 0 + items: [] + - accountId: 3b58f7ff-fa16-453a-9931-f020816d76e7 + name: Interest Payables + value: 1193.59 + items: [] + - accountId: 8636effc-50fb-45ba-8b2b-18336fa29b6b + name: John Smith + value: 1147.11 + items: [] + - accountId: e2530acd-91c8-48f8-a35f-935dbd7432e2 + name: Accruals + value: 439935.82 + items: [] + - accountId: 62060aae-e5a6-4db5-a3bb-6abec6d47959 + name: Credit Card Control Account + value: 28870.62 + items: [] + - accountId: '' + name: Long Term Liability + value: 638999.6 + items: + - accountId: 55008233-40e7-41ac-84af-2255fa028c2e + name: Loan + value: 638999.6 + items: [] + netAssets: 3460178.96 + equity: + accountId: '' + name: Equity + value: 3460178.96 + items: + - accountId: 39225d6f-3722-4508-ac3f-a2f6ec96ad31 + name: Retained Earnings + value: 3405201.39 + items: [] + - accountId: 78828dd9-6008-4662-b43c-e9d87907fd2b + name: Current Year Earnings + value: 54977.57 + items: [] + - date: '2023-02-28T00:00:00' + assets: + accountId: '' + name: Assets + value: 4599890.71 + items: + - accountId: '' + name: Fixed Assets + value: 3882793.51 + items: + - accountId: 724ca578-8b5d-4bdb-ad45-e3820eee9de9 + name: Office Equipment + value: 2036803.36 + items: [] + - accountId: be3eb911-034b-42de-95db-0d58ac978b7f + name: Computer Equipment + value: 1845990.15 + items: [] + - accountId: '' + name: Current Assets + value: 717097.2 + items: + - accountId: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + name: Accounts Receivable + value: 136245.44 + items: [] + - accountId: 22de1660-d745-4809-a363-16b134607e66 + name: Prepayments + value: 18719.25 + items: [] + - accountId: e5d7612c-1671-47b4-b733-5db48363fcd0 + name: Inventory + value: 146898.62 + items: [] + - accountId: '' + name: Bank + value: 415233.89 + items: + - accountId: dbcaf288-2b39-4b95-8ab3-42202ab15918 + name: Business Current Account + value: 415233.89 + items: [] + liabilities: + accountId: '' + name: Liabilities + value: 1150262.51 + items: + - accountId: '' + name: Current Liabilities + value: 508579.57 + items: + - accountId: 3a872b81-d1af-4d31-9bfa-a37280b8f68c + name: VAT + value: 22517.83 + items: [] + - accountId: d19852a2-e292-4eb9-a909-9dadb95c0e76 + name: Rounding + value: 0 + items: [] + - accountId: 9be6382f-6b33-402d-b448-0db1dbf67a98 + name: Historical Adjustment + value: 5994.86 + items: [] + - accountId: 53bf27a7-7497-4c61-9887-dfaad5c6d80a + name: Accounts Payable + value: 49993.06 + items: [] + - accountId: 8852a857-aa9d-4706-839f-638e9d6b5a66 + name: Unpaid Expense Claims + value: 0 + items: [] + - accountId: 3b58f7ff-fa16-453a-9931-f020816d76e7 + name: Interest Payables + value: 1424.88 + items: [] + - accountId: 8636effc-50fb-45ba-8b2b-18336fa29b6b + name: John Smith + value: 1863.01 + items: [] + - accountId: e2530acd-91c8-48f8-a35f-935dbd7432e2 + name: Accruals + value: 399839.88 + items: [] + - accountId: 62060aae-e5a6-4db5-a3bb-6abec6d47959 + name: Credit Card Control Account + value: 26946.05 + items: [] + - accountId: '' + name: Long Term Liability + value: 641682.94 + items: + - accountId: 55008233-40e7-41ac-84af-2255fa028c2e + name: Loan + value: 641682.94 + items: [] + netAssets: 3449628.2 + equity: + accountId: '' + name: Equity + value: 3449628.19 + items: + - accountId: 39225d6f-3722-4508-ac3f-a2f6ec96ad31 + name: Retained Earnings + value: 3405201.39 + items: [] + - accountId: 78828dd9-6008-4662-b43c-e9d87907fd2b + name: Current Year Earnings + value: 44426.8 + items: [] + mostRecentAvailableMonth: '2023-03-31T00:00:00' + earliestAvailableMonth: '2018-04-01T00:00:00' + Dynamics 365 Business Central: + value: + currency: GBP + reports: + - date: '2023-03-27T00:00:00' + assets: + name: Assets + value: 260454.26 + items: + - name: '' + value: 27.34 + items: + - accountId: c0861a65-c69f-ec11-80f1-0022481b4546 + name: 10 - Account no cat Balance Sheet + value: 27.34 + items: [] + - accountId: 9cc90e3e-843d-ed11-97e8-0022481b89f2 + name: 12345 - Income Statement and Asset + value: 0 + items: [] + - name: Equipment + value: 5504.37 + items: + - accountId: 5b9782f7-0fe7-ec11-82f9-0022481afc56 + name: 1350 - Iana test + value: 16 + items: [] + - accountId: 6c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40800 - Equipment + value: 5488.37 + items: [] + - name: Cash + value: 36998.49 + items: + - accountId: 5e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40100 - Checking account + value: -35824.11 + items: [] + - accountId: 601217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40200 - Savings account + value: 2802.59 + items: [] + - accountId: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40300 - Petty Cash + value: 70020.01 + items: [] + - accountId: 5c062318-3c59-ed11-8c36-002248c5e6c0 + name: 4544 - cash bal + value: 0 + items: [] + - name: Accounts Receivable + value: 189399.22 + items: + - accountId: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40400 - Accounts Receivable + value: 129008.09 + items: [] + - accountId: 9cb05c6f-9fbd-ed11-9a88-000d3a7ea13c + name: 40450 - test3 + value: 0 + items: [] + - accountId: 7a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46200 - Purchase VAT 20 % EU + value: -11635.12 + items: [] + - accountId: 7c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46210 - Purchase VAT 5 % EU + value: 0 + items: [] + - accountId: 7e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46300 - Purchase VAT 20 % + value: 71992.44 + items: [] + - accountId: 801217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46310 - Purchase VAT 5 % + value: 9.35 + items: [] + - accountId: 821217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46320 - Purchase Full VAT 5 % + value: 10 + items: [] + - accountId: 841217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46330 - Purchase Full VAT 20 % + value: 14.46 + items: [] + - accountId: 1bd1222e-94bd-ed11-9a88-6045bd0f961f + name: 9999 - BaleSales + value: 0 + items: [] + - name: Prepaid Expenses + value: -1040 + items: + - accountId: 661217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40500 - Prepaid Rent + value: 0 + items: [] + - accountId: 681217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40600 - Prepaid Insurance + value: -1040 + items: [] + - accountId: 781217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 41000 - Vendor Prepayments + value: 0 + items: [] + - name: Inventory + value: 26065.84 + items: + - accountId: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40700 - Inventory + value: 26065.84 + items: [] + - name: Accumulated Depreciation + value: 3499 + items: + - accountId: 6e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40900 - Accumulated Depreciation + value: 3499 + items: [] + - name: Assets + value: 0 + items: + - accountId: 701217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40910 - WIP Job Sales + value: 0 + items: [] + - accountId: 721217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40920 - Invoiced Job Sales + value: 0 + items: [] + - accountId: 741217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40940 - Accrued Job Costs + value: 0 + items: [] + - accountId: 761217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40950 - WIP Job Costs + value: 0 + items: [] + liabilities: + name: Liabilities + value: 99721.85 + items: + - name: Current Liabilities + value: 99735.85 + items: + - accountId: 8a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50100 - Accounts Payable + value: 42435.31 + items: [] + - accountId: 8c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50200 - Purchase Discounts + value: 210.22 + items: [] + - accountId: 8e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50300 - Purchase Returns & Allowances + value: 0 + items: [] + - accountId: 901217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50400 - Deferred Revenue + value: 0 + items: [] + - accountId: 921217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50500 - Credit Cards + value: 0 + items: [] + - accountId: 9e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 52000 - Customer Prepayments + value: 0 + items: [] + - accountId: a01217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56100 - Sales VAT 20 % + value: 57906.98 + items: [] + - accountId: a21217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56110 - Sales VAT 5 % + value: -816.66 + items: [] + - accountId: a41217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56120 - Sales Full VAT 5 % + value: 0 + items: [] + - accountId: a61217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56130 - Sales Full VAT 20 % + value: 0 + items: [] + - accountId: a81217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56140 - VAT Payable + value: 0 + items: [] + - name: Payroll Liabilities + value: -14 + items: + - accountId: 941217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50700 - Accrued Salaries & Wages + value: 0 + items: [] + - accountId: 961217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51400 - Employee Benefits Payable + value: 0 + items: [] + - accountId: 981217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51500 - Holiday Compensation Payable + value: 7 + items: [] + - accountId: 9a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51600 - Employees Payable + value: -21 + items: [] + - name: Long Term Liabilities + value: 0 + items: + - accountId: 9c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51900 - Notes Payable + value: 0 + items: [] + netAssets: 160732.41 + equity: + name: Equity + value: 160732.41 + items: + - name: Common Stock + value: 19988.72 + items: + - accountId: aa1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60100 - Share Capital + value: 19988.72 + items: [] + - name: Retained Earnings + value: 69723.14 + items: + - accountId: ac1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60200 - Retained Earnings + value: 69723.14 + items: [] + - name: Dividends + value: 0 + items: + - accountId: b01217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60300 - Dividends + value: 0 + items: [] + - accountId: NO-ID-EARNINGS-SO-FAR + name: Earnings so far + value: 71020.55 + items: [] + - date: '2023-02-28T00:00:00' + assets: + name: Assets + value: 262531.32 + items: + - name: '' + value: 27.34 + items: + - accountId: c0861a65-c69f-ec11-80f1-0022481b4546 + name: 10 - Account no cat Balance Sheet + value: 27.34 + items: [] + - accountId: 9cc90e3e-843d-ed11-97e8-0022481b89f2 + name: 12345 - Income Statement and Asset + value: 0 + items: [] + - name: Equipment + value: 5504.37 + items: + - accountId: 5b9782f7-0fe7-ec11-82f9-0022481afc56 + name: 1350 - Iana test + value: 16 + items: [] + - accountId: 6c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40800 - Equipment + value: 5488.37 + items: [] + - name: Cash + value: 37693.84 + items: + - accountId: 5e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40100 - Checking account + value: -35778.16 + items: [] + - accountId: 601217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40200 - Savings account + value: 2802.59 + items: [] + - accountId: 621217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40300 - Petty Cash + value: 70669.41 + items: [] + - accountId: 5c062318-3c59-ed11-8c36-002248c5e6c0 + name: 4544 - cash bal + value: 0 + items: [] + - name: Accounts Receivable + value: 188021.29 + items: + - accountId: 641217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40400 - Accounts Receivable + value: 127634.34 + items: [] + - accountId: 9cb05c6f-9fbd-ed11-9a88-000d3a7ea13c + name: 40450 - test3 + value: 0 + items: [] + - accountId: 7a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46200 - Purchase VAT 20 % EU + value: -11635.12 + items: [] + - accountId: 7c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46210 - Purchase VAT 5 % EU + value: 0 + items: [] + - accountId: 7e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46300 - Purchase VAT 20 % + value: 71988.26 + items: [] + - accountId: 801217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46310 - Purchase VAT 5 % + value: 9.35 + items: [] + - accountId: 821217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46320 - Purchase Full VAT 5 % + value: 10 + items: [] + - accountId: 841217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 46330 - Purchase Full VAT 20 % + value: 14.46 + items: [] + - accountId: 1bd1222e-94bd-ed11-9a88-6045bd0f961f + name: 9999 - BaleSales + value: 0 + items: [] + - name: Prepaid Expenses + value: -1040 + items: + - accountId: 661217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40500 - Prepaid Rent + value: 0 + items: [] + - accountId: 681217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40600 - Prepaid Insurance + value: -1040 + items: [] + - accountId: 781217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 41000 - Vendor Prepayments + value: 0 + items: [] + - name: Inventory + value: 28825.48 + items: + - accountId: 6a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40700 - Inventory + value: 28825.48 + items: [] + - name: Accumulated Depreciation + value: 3499 + items: + - accountId: 6e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40900 - Accumulated Depreciation + value: 3499 + items: [] + - name: Assets + value: 0 + items: + - accountId: 701217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40910 - WIP Job Sales + value: 0 + items: [] + - accountId: 721217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40920 - Invoiced Job Sales + value: 0 + items: [] + - accountId: 741217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40940 - Accrued Job Costs + value: 0 + items: [] + - accountId: 761217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 40950 - WIP Job Costs + value: 0 + items: [] + liabilities: + name: Liabilities + value: 99680 + items: + - name: Current Liabilities + value: 99694 + items: + - accountId: 8a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50100 - Accounts Payable + value: 42459.31 + items: [] + - accountId: 8c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50200 - Purchase Discounts + value: 210.22 + items: [] + - accountId: 8e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50300 - Purchase Returns & Allowances + value: 0 + items: [] + - accountId: 901217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50400 - Deferred Revenue + value: 0 + items: [] + - accountId: 921217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50500 - Credit Cards + value: 0 + items: [] + - accountId: 9e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 52000 - Customer Prepayments + value: 0 + items: [] + - accountId: a01217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56100 - Sales VAT 20 % + value: 57841.13 + items: [] + - accountId: a21217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56110 - Sales VAT 5 % + value: -816.66 + items: [] + - accountId: a41217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56120 - Sales Full VAT 5 % + value: 0 + items: [] + - accountId: a61217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56130 - Sales Full VAT 20 % + value: 0 + items: [] + - accountId: a81217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 56140 - VAT Payable + value: 0 + items: [] + - name: Payroll Liabilities + value: -14 + items: + - accountId: 941217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 50700 - Accrued Salaries & Wages + value: 0 + items: [] + - accountId: 961217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51400 - Employee Benefits Payable + value: 0 + items: [] + - accountId: 981217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51500 - Holiday Compensation Payable + value: 7 + items: [] + - accountId: 9a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51600 - Employees Payable + value: -21 + items: [] + - name: Long Term Liabilities + value: 0 + items: + - accountId: 9c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 51900 - Notes Payable + value: 0 + items: [] + netAssets: 162851.32 + equity: + name: Equity + value: 162851.32 + items: + - name: Common Stock + value: 19988.72 + items: + - accountId: aa1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60100 - Share Capital + value: 19988.72 + items: [] + - name: Retained Earnings + value: 69723.14 + items: + - accountId: ac1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60200 - Retained Earnings + value: 69723.14 + items: [] + - name: Dividends + value: 0 + items: + - accountId: b01217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 60300 - Dividends + value: 0 + items: [] + - accountId: NO-ID-EARNINGS-SO-FAR + name: Earnings so far + value: 73139.46 + items: [] + mostRecentAvailableMonth: '2023-03-31T00:00:00' + earliestAvailableMonth: '2022-09-01T00:00:00' + Exact (Netherlands): + value: + reports: [] + Exact (UK): + value: + currency: GBP + reports: + - date: '2022-10-31T00:00:00Z' + assets: + name: Assets + value: -2 + items: + - accountId: cf9572e7-8afa-4339-9113-af32a66d9df9 + name: 15400 - Trade Debtors + value: -3 + items: [] + - accountId: ba382d88-a4e5-4117-8fc6-4752ee8bc93d + name: 15801 - Standard account + value: 1 + items: [] + liabilities: + name: Liabilities + value: 0 + items: [] + netAssets: -2 + equity: + name: Equities + value: -2 + items: + - accountId: PROFIT-AND-LOSS + name: Profit for this period + value: -2 + items: [] + - date: '2022-09-30T00:00:00Z' + assets: + name: Assets + value: 208 + items: + - accountId: 885ff551-664d-451b-995b-cb114c9877d0 + name: 15890 - Unallocated Cash + value: 0 + items: [] + - accountId: cf9572e7-8afa-4339-9113-af32a66d9df9 + name: 15400 - Trade Debtors + value: 78 + items: [] + - accountId: 4a4e34b5-7f62-4b64-a44a-073398b14b41 + name: 15880 - Bank + value: 130 + items: [] + liabilities: + name: Liabilities + value: 0 + items: + - accountId: 88d733a8-51e1-4ee7-b2a0-fb49879e36cc + name: 21000 - Trade Creditors + value: 0 + items: [] + netAssets: 208 + equity: + name: Equities + value: 208 + items: + - accountId: PROFIT-AND-LOSS + name: Profit for this period + value: 208 + items: [] + mostRecentAvailableMonth: '2022-10-31T00:00:00' + earliestAvailableMonth: '2022-04-01T00:00:00' + FreshBooks: + value: + currency: GBP + reports: + - date: '2023-04-30T00:00:00' + assets: + name: assets + value: 38416.28 + items: + - accountId: '167679' + name: Cash + value: -3011.5 + items: + - accountId: '291721' + name: Petty Cash + value: -3022.5 + items: [] + - accountId: '3427097' + name: Cash + value: 11 + items: [] + - accountId: '67357' + name: Accounts Receivable + value: 41445.53 + items: + - accountId: '128611' + name: Accounts Receivable + value: 41445.53 + items: [] + - accountId: '2761661' + name: Current Asset + value: -11 + items: + - accountId: '3420060' + name: Prepaid Expenses + value: -11 + items: [] + - accountId: '2288207' + name: 'Property, Plant, and Equipment' + value: -6.75 + items: + - accountId: '2792069' + name: Office Equipment + value: -6.75 + items: [] + liabilities: + name: liabilities + value: 9310.72 + items: + - accountId: '2288209' + name: Accounts Payable + value: 460.39 + items: + - accountId: '3385145' + name: Accounts Payable + value: 460.39 + items: [] + - accountId: '67361' + name: Taxes Payable + value: 36.75 + items: + - accountId: '128615' + name: VAT + value: -108.9 + items: [] + - accountId: '3380553' + name: Customs Duty + value: -2.5 + items: [] + - accountId: '3380555' + name: Excise Duty + value: -54.45 + items: [] + - accountId: '3384241' + name: tax 50 + value: 0.7 + items: [] + - accountId: '3384293' + name: helloabdul + value: 86.03 + items: [] + - accountId: '3384425' + name: hello2 + value: 114.76 + items: [] + - accountId: '3420099' + name: VAT1 + value: 1.11 + items: [] + - accountId: '237025' + name: Customer Credit + value: 8813.58 + items: + - accountId: '392937' + name: Customer Credit + value: 8813.58 + items: [] + netAssets: 29105.56 + equity: + name: equity + value: 29105.56 + items: + - accountId: '' + name: Net Income + value: 29105.56 + items: [] + - date: '2023-03-31T00:00:00' + assets: + name: assets + value: 38416.28 + items: + - accountId: '167679' + name: Cash + value: -3011.5 + items: + - accountId: '291721' + name: Petty Cash + value: -3022.5 + items: [] + - accountId: '3427097' + name: Cash + value: 11 + items: [] + - accountId: '67357' + name: Accounts Receivable + value: 41445.53 + items: + - accountId: '128611' + name: Accounts Receivable + value: 41445.53 + items: [] + - accountId: '2761661' + name: Current Asset + value: -11 + items: + - accountId: '3420060' + name: Prepaid Expenses + value: -11 + items: [] + - accountId: '2288207' + name: 'Property, Plant, and Equipment' + value: -6.75 + items: + - accountId: '2792069' + name: Office Equipment + value: -6.75 + items: [] + liabilities: + name: liabilities + value: 9310.72 + items: + - accountId: '2288209' + name: Accounts Payable + value: 460.39 + items: + - accountId: '3385145' + name: Accounts Payable + value: 460.39 + items: [] + - accountId: '67361' + name: Taxes Payable + value: 36.75 + items: + - accountId: '128615' + name: VAT + value: -108.9 + items: [] + - accountId: '3380553' + name: Customs Duty + value: -2.5 + items: [] + - accountId: '3380555' + name: Excise Duty + value: -54.45 + items: [] + - accountId: '3384241' + name: tax 50 + value: 0.7 + items: [] + - accountId: '3384293' + name: helloabdul + value: 86.03 + items: [] + - accountId: '3384425' + name: hello2 + value: 114.76 + items: [] + - accountId: '3420099' + name: VAT1 + value: 1.11 + items: [] + - accountId: '237025' + name: Customer Credit + value: 8813.58 + items: + - accountId: '392937' + name: Customer Credit + value: 8813.58 + items: [] + netAssets: 29105.56 + equity: + name: equity + value: 29105.56 + items: + - accountId: '' + name: Net Income + value: 29105.56 + items: [] + mostRecentAvailableMonth: '2023-04-30T00:00:00' + earliestAvailableMonth: '2022-10-01T00:00:00' + KashFlow: + value: + currency: GBP + reports: + - date: '2022-09-30T00:00:00' + assets: + name: Assets + value: 109979.14 + items: + - name: Fixed Assets + value: 923.62 + items: + - accountId: '29362903' + name: FIXED ASSET CODE (SALES) + value: -100 + items: [] + - accountId: '29362906' + name: FIXED ASSET CODE (OUTGOING) + value: 1006 + items: [] + - accountId: '29358753' + name: TESTCODE + value: 9.29 + items: [] + - accountId: '21481884' + name: Computer equipment cost + value: 8.33 + items: [] + - name: Current Assets + value: 109055.52 + items: + - accountId: '21481886' + name: Trade debtors + value: 67166.51 + items: [] + - accountId: '636062' + name: Current account + value: 425.33 + items: [] + - accountId: '680495' + name: Test Account + value: 38003 + items: [] + - accountId: '684416' + name: Tide Account 2 + value: 303.22 + items: [] + - accountId: '684418' + name: New Tide Account + value: 303.22 + items: [] + - accountId: '686687' + name: Pete Test 02/05 + value: 301.64 + items: [] + - accountId: '696204' + name: Go Live + value: 9 + items: [] + - accountId: '696740' + name: Production Test + value: 0.08 + items: [] + - accountId: '707236' + name: Dave Push Test uat + value: 123.41 + items: [] + - accountId: '707240' + name: Dave Push Test integ + value: 139.54 + items: [] + - accountId: '813944' + name: Please dont balance + value: 110 + items: [] + - accountId: '765768' + name: 16th Account + value: 326 + items: [] + - accountId: '809283' + name: abduls company credit card + value: 13.85 + items: [] + - accountId: '809318' + name: ASSET ACCOUNT + value: 110 + items: [] + - accountId: '776582' + name: VandanaKasAcc1 + value: 20 + items: [] + - accountId: '780580' + name: ABRAHAM2 + value: 40 + items: [] + - accountId: '780605' + name: AbeVanTest3 + value: 10 + items: [] + - accountId: '780619' + name: VandanaAccTest4 + value: 92.63 + items: [] + - accountId: '780669' + name: NewXeroAccount10 + value: 21 + items: [] + - accountId: '780672' + name: NewKasAccount10 + value: 111 + items: [] + - accountId: '809742' + name: HSBBBBB + value: 111 + items: [] + - accountId: '833089' + name: AAAAA + value: 260 + items: [] + - accountId: '21481890' + name: Output VAT + value: 511.04 + items: [] + - accountId: '21481891' + name: Input VAT + value: 504.05 + items: [] + - accountId: '21481895' + name: CIS deductions + value: 40 + items: [] + liabilities: + name: Liabilities + value: 80187.1 + items: + - name: Current Liabilities + value: 80187.1 + items: + - accountId: '21481902' + name: Other + value: 43799.56 + items: [] + - accountId: '21481888' + name: Cash in hand + value: 317.07 + items: [] + - accountId: '612964' + name: Bank account + value: 33011.08 + items: [] + - accountId: '687106' + name: May 4th Account + value: 926.81 + items: [] + - accountId: '21481892' + name: VAT control account + value: 322 + items: [] + - accountId: '21481893' + name: Trade creditors + value: 1618.27 + items: [] + - accountId: '29553868' + name: Creditors Control Account + value: 192.31 + items: [] + netAssets: 29792.04 + equity: + name: Equity + value: 29792.05 + items: + - name: Capital and Reserves + value: 29792.05 + items: + - accountId: '21481901' + name: Retained profit/loss + value: 31402.01 + items: [] + - accountId: '0' + name: P&L Account + value: -1609.96 + items: [] + - date: '2022-08-31T00:00:00' + assets: + name: Assets + value: 109979.14 + items: + - name: Fixed Assets + value: 923.62 + items: + - accountId: '29362903' + name: FIXED ASSET CODE (SALES) + value: -100 + items: [] + - accountId: '29362906' + name: FIXED ASSET CODE (OUTGOING) + value: 1006 + items: [] + - accountId: '29358753' + name: TESTCODE + value: 9.29 + items: [] + - accountId: '21481884' + name: Computer equipment cost + value: 8.33 + items: [] + - name: Current Assets + value: 109055.52 + items: + - accountId: '21481886' + name: Trade debtors + value: 67166.51 + items: [] + - accountId: '636062' + name: Current account + value: 425.33 + items: [] + - accountId: '680495' + name: Test Account + value: 38003 + items: [] + - accountId: '684416' + name: Tide Account 2 + value: 303.22 + items: [] + - accountId: '684418' + name: New Tide Account + value: 303.22 + items: [] + - accountId: '686687' + name: Pete Test 02/05 + value: 301.64 + items: [] + - accountId: '696204' + name: Go Live + value: 9 + items: [] + - accountId: '696740' + name: Production Test + value: 0.08 + items: [] + - accountId: '707236' + name: Dave Push Test uat + value: 123.41 + items: [] + - accountId: '707240' + name: Dave Push Test integ + value: 139.54 + items: [] + - accountId: '813944' + name: Please dont balance + value: 110 + items: [] + - accountId: '765768' + name: 16th Account + value: 326 + items: [] + - accountId: '809283' + name: abduls company credit card + value: 13.85 + items: [] + - accountId: '809318' + name: ASSET ACCOUNT + value: 110 + items: [] + - accountId: '776582' + name: VandanaKasAcc1 + value: 20 + items: [] + - accountId: '780580' + name: ABRAHAM2 + value: 40 + items: [] + - accountId: '780605' + name: AbeVanTest3 + value: 10 + items: [] + - accountId: '780619' + name: VandanaAccTest4 + value: 92.63 + items: [] + - accountId: '780669' + name: NewXeroAccount10 + value: 21 + items: [] + - accountId: '780672' + name: NewKasAccount10 + value: 111 + items: [] + - accountId: '809742' + name: HSBBBBB + value: 111 + items: [] + - accountId: '833089' + name: AAAAA + value: 260 + items: [] + - accountId: '21481890' + name: Output VAT + value: 511.04 + items: [] + - accountId: '21481891' + name: Input VAT + value: 504.05 + items: [] + - accountId: '21481895' + name: CIS deductions + value: 40 + items: [] + liabilities: + name: Liabilities + value: 80187.1 + items: + - name: Current Liabilities + value: 80187.1 + items: + - accountId: '21481902' + name: Other + value: 43799.56 + items: [] + - accountId: '21481888' + name: Cash in hand + value: 317.07 + items: [] + - accountId: '612964' + name: Bank account + value: 33011.08 + items: [] + - accountId: '687106' + name: May 4th Account + value: 926.81 + items: [] + - accountId: '21481892' + name: VAT control account + value: 322 + items: [] + - accountId: '21481893' + name: Trade creditors + value: 1618.27 + items: [] + - accountId: '29553868' + name: Creditors Control Account + value: 192.31 + items: [] + netAssets: 29792.04 + equity: + name: Equity + value: 29792.05 + items: + - name: Capital and Reserves + value: 29792.05 + items: + - accountId: '21481901' + name: Retained profit/loss + value: 31402.01 + items: [] + - accountId: '0' + name: P&L Account + value: -1609.96 + items: [] + mostRecentAvailableMonth: '2022-09-30T00:00:00' + earliestAvailableMonth: '2022-03-01T00:00:00' + MYOB AccountRight and Essentials: + value: + currency: GBP + reports: + - date: '2022-11-30T00:00:00' + assets: + name: Assets + value: 0 + items: [] + liabilities: + name: Liabilities + value: 0 + items: [] + netAssets: 0 + equity: + name: Equity + value: 0 + items: [] + - date: '2022-10-31T00:00:00' + assets: + name: Assets + value: 0 + items: [] + liabilities: + name: Liabilities + value: 0 + items: [] + netAssets: 0 + equity: + name: Equity + value: 0 + items: [] + mostRecentAvailableMonth: '2022-11-30T00:00:00' + earliestAvailableMonth: '2022-05-01T00:00:00' + Oracle NetSuite: + value: + currency: GBP + reports: + - date: '2023-05-31T00:00:00' + assets: + accountId: '' + name: Assets + value: 703 + items: + - accountId: '119' + name: Accounts Receivable + value: -565 + items: [] + - accountId: '122' + name: Undeposited Funds + value: 10 + items: [] + - accountId: '211' + name: VAT on Purchases + value: 24 + items: [] + - accountId: '716' + name: Inventory In Transit + value: 120 + items: [] + - accountId: '825' + name: Codat Europe Bank + value: 558.22 + items: + - accountId: '825' + name: Codat Europe Bank + value: 558.22 + items: [] + - accountId: '844' + name: Asset account test 2 + value: 555.78 + items: + - accountId: '844' + name: Asset account test 2 + value: 555.78 + items: [] + liabilities: + accountId: '' + name: Liabilities + value: 635.55 + items: + - accountId: '111' + name: Accounts Payable + value: 635.55 + items: + - accountId: '111' + name: Accounts Payable + value: 635.55 + items: [] + netAssets: 67.45 + equity: + accountId: '' + name: Equity + value: 67.45 + items: + - accountId: '851' + name: Demo account equity + value: -11 + items: [] + - name: Net Income + value: 78.45 + items: [] + - date: '2023-04-30T00:00:00' + assets: + accountId: '' + name: Assets + value: 703 + items: + - accountId: '119' + name: Accounts Receivable + value: -565 + items: [] + - accountId: '122' + name: Undeposited Funds + value: 10 + items: [] + - accountId: '211' + name: VAT on Purchases + value: 24 + items: [] + - accountId: '716' + name: Inventory In Transit + value: 120 + items: [] + - accountId: '825' + name: Codat Europe Bank + value: 558.22 + items: + - accountId: '825' + name: Codat Europe Bank + value: 558.22 + items: [] + - accountId: '844' + name: Asset account test 2 + value: 555.78 + items: + - accountId: '844' + name: Asset account test 2 + value: 555.78 + items: [] + liabilities: + accountId: '' + name: Liabilities + value: 635.55 + items: + - accountId: '111' + name: Accounts Payable + value: 635.55 + items: + - accountId: '111' + name: Accounts Payable + value: 635.55 + items: [] + netAssets: 67.45 + equity: + accountId: '' + name: Equity + value: 67.45 + items: + - accountId: '851' + name: Demo account equity + value: -11 + items: [] + - name: Net Income + value: 78.45 + items: [] + mostRecentAvailableMonth: '2023-05-31T00:00:00' + earliestAvailableMonth: '2022-11-01T00:00:00' + QuickBooks Desktop: + value: + currency: GBP + reports: + - date: '2023-04-30T00:00:00' + assets: + name: ASSETS + value: 549695.86 + items: + - name: Current Assets + value: 81821.64 + items: + - name: Checking/Savings + value: 57007.53 + items: + - accountId: 20000-933270541 + name: 10100 � Checking + value: 40814.11 + items: [] + - accountId: 30000-933270541 + name: 10300 � Savings + value: 15693.42 + items: [] + - accountId: 550001-1071509830 + name: 10400 � Petty Cash + value: 500 + items: [] + - name: Accounts Receivable + value: 7719.99 + items: + - accountId: 40000-933270541 + name: 11000 � Accounts Receivable + value: 7719.99 + items: [] + - name: Other Current Assets + value: 17094.12 + items: + - accountId: 60000-933270541 + name: 12100 � Inventory Asset + value: 13177.4 + items: [] + - accountId: 50000-933270541 + name: 12800 � Employee Advances + value: 770 + items: [] + - accountId: 370001-1071514466 + name: 13100 � Pre-paid Insurance + value: 1350 + items: [] + - accountId: 70000-933270541 + name: 13400 � Retainage Receivable + value: 1796.72 + items: [] + - name: Fixed Assets + value: 466154.22 + items: + - accountId: 5F0000-1197755449 + name: 15000 � Furniture and Equipment + value: 22826 + items: [] + - accountId: 90000-933270541 + name: 15100 � Vehicles + value: 78936.91 + items: [] + - accountId: 600000-1197756365 + name: 15200 � Buildings and Improvements + value: 325000 + items: [] + - accountId: 590000-1071511920 + name: 15300 � Construction Equipment + value: 15300 + items: [] + - accountId: 610000-1197756496 + name: 16900 � Land + value: 90000 + items: [] + - accountId: 620000-1197756666 + name: 17000 � Accumulated Depreciation + value: -65908.69 + items: [] + - name: Other Assets + value: 1720 + items: + - accountId: 80000063-1197709076 + name: 18700 � Security Deposits + value: 1720 + items: [] + liabilities: + name: Liabilities + value: 451499.2 + items: + - name: Current Liabilities + value: 6718.02 + items: + - name: Accounts Payable + value: 5000 + items: + - accountId: C0000-933270541 + name: 20000 � Accounts Payable + value: 5000 + items: [] + - name: Credit Cards + value: 1400 + items: + - accountId: 570000-1071509253 + name: 20500 � QuickBooks Credit Card + value: 1400 + items: [] + - name: Other Current Liabilities + value: 318.02 + items: + - accountId: 100000-933270541 + name: 25500 � Sales Tax Payable + value: 318.02 + items: [] + - name: Long Term Liabilities + value: 444781.18 + items: + - accountId: 120000-933270541 + name: 23000 � Loan - Vehicles (Van) + value: 19932.64 + items: [] + - accountId: 80000075-1197719780 + name: 23100 � Loan - Vehicles (Utility Truck) + value: 19936.91 + items: [] + - accountId: 80000076-1197719828 + name: 23200 � Loan - Vehicles (Pickup Truck) + value: 22641 + items: [] + - accountId: 5B0000-1197774305 + name: 28100 � Loan - Construction Equipment + value: 14343.11 + items: [] + - accountId: 80000068-1197710590 + name: 28200 � Loan - Furniture/Office Equip + value: 21000 + items: [] + - accountId: 8000008F-1197954502 + name: 28700 � Note Payable - Bank of Anycity + value: 50644.52 + items: [] + - accountId: 80000067-1197709946 + name: 28900 � Mortgage - Office Building + value: 296283 + items: [] + netAssets: 98196.66 + equity: + name: Equity + value: 98196.66 + items: + - accountId: 10000-933270541 + name: 30000 � Opening Bal Equity + value: 38773.75 + items: [] + - accountId: 80000066-1197709715 + name: 30100 � Capital Stock + value: 500 + items: [] + - accountId: 160000-933270541 + name: 32000 � Retained Earnings + value: 36213.97 + items: [] + - name: Net Income + value: 22708.94 + items: [] + - date: '2023-03-31T00:00:00' + assets: + name: ASSETS + value: 547971.05 + items: + - name: Current Assets + value: 80096.83 + items: + - name: Checking/Savings + value: 45769.39 + items: + - accountId: 20000-933270541 + name: 10100 � Checking + value: 29575.97 + items: [] + - accountId: 30000-933270541 + name: 10300 � Savings + value: 15693.42 + items: [] + - accountId: 550001-1071509830 + name: 10400 � Petty Cash + value: 500 + items: [] + - name: Accounts Receivable + value: 16228.47 + items: + - accountId: 40000-933270541 + name: 11000 � Accounts Receivable + value: 16228.47 + items: [] + - name: Other Current Assets + value: 18098.97 + items: + - accountId: 60000-933270541 + name: 12100 � Inventory Asset + value: 13507.25 + items: [] + - accountId: 50000-933270541 + name: 12800 � Employee Advances + value: 770 + items: [] + - accountId: 370001-1071514466 + name: 13100 � Pre-paid Insurance + value: 2025 + items: [] + - accountId: 70000-933270541 + name: 13400 � Retainage Receivable + value: 1796.72 + items: [] + - name: Fixed Assets + value: 466154.22 + items: + - accountId: 5F0000-1197755449 + name: 15000 � Furniture and Equipment + value: 22826 + items: [] + - accountId: 90000-933270541 + name: 15100 � Vehicles + value: 78936.91 + items: [] + - accountId: 600000-1197756365 + name: 15200 � Buildings and Improvements + value: 325000 + items: [] + - accountId: 590000-1071511920 + name: 15300 � Construction Equipment + value: 15300 + items: [] + - accountId: 610000-1197756496 + name: 16900 � Land + value: 90000 + items: [] + - accountId: 620000-1197756666 + name: 17000 � Accumulated Depreciation + value: -65908.69 + items: [] + - name: Other Assets + value: 1720 + items: + - accountId: 80000063-1197709076 + name: 18700 � Security Deposits + value: 1720 + items: [] + liabilities: + name: Liabilities + value: 453300.75 + items: + - name: Current Liabilities + value: 5714 + items: + - name: Accounts Payable + value: 5714 + items: + - accountId: C0000-933270541 + name: 20000 � Accounts Payable + value: 5714 + items: [] + - name: Long Term Liabilities + value: 447586.75 + items: + - accountId: 120000-933270541 + name: 23000 � Loan - Vehicles (Van) + value: 20376.27 + items: [] + - accountId: 80000075-1197719780 + name: 23100 � Loan - Vehicles (Utility Truck) + value: 19936.91 + items: [] + - accountId: 80000076-1197719828 + name: 23200 � Loan - Vehicles (Pickup Truck) + value: 22641 + items: [] + - accountId: 5B0000-1197774305 + name: 28100 � Loan - Construction Equipment + value: 14343.11 + items: [] + - accountId: 80000068-1197710590 + name: 28200 � Loan - Furniture/Office Equip + value: 21000 + items: [] + - accountId: 8000008F-1197954502 + name: 28700 � Note Payable - Bank of Anycity + value: 53006.46 + items: [] + - accountId: 80000067-1197709946 + name: 28900 � Mortgage - Office Building + value: 296283 + items: [] + netAssets: 94670.3 + equity: + name: Equity + value: 94670.3 + items: + - accountId: 10000-933270541 + name: 30000 � Opening Bal Equity + value: 38773.75 + items: [] + - accountId: 80000066-1197709715 + name: 30100 � Capital Stock + value: 500 + items: [] + - accountId: 160000-933270541 + name: 32000 � Retained Earnings + value: 36213.97 + items: [] + - name: Net Income + value: 19182.58 + items: [] + mostRecentAvailableMonth: '2023-04-30T00:00:00' + earliestAvailableMonth: '2022-10-01T00:00:00' + QuickBooks Online Sandbox: + value: + currency: GBP + reports: + - date: '2023-04-30T00:00:00' + assets: + name: Assets + value: 3856584.88 + items: + - name: Fixed Asset + value: 2766.17 + items: + - accountId: '3' + name: Accumulated Depreciation + value: -399.96 + items: [] + - accountId: '5' + name: Furniture and Equipment + value: 2750 + items: [] + - accountId: '7' + name: Leasehold Improvements + value: -99.12 + items: [] + - accountId: '9' + name: Vehicles + value: 515.25 + items: [] + - name: Bank + value: 520021.91 + items: + - accountId: '114' + name: 0983741 SamplePushBankAccount2 + value: 40.5 + items: [] + - accountId: '175' + name: 1 Push-FrontDoor-Test-1 + value: 112 + items: [] + - accountId: '134' + name: 1001001 Revenue + value: -235.34 + items: [] + - accountId: '110' + name: 101 Push Refactor Test + value: -149.4 + items: [] + - accountId: '102' + name: 10101 IntegrationTest + value: -1444.14 + items: [] + - accountId: '103' + name: 101011 testdemo1 + value: 18.6 + items: [] + - accountId: '104' + name: 101012 Dave Test + value: -5.4 + items: [] + - accountId: '105' + name: 101013 Push Test + value: 5.4 + items: [] + - accountId: '107' + name: 11 aaa + value: 23610.49 + items: [] + - accountId: '115' + name: '1111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111' + value: -9000.81 + items: [] + - accountId: '100' + name: 1131 Savings2 + value: 30281.54 + items: [] + - accountId: '109' + name: 122 Generic Push Test + value: -1079.05 + items: [] + - accountId: '101' + name: 123 Test Savings + value: 2293.37 + items: [] + - accountId: '111' + name: 123123 Steve Test + value: -1104.2 + items: [] + - accountId: '124' + name: 123175 Nominal Card + value: -2013.04 + items: [] + - accountId: '137' + name: 1232 test 55 + value: 1.29 + items: [] + - accountId: '122' + name: 1234567 Card3million + value: -85 + items: [] + - accountId: '176' + name: 12345671 testName_1 + value: 17546.08 + items: [] + - accountId: '165' + name: 123564 Huws testing name + value: -2 + items: [] + - accountId: '159' + name: 1533465364 Huws test name + value: 282.21 + items: [] + - accountId: '161' + name: 160894 Tom Automated Tests ExpensesAccount + value: -15900.6 + items: [] + - accountId: '108' + name: 19191 New Push Operation Test + value: 317.54 + items: [] + - accountId: '139' + name: 2501 Barclays + value: 211127.4 + items: [] + - accountId: '140' + name: 2502 HSBC + value: 109500.4 + items: [] + - accountId: '141' + name: 2503 BoA + value: 128050.89 + items: [] + - accountId: '138' + name: 4234 test55 + value: -29.28 + items: [] + - accountId: '106' + name: aa aa + value: -5.4 + items: [] + - accountId: '129' + name: Account Test 11 + value: 33.93 + items: [] + - accountId: '147' + name: Bank EUR + value: 188.5 + items: [] + - accountId: '173' + name: Cash on hand + value: 2655 + items: [] + - accountId: '178' + name: Citi + value: 189.11 + items: [] + - accountId: '81' + name: Current + value: 24513.64 + items: [] + - accountId: '177' + name: HSBC HKD + value: -39.39 + items: [] + - accountId: '169' + name: Matt Ager Test UI Parent Account + value: 75 + items: [] + - accountId: '89' + name: TestBankAccount_1 + value: 272.07 + items: [] + - name: Accounts Receivable + value: 3074459.19 + items: + - accountId: '70' + name: Debtors + value: 3041138.07 + items: [] + - accountId: '80' + name: Debtors - USD + value: 33315.2 + items: [] + - accountId: '125' + name: Debtors 2 + value: -7.45 + items: [] + - accountId: '88' + name: TestBankAccount + value: 13.37 + items: [] + - name: Other Current Asset + value: 259337.61 + items: + - accountId: '98' + name: Account_001 + value: 545.86 + items: [] + - accountId: '185' + name: Loans To Officers + value: 1200 + items: [] + - accountId: '179' + name: Loans to Others + value: 58.2 + items: [] + - accountId: '171' + name: Matt Ager Test UI Parent Account 1 + value: 11 + items: [] + - accountId: '168' + name: Other current assets + value: 10 + items: [] + - accountId: '65' + name: Stock Asset + value: 36524 + items: [] + - accountId: '150' + name: stock test + value: 10 + items: [] + - accountId: '77' + name: Uncategorised Asset + value: 47.8 + items: [] + - accountId: '85' + name: Undeposited Funds + value: 220930.75 + items: [] + liabilities: + name: Liabilities + value: 169469.71 + items: + - name: Accounts Payable + value: 93748.74 + items: + - accountId: '71' + name: Creditors + value: 93635.4 + items: [] + - accountId: '74' + name: Creditors - HKD + value: 113.34 + items: [] + - name: Credit Card + value: 10841.34 + items: + - accountId: '142' + name: 2504 Amex - CC + value: 9957.72 + items: [] + - accountId: '126' + name: Credit Card 2 + value: -71.91 + items: [] + - accountId: '183' + name: Expense Automated Tests Credit Card + value: -2469.91 + items: [] + - accountId: '57' + name: Visa Credit Card + value: 3425.44 + items: [] + - name: Other Current Liability + value: 10001.33 + items: + - accountId: '118' + name: Current Liabilities + value: 82.12 + items: [] + - accountId: '157' + name: Loan Payable - Kay's Bank + value: 12726 + items: [] + - accountId: '187' + name: Payroll Clearing + value: -3458.3 + items: [] + - accountId: '53' + name: VAT Control + value: -4738.49 + items: [] + - accountId: '54' + name: VAT Suspense + value: 5390 + items: [] + - name: Long Term Liability + value: 54878.3 + items: + - accountId: '158' + name: Loan Long term borrowings - Jay's Bank + value: 35630 + items: [] + - accountId: '84' + name: Long term borrowings + value: -1100 + items: [] + - accountId: '63' + name: Note Payable + value: 19348.3 + items: [] + - accountId: '86' + name: Accruals and deferred income + value: 1000 + items: [] + netAssets: 3687115.17 + equity: + name: Equity + value: 3687115.17 + items: + - name: Equity + value: 3697585.43 + items: + - accountId: '55' + name: Opening Balance Equity + value: 966720.56 + items: [] + - accountId: '2' + name: Retained Earnings + value: 2706364.87 + items: [] + - accountId: '61' + name: Owner's Equity - Contributions + value: 25500 + items: [] + - accountId: '62' + name: Owner's Equity - Draws + value: -1000 + items: [] + - name: Profit for the year + value: -10470.26 + items: [] + - date: '2023-03-31T00:00:00' + assets: + name: Assets + value: 4385453.25 + items: + - name: Fixed Asset + value: 2766.17 + items: + - accountId: '3' + name: Accumulated Depreciation + value: -399.96 + items: [] + - accountId: '5' + name: Furniture and Equipment + value: 2750 + items: [] + - accountId: '7' + name: Leasehold Improvements + value: -99.12 + items: [] + - accountId: '9' + name: Vehicles + value: 515.25 + items: [] + - name: Bank + value: 1048102.14 + items: + - accountId: '114' + name: 0983741 SamplePushBankAccount2 + value: 40.5 + items: [] + - accountId: '175' + name: 1 Push-FrontDoor-Test-1 + value: 112 + items: [] + - accountId: '134' + name: 1001001 Revenue + value: -235.34 + items: [] + - accountId: '110' + name: 101 Push Refactor Test + value: -149.4 + items: [] + - accountId: '102' + name: 10101 IntegrationTest + value: -1444.14 + items: [] + - accountId: '103' + name: 101011 testdemo1 + value: 18.6 + items: [] + - accountId: '104' + name: 101012 Dave Test + value: -5.4 + items: [] + - accountId: '105' + name: 101013 Push Test + value: 5.4 + items: [] + - accountId: '107' + name: 11 aaa + value: 23610.49 + items: [] + - accountId: '115' + name: '1111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111111' + value: -9000.81 + items: [] + - accountId: '100' + name: 1131 Savings2 + value: 30281.54 + items: [] + - accountId: '109' + name: 122 Generic Push Test + value: -1079.05 + items: [] + - accountId: '101' + name: 123 Test Savings + value: 2293.37 + items: [] + - accountId: '111' + name: 123123 Steve Test + value: -1104.2 + items: [] + - accountId: '124' + name: 123175 Nominal Card + value: -2013.04 + items: [] + - accountId: '137' + name: 1232 test 55 + value: 1.29 + items: [] + - accountId: '122' + name: 1234567 Card3million + value: -85 + items: [] + - accountId: '176' + name: 12345671 testName_1 + value: 14029.28 + items: [] + - accountId: '165' + name: 123564 Huws testing name + value: -2 + items: [] + - accountId: '159' + name: 1533465364 Huws test name + value: 282.21 + items: [] + - accountId: '161' + name: 160894 Tom Automated Tests ExpensesAccount + value: -11410.5 + items: [] + - accountId: '108' + name: 19191 New Push Operation Test + value: 317.54 + items: [] + - accountId: '139' + name: 2501 Barclays + value: 741293.8 + items: [] + - accountId: '140' + name: 2502 HSBC + value: 109155.93 + items: [] + - accountId: '141' + name: 2503 BoA + value: 128055.89 + items: [] + - accountId: '138' + name: 4234 test55 + value: -14.28 + items: [] + - accountId: '106' + name: aa aa + value: -5.4 + items: [] + - accountId: '129' + name: Account Test 11 + value: 33.93 + items: [] + - accountId: '147' + name: Bank EUR + value: 188.5 + items: [] + - accountId: '173' + name: Cash on hand + value: -5 + items: [] + - accountId: '178' + name: Citi + value: 189.11 + items: [] + - accountId: '81' + name: Current + value: 24438.64 + items: [] + - accountId: '177' + name: HSBC HKD + value: -39.39 + items: [] + - accountId: '169' + name: Matt Ager Test UI Parent Account + value: 75 + items: [] + - accountId: '89' + name: TestBankAccount_1 + value: 272.07 + items: [] + - name: Accounts Receivable + value: 3075173.68 + items: + - accountId: '70' + name: Debtors + value: 3041854.11 + items: [] + - accountId: '80' + name: Debtors - USD + value: 33315.2 + items: [] + - accountId: '125' + name: Debtors 2 + value: -9 + items: [] + - accountId: '88' + name: TestBankAccount + value: 13.37 + items: [] + - name: Other Current Asset + value: 259411.26 + items: + - accountId: '98' + name: Account_001 + value: 545.86 + items: [] + - accountId: '185' + name: Loans To Officers + value: 1200 + items: [] + - accountId: '179' + name: Loans to Others + value: 58.2 + items: [] + - accountId: '171' + name: Matt Ager Test UI Parent Account 1 + value: 11 + items: [] + - accountId: '168' + name: Other current assets + value: 10 + items: [] + - accountId: '65' + name: Stock Asset + value: 36533.45 + items: [] + - accountId: '150' + name: stock test + value: 10 + items: [] + - accountId: '77' + name: Uncategorised Asset + value: 47.8 + items: [] + - accountId: '85' + name: Undeposited Funds + value: 220994.95 + items: [] + liabilities: + name: Liabilities + value: 699368.94 + items: + - name: Accounts Payable + value: 93773.74 + items: + - accountId: '71' + name: Creditors + value: 93660.4 + items: [] + - accountId: '74' + name: Creditors - HKD + value: 113.34 + items: [] + - name: Credit Card + value: 12226.79 + items: + - accountId: '142' + name: 2504 Amex - CC + value: 11004.72 + items: [] + - accountId: '126' + name: Credit Card 2 + value: -71.91 + items: [] + - accountId: '183' + name: Expense Automated Tests Credit Card + value: -2471.46 + items: [] + - accountId: '57' + name: Visa Credit Card + value: 3765.44 + items: [] + - name: Other Current Liability + value: 538490.11 + items: + - accountId: '118' + name: Current Liabilities + value: 72.12 + items: [] + - accountId: '157' + name: Loan Payable - Kay's Bank + value: 12726 + items: [] + - accountId: '187' + name: Payroll Clearing + value: -3458.3 + items: [] + - accountId: '53' + name: VAT Control + value: -3792.71 + items: [] + - accountId: '54' + name: VAT Suspense + value: 532943 + items: [] + - name: Long Term Liability + value: 54878.3 + items: + - accountId: '158' + name: Loan Long term borrowings - Jay's Bank + value: 35630 + items: [] + - accountId: '84' + name: Long term borrowings + value: -1100 + items: [] + - accountId: '63' + name: Note Payable + value: 19348.3 + items: [] + - accountId: '86' + name: Accruals and deferred income + value: 1000 + items: [] + netAssets: 3686084.31 + equity: + name: Equity + value: 3686084.31 + items: + - name: Equity + value: 3697585.43 + items: + - accountId: '55' + name: Opening Balance Equity + value: 966720.56 + items: [] + - accountId: '2' + name: Retained Earnings + value: 2706364.87 + items: [] + - accountId: '61' + name: Owner's Equity - Contributions + value: 25500 + items: [] + - accountId: '62' + name: Owner's Equity - Draws + value: -1000 + items: [] + - name: Profit for the year + value: -11501.12 + items: [] + mostRecentAvailableMonth: '2023-04-30T00:00:00' + earliestAvailableMonth: '2022-10-01T00:00:00' + QuickBooks Online: + value: + reports: [] + Sage 50 (UK): + value: + currency: GBP + reports: + - date: '2023-03-31T00:00:00' + assets: + name: Assets + value: 239322.69 + items: + - name: Fixed Assets + value: 81530.08 + items: + - name: Plant and Machinery + value: 46515 + items: + - accountId: '0020' + name: Plant and Machinery + value: 50000 + items: [] + - accountId: '0021' + name: Plant/Machinery Depreciation + value: -3485 + items: [] + - name: Furniture and Fixtures + value: 16807 + items: + - accountId: '0040' + name: Furniture and Fixtures + value: 16900 + items: [] + - accountId: '0041' + name: Furniture/Fixture Depreciation + value: -93 + items: [] + - name: Motor Vehicles + value: 18208.08 + items: + - accountId: '0051' + name: Motor Vehicles Depreciation + value: -2091.92 + items: [] + - accountId: '0050' + name: Motor Vehicles + value: 20300 + items: [] + - name: Current Assets + value: 157792.61 + items: + - name: Stock + value: 35000 + items: + - accountId: '1001' + name: Stock + value: 35000 + items: [] + - name: Debtors + value: 90640.61 + items: + - accountId: '1100' + name: Debtors Control Account + value: 90640.61 + items: [] + - accountId: '1103' + name: Prepayments + value: 0 + items: [] + - name: Deposits and Cash + value: 5148.01 + items: + - accountId: '1220' + name: Building Society Account + value: 507.53 + items: [] + - accountId: '1230' + name: Petty Cash + value: 1130.48 + items: [] + - accountId: '1210' + name: Bank Deposit Account + value: 3510 + items: [] + - name: VAT Liability + value: 27003.99 + items: + - accountId: '2201' + name: Purchase Tax Control Account + value: 12203.64 + items: [] + - accountId: '2202' + name: VAT Liability + value: 14800.35 + items: [] + liabilities: + name: Liabilities + value: 97996.05 + items: + - name: Current Liabilities + value: 84941.05 + items: + - name: Bank Account + value: 20091.04 + items: + - accountId: '1200' + name: Bank Current Account + value: 20091.04 + items: [] + - name: Credit Card (Creditors) + value: -9358.97 + items: + - accountId: '1240' + name: Company Credit Card + value: -9358.97 + items: [] + - name: 'Creditors : Short Term' + value: 44502.68 + items: + - accountId: '2100' + name: Creditors Control Account + value: 44502.68 + items: [] + - accountId: '2109' + name: Accruals + value: 0 + items: [] + - name: VAT Liability + value: 22182.53 + items: + - accountId: '2200' + name: Sales Tax Control Account + value: 22182.53 + items: [] + - name: Taxation + value: 7403.77 + items: + - accountId: '2210' + name: P.A.Y.E. + value: 5396.79 + items: [] + - accountId: '2211' + name: National Insurance + value: 2006.98 + items: [] + - name: Wages + value: 120 + items: + - accountId: '2220' + name: Net Wages + value: 0 + items: [] + - accountId: '2230' + name: Pension Fund + value: 120 + items: [] + - name: Non-Current Liabilities + value: 13055 + items: + - name: 'Creditors : Long Term' + value: 13055 + items: + - accountId: '2310' + name: Hire Purchase + value: 6160 + items: [] + - accountId: '2300' + name: Loans + value: 6895 + items: [] + netAssets: 141326.64 + equity: + name: Equity + value: 141326.64 + items: + - name: Share Capital + value: 96332 + items: + - accountId: '3000' + name: Ordinary Shares + value: 96332 + items: [] + - name: Profit and Loss Account + value: 44994.64 + items: [] + - date: '2023-02-28T00:00:00' + assets: + name: Assets + value: 239322.69 + items: + - name: Fixed Assets + value: 81530.08 + items: + - name: Plant and Machinery + value: 46515 + items: + - accountId: '0020' + name: Plant and Machinery + value: 50000 + items: [] + - accountId: '0021' + name: Plant/Machinery Depreciation + value: -3485 + items: [] + - name: Furniture and Fixtures + value: 16807 + items: + - accountId: '0040' + name: Furniture and Fixtures + value: 16900 + items: [] + - accountId: '0041' + name: Furniture/Fixture Depreciation + value: -93 + items: [] + - name: Motor Vehicles + value: 18208.08 + items: + - accountId: '0051' + name: Motor Vehicles Depreciation + value: -2091.92 + items: [] + - accountId: '0050' + name: Motor Vehicles + value: 20300 + items: [] + - name: Current Assets + value: 157792.61 + items: + - name: Stock + value: 35000 + items: + - accountId: '1001' + name: Stock + value: 35000 + items: [] + - name: Debtors + value: 90640.61 + items: + - accountId: '1100' + name: Debtors Control Account + value: 90640.61 + items: [] + - accountId: '1103' + name: Prepayments + value: 0 + items: [] + - name: Deposits and Cash + value: 5148.01 + items: + - accountId: '1220' + name: Building Society Account + value: 507.53 + items: [] + - accountId: '1230' + name: Petty Cash + value: 1130.48 + items: [] + - accountId: '1210' + name: Bank Deposit Account + value: 3510 + items: [] + - name: VAT Liability + value: 27003.99 + items: + - accountId: '2201' + name: Purchase Tax Control Account + value: 12203.64 + items: [] + - accountId: '2202' + name: VAT Liability + value: 14800.35 + items: [] + liabilities: + name: Liabilities + value: 97996.05 + items: + - name: Current Liabilities + value: 84941.05 + items: + - name: Bank Account + value: 20091.04 + items: + - accountId: '1200' + name: Bank Current Account + value: 20091.04 + items: [] + - name: Credit Card (Creditors) + value: -9358.97 + items: + - accountId: '1240' + name: Company Credit Card + value: -9358.97 + items: [] + - name: 'Creditors : Short Term' + value: 44502.68 + items: + - accountId: '2100' + name: Creditors Control Account + value: 44502.68 + items: [] + - accountId: '2109' + name: Accruals + value: 0 + items: [] + - name: VAT Liability + value: 22182.53 + items: + - accountId: '2200' + name: Sales Tax Control Account + value: 22182.53 + items: [] + - name: Taxation + value: 7403.77 + items: + - accountId: '2210' + name: P.A.Y.E. + value: 5396.79 + items: [] + - accountId: '2211' + name: National Insurance + value: 2006.98 + items: [] + - name: Wages + value: 120 + items: + - accountId: '2220' + name: Net Wages + value: 0 + items: [] + - accountId: '2230' + name: Pension Fund + value: 120 + items: [] + - name: Non-Current Liabilities + value: 13055 + items: + - name: 'Creditors : Long Term' + value: 13055 + items: + - accountId: '2310' + name: Hire Purchase + value: 6160 + items: [] + - accountId: '2300' + name: Loans + value: 6895 + items: [] + netAssets: 141326.64 + equity: + name: Equity + value: 141326.64 + items: + - name: Share Capital + value: 96332 + items: + - accountId: '3000' + name: Ordinary Shares + value: 96332 + items: [] + - name: Profit and Loss Account + value: 44994.64 + items: [] + mostRecentAvailableMonth: '2023-03-31T00:00:00' + earliestAvailableMonth: '2021-04-01T00:00:00' + Sage Business Cloud Accounting: + value: + currency: GBP + reports: + - date: '2022-10-31T00:00:00' + assets: + name: Assets + value: 1740591.73 + items: + - accountId: 9a25937b267a11e797950a57719b2edb + name: 1200 - Current + value: 8493.25 + items: [] + - accountId: 9a3e4bc6267a11e797950a57719b2edb + name: 1210 - Cash + value: 2664.25 + items: [] + - accountId: 9a98cf79267a11e797950a57719b2edb + name: 1 - Assets - Cost + value: 1302.24 + items: [] + - accountId: 9a990bbd267a11e797950a57719b2edb + name: 30 - Office equipment and IT - Cost + value: 100 + items: [] + - accountId: 9a99117b267a11e797950a57719b2edb + name: 40 - Fixtures and fittings - Cost + value: 485 + items: [] + - accountId: 9a9915ef267a11e797950a57719b2edb + name: 50 - Motor Vehicles - Cost + value: -426.67 + items: [] + - accountId: 9a991c56267a11e797950a57719b2edb + name: 1100 - Trade Debtors + value: 1425254.88 + items: [] + - accountId: 9a991e47267a11e797950a57719b2edb + name: 1101 - Provision for doubtful debtors + value: 25 + items: [] + - accountId: 7e6c7ed52c2d11e8b45c025132dab352 + name: 1220 - Savings + value: -155764.91 + items: [] + - accountId: 2572c8766afc11e8aaa5027d54329956 + name: 1230 - Tide Current + value: 509590.44 + items: [] + - accountId: e5889b459f544926ac5b8e6756df2ad4 + name: 1560 - Abdi Internet Bank + value: 49.61 + items: [] + - accountId: b17083bc9b2748b4ab321b024e260eda + name: 147852 - Abdi Live Test + value: -225830.75 + items: [] + - accountId: 92b80ba619d34cafbedd0eb2e69a82f7 + name: 12345678 - ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + value: 34321.11 + items: [] + - accountId: ae17d64a96a741719f1d31045aa4a8ef + name: 11113 - bills bank account + value: 2919.35 + items: [] + - accountId: 7c8be6c5e19a40cd92f93e36aecd4156 + name: 12345698 - Abdi Savings + value: 8949 + items: [] + - accountId: 5a64e8ada630412eb8fd1762175b3182 + name: 12345748 - My Test Bank Account + value: 20438.71 + items: [] + - accountId: 8cd0b0b93f0f4c8ba3434bc72d297cc2 + name: 12345758 - AlexT + value: 1080 + items: [] + - accountId: d340f7af2ba249cbb1c4cf12a6fdae14 + name: 12345768 - AbdiCredit + value: -40 + items: [] + - accountId: 8065f6270c984d6dae78ce817399ac4d + name: 101010 - Test Push Account + value: 120 + items: [] + - accountId: b34c43d0f3cd404ead4b282c2163c021 + name: 231 - TestArch12345 + value: -20 + items: [] + - accountId: 0f114074c6874794961e6e4b1ab6e4b1 + name: 466 - TestArch321 + value: 0.01 + items: [] + - accountId: fd4573ca207742d7bc8f04481952e53a + name: 1004 - Card Provider Bank Account + value: -4 + items: [] + - accountId: 90f1a608fcee4bddbc81cce5f6335060 + name: 345678 - Capital on Tap Bank Account CC + value: -120 + items: [] + - accountId: 5e77ffb2faa540a794f2dbd157064556 + name: 12345788 - Mike B Commerce Test Bank Account + value: 89120.55 + items: [] + - accountId: ad11ee61cdc54d4bb991f4855d9608b0 + name: 12345798 - Current Account 5 + value: 30 + items: [] + - accountId: f8cfa3dd79da436683f1768de75858b0 + name: 12345818 - Maria's Current Account + value: 1732.13 + items: [] + - accountId: e6717e9019c7456787e9054822772ebb + name: 12345828 - Joseph Test + value: 15662 + items: [] + - accountId: 495afbea7acb4be38cb5910b8c8db27d + name: 56743 - Nic Test Bank Account + value: 13.4 + items: [] + - accountId: f7559ab5cf8a493aa436503bd9712158 + name: 12345858 - Rob Credit Card + value: -200 + items: [] + - accountId: 83fbaf62ee244bebbee822d97b267c55 + name: 12345898 - Joseph (EUR) + value: 95.09 + items: [] + - accountId: afac9b7c22184fae8f7bc734d880b166 + name: 12345928 - Matt Ager test loan + value: 10 + items: [] + - accountId: 553ed57b302b4eda881b129b6abda736 + name: 12345938 - Matt Ager Test Current Account + value: 239.77 + items: [] + - accountId: 785c9d9f9b954307bd700bede22cf0b5 + name: 12345948 - Matt Ager Test Savings Account + value: 195 + items: [] + - accountId: 3c18fba9e0ba414bb6668bc0668a3090 + name: 12345958 - Matt Ager Test Credit Card + value: 30 + items: [] + - accountId: a11475c87cd54d0bb81951852ad91035 + name: 12345968 - Matt Ager Test Cash + value: 290 + items: [] + - accountId: 3d067bcf4a4b4a408ef3abaa4d944b91 + name: 12345978 - Matt Ager Test Other Bank Account + value: 20 + items: [] + - accountId: 179e02763960436c903b7ff2708659a2 + name: 12345988 - Matt Ager Test EUR Account + value: -58.16 + items: [] + - accountId: bb6151d3fd744fa6a81f2164b1d156dc + name: 13918348 - PUSH 1 Matt Ager Test EUR Account + value: 9 + items: [] + - accountId: 9a207c1a748b45f29117fa7126c12a9e + name: 13918594 - Australian Current Account + value: 1.43 + items: [] + - accountId: ab8e9947a5434c848e9a294188664117 + name: 13918604 - Bank Account 70 + value: -70 + items: [] + - accountId: 77650bcb6a1d4924be22d6a5da309031 + name: 13918624 - COT GBP Account + value: -10 + items: [] + - accountId: 8be8979ae30c46a6830dc653c9ad4400 + name: 57436 - Capital on Tap Business Credit Card + value: -105 + items: [] + liabilities: + name: Liabilities + value: 173084617.49 + items: + - accountId: 9a992290267a11e797950a57719b2edb + name: 2100 - Trade Creditors + value: 183778965.2 + items: [] + - accountId: 9a992966267a11e797950a57719b2edb + name: 2200 - VAT on Sales + value: 57234.67 + items: [] + - accountId: 9a992b99267a11e797950a57719b2edb + name: 2201 - VAT on Purchases + value: -34745.24 + items: [] + - accountId: 9a992d9e267a11e797950a57719b2edb + name: 2202 - VAT Liability + value: 256.86 + items: [] + - accountId: 9a992fb3267a11e797950a57719b2edb + name: 2203 - VAT Allocations & Adjustments + value: -40 + items: [] + - accountId: 9a9931b4267a11e797950a57719b2edb + name: 2205 - VAT on Sales - Holding Account + value: 199200.59 + items: [] + - accountId: 9a9933d1267a11e797950a57719b2edb + name: 2206 - VAT on Purchases - Holding Account + value: -10893226.32 + items: [] + - accountId: b954fb00e56447259a9f0cd84dbb6125 + name: 12345 - Pete Bill Account + value: -6383.05 + items: [] + - accountId: 7723dee96cbb435a800c2f7c047f47f3 + name: 312323 - Commerce Prepaid + value: -12842.93 + items: [] + - accountId: f96e7c899a1c4336bfbfe3d91ff4c157 + name: 121212 - Commerce Prepaid2 + value: -464.36 + items: [] + - accountId: 7ed323223f8d4d8f8f737d76e380a254 + name: 987 - Mike B Commerce Prepaid Test Account + value: -5011.84 + items: [] + - accountId: a2b43df636774b5a92fbfd889e390348 + name: 989 - Mike B Commerce Loan Test Account + value: 62 + items: [] + - accountId: 5cdf52bfb00d4d86b5a01e8af0761fe5 + name: 990 - Mike B Commerce Loan Test Account + value: 1538.24 + items: [] + - accountId: 09f1976c146f40c6b2009b26f1d20f97 + name: 42 - TestDatatypesAccount + value: 100 + items: [] + - accountId: 229eb087d0574c28be42fa4cc89af1f3 + name: 2110 - Trade Creditors + value: -26.33 + items: [] + netAssets: -171344025.76 + equity: + name: Equities + value: -171344025.76 + items: + - accountId: PROFIT-AND-LOSS + name: Profit for this period + value: -171344025.76 + items: [] + - date: '2022-09-30T00:00:00' + assets: + name: Assets + value: 1748139.93 + items: + - accountId: 9a25937b267a11e797950a57719b2edb + name: 1200 - Current + value: 8493.25 + items: [] + - accountId: 9a3e4bc6267a11e797950a57719b2edb + name: 1210 - Cash + value: 2664.25 + items: [] + - accountId: 9a98cf79267a11e797950a57719b2edb + name: 1 - Assets - Cost + value: 1302.24 + items: [] + - accountId: 9a990bbd267a11e797950a57719b2edb + name: 30 - Office equipment and IT - Cost + value: 100 + items: [] + - accountId: 9a99117b267a11e797950a57719b2edb + name: 40 - Fixtures and fittings - Cost + value: 485 + items: [] + - accountId: 9a9915ef267a11e797950a57719b2edb + name: 50 - Motor Vehicles - Cost + value: -426.67 + items: [] + - accountId: 9a991c56267a11e797950a57719b2edb + name: 1100 - Trade Debtors + value: 1432812.05 + items: [] + - accountId: 9a991e47267a11e797950a57719b2edb + name: 1101 - Provision for doubtful debtors + value: 25 + items: [] + - accountId: 7e6c7ed52c2d11e8b45c025132dab352 + name: 1220 - Savings + value: -155764.91 + items: [] + - accountId: 2572c8766afc11e8aaa5027d54329956 + name: 1230 - Tide Current + value: 509590.44 + items: [] + - accountId: e5889b459f544926ac5b8e6756df2ad4 + name: 1560 - Abdi Internet Bank + value: 49.61 + items: [] + - accountId: b17083bc9b2748b4ab321b024e260eda + name: 147852 - Abdi Live Test + value: -225830.75 + items: [] + - accountId: 92b80ba619d34cafbedd0eb2e69a82f7 + name: 12345678 - ozzbtdynvoblhytjolxaiohrtrhtpvndiqncpjtcjzwcddpvzl + value: 34321.11 + items: [] + - accountId: ae17d64a96a741719f1d31045aa4a8ef + name: 11113 - bills bank account + value: 2919.35 + items: [] + - accountId: 7c8be6c5e19a40cd92f93e36aecd4156 + name: 12345698 - Abdi Savings + value: 8949 + items: [] + - accountId: 5a64e8ada630412eb8fd1762175b3182 + name: 12345748 - My Test Bank Account + value: 20438.74 + items: [] + - accountId: 8cd0b0b93f0f4c8ba3434bc72d297cc2 + name: 12345758 - AlexT + value: 1080 + items: [] + - accountId: d340f7af2ba249cbb1c4cf12a6fdae14 + name: 12345768 - AbdiCredit + value: -40 + items: [] + - accountId: 8065f6270c984d6dae78ce817399ac4d + name: 101010 - Test Push Account + value: 120 + items: [] + - accountId: b34c43d0f3cd404ead4b282c2163c021 + name: 231 - TestArch12345 + value: -20 + items: [] + - accountId: 0f114074c6874794961e6e4b1ab6e4b1 + name: 466 - TestArch321 + value: 0.01 + items: [] + - accountId: fd4573ca207742d7bc8f04481952e53a + name: 1004 - Card Provider Bank Account + value: -4 + items: [] + - accountId: 90f1a608fcee4bddbc81cce5f6335060 + name: 345678 - Capital on Tap Bank Account CC + value: -120 + items: [] + - accountId: 5e77ffb2faa540a794f2dbd157064556 + name: 12345788 - Mike B Commerce Test Bank Account + value: 89120.55 + items: [] + - accountId: ad11ee61cdc54d4bb991f4855d9608b0 + name: 12345798 - Current Account 5 + value: 30 + items: [] + - accountId: f8cfa3dd79da436683f1768de75858b0 + name: 12345818 - Maria's Current Account + value: 1732.13 + items: [] + - accountId: e6717e9019c7456787e9054822772ebb + name: 12345828 - Joseph Test + value: 15662 + items: [] + - accountId: 495afbea7acb4be38cb5910b8c8db27d + name: 56743 - Nic Test Bank Account + value: 13.4 + items: [] + - accountId: f7559ab5cf8a493aa436503bd9712158 + name: 12345858 - Rob Credit Card + value: -200 + items: [] + - accountId: 83fbaf62ee244bebbee822d97b267c55 + name: 12345898 - Joseph (EUR) + value: 95.09 + items: [] + - accountId: afac9b7c22184fae8f7bc734d880b166 + name: 12345928 - Matt Ager test loan + value: 10 + items: [] + - accountId: 553ed57b302b4eda881b129b6abda736 + name: 12345938 - Matt Ager Test Current Account + value: 239.77 + items: [] + - accountId: 785c9d9f9b954307bd700bede22cf0b5 + name: 12345948 - Matt Ager Test Savings Account + value: 195 + items: [] + - accountId: 3c18fba9e0ba414bb6668bc0668a3090 + name: 12345958 - Matt Ager Test Credit Card + value: 30 + items: [] + - accountId: a11475c87cd54d0bb81951852ad91035 + name: 12345968 - Matt Ager Test Cash + value: 290 + items: [] + - accountId: 3d067bcf4a4b4a408ef3abaa4d944b91 + name: 12345978 - Matt Ager Test Other Bank Account + value: 20 + items: [] + - accountId: 179e02763960436c903b7ff2708659a2 + name: 12345988 - Matt Ager Test EUR Account + value: -58.16 + items: [] + - accountId: 9a207c1a748b45f29117fa7126c12a9e + name: 13918594 - Australian Current Account + value: 1.43 + items: [] + - accountId: ab8e9947a5434c848e9a294188664117 + name: 13918604 - Bank Account 70 + value: -70 + items: [] + - accountId: 77650bcb6a1d4924be22d6a5da309031 + name: 13918624 - COT GBP Account + value: -10 + items: [] + - accountId: 8be8979ae30c46a6830dc653c9ad4400 + name: 57436 - Capital on Tap Business Credit Card + value: -105 + items: [] + liabilities: + name: Liabilities + value: 161482418.52 + items: + - accountId: 9a992290267a11e797950a57719b2edb + name: 2100 - Trade Creditors + value: 171440565.23 + items: [] + - accountId: 9a992966267a11e797950a57719b2edb + name: 2200 - VAT on Sales + value: 57232.9 + items: [] + - accountId: 9a992b99267a11e797950a57719b2edb + name: 2201 - VAT on Purchases + value: -34745.24 + items: [] + - accountId: 9a992d9e267a11e797950a57719b2edb + name: 2202 - VAT Liability + value: 256.86 + items: [] + - accountId: 9a992fb3267a11e797950a57719b2edb + name: 2203 - VAT Allocations & Adjustments + value: -40 + items: [] + - accountId: 9a9931b4267a11e797950a57719b2edb + name: 2205 - VAT on Sales - Holding Account + value: 199003.36 + items: [] + - accountId: 9a9933d1267a11e797950a57719b2edb + name: 2206 - VAT on Purchases - Holding Account + value: -10156826.32 + items: [] + - accountId: b954fb00e56447259a9f0cd84dbb6125 + name: 12345 - Pete Bill Account + value: -6383.05 + items: [] + - accountId: 7723dee96cbb435a800c2f7c047f47f3 + name: 312323 - Commerce Prepaid + value: -12842.93 + items: [] + - accountId: f96e7c899a1c4336bfbfe3d91ff4c157 + name: 121212 - Commerce Prepaid2 + value: -464.36 + items: [] + - accountId: 7ed323223f8d4d8f8f737d76e380a254 + name: 987 - Mike B Commerce Prepaid Test Account + value: -5011.84 + items: [] + - accountId: a2b43df636774b5a92fbfd889e390348 + name: 989 - Mike B Commerce Loan Test Account + value: 62 + items: [] + - accountId: 5cdf52bfb00d4d86b5a01e8af0761fe5 + name: 990 - Mike B Commerce Loan Test Account + value: 1538.24 + items: [] + - accountId: 09f1976c146f40c6b2009b26f1d20f97 + name: 42 - TestDatatypesAccount + value: 100 + items: [] + - accountId: 229eb087d0574c28be42fa4cc89af1f3 + name: 2110 - Trade Creditors + value: -26.33 + items: [] + netAssets: -159734278.59 + equity: + name: Equities + value: -159734278.59 + items: + - accountId: PROFIT-AND-LOSS + name: Profit for this period + value: -159734278.59 + items: [] + mostRecentAvailableMonth: '2022-10-31T00:00:00' + earliestAvailableMonth: '2022-04-01T00:00:00' + Wave: + value: + currency: GBP + reports: + - date: '2022-11-30T00:00:00' + assets: + name: Assets + value: 2220.87 + items: + - name: Cash and Bank + value: 1001.87 + items: + - name: Abdi Bank + value: 158.9 + items: [] + - name: Cash on Hand + value: 245.31 + items: [] + - name: Current Account + value: 597.66 + items: [] + - name: Other Current Assets + value: 219 + items: + - name: Accounts Receivable + value: 211.99 + items: [] + - name: Unrealized Gain on Foreign Exchange + value: 7.01 + items: [] + - name: Long-term Assets + value: 1000 + items: + - name: Furniture + value: 1000 + items: [] + liabilities: + name: Liabilities + value: 4641.15 + items: + - name: Current Liabilities + value: 4641.15 + items: + - name: Accounts Payable + value: 3557.14 + items: [] + - name: Abdul's new Tax + value: 7.54 + items: [] + - name: FederalABC + value: 1002.6 + items: [] + - name: STANDARD + value: 73.87 + items: [] + netAssets: -2420.28 + equity: + name: Equity + value: -2420.28 + items: + - name: Other Equity + value: 63.8 + items: + - name: Owner Investment / Drawings + value: -36.2 + items: [] + - name: Some Equity + value: 100 + items: [] + - name: Retained Earnings + value: -2484.08 + items: + - name: Profit for all prior years + value: -1950.59 + items: [] + - name: 'Profit between Jan 1, 2022 and Nov 30, 2022' + value: -533.49 + items: [] + - date: '2022-10-31T00:00:00' + assets: + name: Assets + value: 2222.22 + items: + - name: Cash and Bank + value: 1001.87 + items: + - name: Abdi Bank + value: 158.9 + items: [] + - name: Cash on Hand + value: 245.31 + items: [] + - name: Current Account + value: 597.66 + items: [] + - name: Other Current Assets + value: 220.35 + items: + - name: Accounts Receivable + value: 211.99 + items: [] + - name: Unrealized Gain on Foreign Exchange + value: 8.36 + items: [] + - name: Long-term Assets + value: 1000 + items: + - name: Furniture + value: 1000 + items: [] + liabilities: + name: Liabilities + value: 4086.15 + items: + - name: Current Liabilities + value: 4086.15 + items: + - name: Accounts Payable + value: 3002.14 + items: [] + - name: Abdul's new Tax + value: 7.54 + items: [] + - name: FederalABC + value: 1002.6 + items: [] + - name: STANDARD + value: 73.87 + items: [] + netAssets: -1863.93 + equity: + name: Equity + value: -1863.93 + items: + - name: Other Equity + value: 63.8 + items: + - name: Owner Investment / Drawings + value: -36.2 + items: [] + - name: Some Equity + value: 100 + items: [] + - name: Retained Earnings + value: -1927.73 + items: + - name: Profit for all prior years + value: -1950.59 + items: [] + - name: 'Profit between Jan 1, 2022 and Oct 31, 2022' + value: 22.86 + items: [] + mostRecentAvailableMonth: '2022-11-30T00:00:00' + earliestAvailableMonth: '2022-05-01T00:00:00' + Xero: + value: + currency: GBP + reports: + - date: '2023-03-31T23:59:59' + assets: + name: Assets + value: 24166.8 + items: + - name: Current Assets + value: 21486.84 + items: + - name: Bank + value: 924.25 + items: + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + value: 924.25 + items: [] + - accountId: a1e2c53a-18b9-40cb-8e87-e2db200fe8af + name: Inventory + value: 121.21 + items: [] + - accountId: 8add7c44-ffe0-4a42-869e-b85dadd5eac1 + name: Accounts Receivable + value: 20441.38 + items: [] + - name: Fixed Assets + value: 2679.96 + items: + - accountId: a4602fb6-2e9d-4064-b318-c409032692ba + name: Office Equipment + value: 3665.63 + items: [] + - accountId: 8d1ae68b-1251-4b44-9d7a-639b3976935c + name: Computer Equipment + value: -985.67 + items: [] + liabilities: + name: Liabilities + value: 14265.73 + items: + - name: Current Liabilities + value: 14265.73 + items: + - accountId: b12f79b9-a082-4b8b-971e-d321292943c7 + name: VAT + value: 1194.45 + items: [] + - accountId: 1873bf00-e52f-48e9-89d6-619c93723f60 + name: Unpaid Expense Claims + value: 150.85 + items: [] + - accountId: 7ff95c6a-5849-4030-a361-52165fab6490 + name: Historical Adjustment + value: 4130.98 + items: [] + - accountId: e0faa299-ca0d-4b0a-9e32-0dfabdf9179a + name: Accounts Payable + value: 8789.45 + items: [] + netAssets: 9901.07 + equity: + name: Equity + value: 9901.07 + items: + - accountId: 524c9f2d-e680-4861-82f6-4ad171b51de5 + name: Retained Earnings + value: -7961.99 + items: [] + - accountId: abababab-abab-abab-abab-abababababab + name: Current Year Earnings + value: 17863.06 + items: [] + - date: '2023-02-28T23:59:59' + assets: + name: Assets + value: 24166.8 + items: + - name: Current Assets + value: 21486.84 + items: + - name: Bank + value: 924.25 + items: + - accountId: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + name: Business Bank Account + value: 924.25 + items: [] + - accountId: a1e2c53a-18b9-40cb-8e87-e2db200fe8af + name: Inventory + value: 121.21 + items: [] + - accountId: 8add7c44-ffe0-4a42-869e-b85dadd5eac1 + name: Accounts Receivable + value: 20441.38 + items: [] + - name: Fixed Assets + value: 2679.96 + items: + - accountId: a4602fb6-2e9d-4064-b318-c409032692ba + name: Office Equipment + value: 3665.63 + items: [] + - accountId: 8d1ae68b-1251-4b44-9d7a-639b3976935c + name: Computer Equipment + value: -985.67 + items: [] + liabilities: + name: Liabilities + value: 14265.73 + items: + - name: Current Liabilities + value: 14265.73 + items: + - accountId: b12f79b9-a082-4b8b-971e-d321292943c7 + name: VAT + value: 1194.45 + items: [] + - accountId: 1873bf00-e52f-48e9-89d6-619c93723f60 + name: Unpaid Expense Claims + value: 150.85 + items: [] + - accountId: 7ff95c6a-5849-4030-a361-52165fab6490 + name: Historical Adjustment + value: 4130.98 + items: [] + - accountId: e0faa299-ca0d-4b0a-9e32-0dfabdf9179a + name: Accounts Payable + value: 8789.45 + items: [] + netAssets: 9901.07 + equity: + name: Equity + value: 9901.07 + items: + - accountId: 524c9f2d-e680-4861-82f6-4ad171b51de5 + name: Retained Earnings + value: -7961.99 + items: [] + - accountId: abababab-abab-abab-abab-abababababab + name: Current Year Earnings + value: 17863.06 + items: [] + mostRecentAvailableMonth: '2023-03-31T00:00:00' + earliestAvailableMonth: '2022-09-01T00:00:00' + Zoho Books: + value: + currency: GBP + reports: + - date: '2022-10-31T00:00:00' + assets: + name: Assets + value: 63170.61 + items: + - name: Current Assets + value: 63150.61 + items: + - name: Cash + value: 1678.31 + items: + - accountId: '104957000000000349' + name: Petty Cash + value: -8246.75 + items: [] + - accountId: '104957000000000346' + name: Undeposited Funds + value: 9925.06 + items: [] + - name: Bank + value: 69910.1 + items: + - accountId: '104957000000060010' + name: Abdi Test + value: 69858.44 + items: [] + - accountId: '104957000000065002' + name: Abdi Test 2 + value: 20 + items: [] + - accountId: '104957000000080006' + name: EUR Test Bank Account + value: 24.29 + items: [] + - accountId: '104957000000508001' + name: Subtra USD wallet + value: 7.37 + items: [] + - accountId: '104957000000000352' + name: Accounts Receivable + value: -959.64 + items: [] + - name: Other Current Assets + value: -7478.16 + items: + - accountId: '104957000000000358' + name: Advance Tax + value: 2.63 + items: [] + - accountId: '104957000000000457' + name: Employee Advance + value: 0 + items: [] + - accountId: '104957000000033015' + name: Input VAT + value: 356.84 + items: [] + - accountId: '104957000000000511' + name: Inventory Asset + value: 90.06 + items: [] + - accountId: '104957000000032010' + name: Prepaid Expenses + value: -8017.69 + items: [] + - accountId: '104957000000388007' + name: Sales to Customers (Cash) + value: 0 + items: [] + - accountId: '104957000000093001' + name: Test prepaid expenses child account + value: 0 + items: [] + - accountId: '104957000000096007' + name: Test prepaid expenses child account 2 + value: 100 + items: [] + - accountId: '104957000000096001' + name: Test prepaid expenses child child account + value: -50 + items: [] + - accountId: '104957000000085001' + name: Test stock account + value: 40 + items: [] + - name: Other Assets + value: 0 + items: [] + - name: Fixed Assets + value: 20 + items: + - accountId: '104957000000000355' + name: Furniture and Equipment + value: 20 + items: [] + liabilities: + name: Liabilities + value: 8615.39 + items: + - name: Liabilities + value: 8615.39 + items: + - name: Current Liabilities + value: 8615.39 + items: + - accountId: '104957000000000361' + name: Accounts Payable + value: 2084.6 + items: [] + - accountId: '104957000000618001' + name: Creadit Card - BA Company + value: 656.05 + items: [] + - accountId: '104957000000183010' + name: Credit Card + value: 26.25 + items: [] + - accountId: '104957000000000460' + name: Employee Reimbursements + value: 10.35 + items: [] + - accountId: '104957000000000499' + name: Opening Balance Adjustments + value: 0 + items: [] + - accountId: '104957000000033017' + name: Output VAT + value: 3934.75 + items: [] + - accountId: '104957000000000501' + name: Unearned Revenue + value: 1903.39 + items: [] + - accountId: '104957000000054026' + name: VAT MOSS Payable + value: 0 + items: [] + - accountId: '104957000000000364' + name: VAT Payable + value: 0 + items: [] + - name: Long Term Liabilities + value: 0 + items: [] + - name: Other Liabilities + value: 0 + items: + - accountId: '104957000000006001' + name: Tag Adjustments + value: 0 + items: [] + netAssets: 54555.22 + equity: + name: Equities + value: 54555.22 + items: + - accountId: '' + name: Current Year Earnings + value: -15199.89 + items: [] + - accountId: '104957000000000451' + name: Drawing + value: 0 + items: [] + - accountId: '104957000000000373' + name: Opening Balance Offset + value: 10000 + items: [] + - accountId: '104957000000000370' + name: Owner's Equity + value: 0 + items: [] + - accountId: '104957000000000367' + name: Retained Earnings + value: 59755.11 + items: [] + - date: '2022-09-01T00:00:00' + assets: + name: Assets + value: 63170.61 + items: + - name: Current Assets + value: 63150.61 + items: + - name: Cash + value: 1678.31 + items: + - accountId: '104957000000000349' + name: Petty Cash + value: -8246.75 + items: [] + - accountId: '104957000000000346' + name: Undeposited Funds + value: 9925.06 + items: [] + - name: Bank + value: 69910.1 + items: + - accountId: '104957000000060010' + name: Abdi Test + value: 69858.44 + items: [] + - accountId: '104957000000065002' + name: Abdi Test 2 + value: 20 + items: [] + - accountId: '104957000000080006' + name: EUR Test Bank Account + value: 24.29 + items: [] + - accountId: '104957000000508001' + name: Subtra USD wallet + value: 7.37 + items: [] + - accountId: '104957000000000352' + name: Accounts Receivable + value: -959.64 + items: [] + - name: Other Current Assets + value: -7478.16 + items: + - accountId: '104957000000000358' + name: Advance Tax + value: 2.63 + items: [] + - accountId: '104957000000000457' + name: Employee Advance + value: 0 + items: [] + - accountId: '104957000000033015' + name: Input VAT + value: 356.84 + items: [] + - accountId: '104957000000000511' + name: Inventory Asset + value: 90.06 + items: [] + - accountId: '104957000000032010' + name: Prepaid Expenses + value: -8017.69 + items: [] + - accountId: '104957000000388007' + name: Sales to Customers (Cash) + value: 0 + items: [] + - accountId: '104957000000093001' + name: Test prepaid expenses child account + value: 0 + items: [] + - accountId: '104957000000096007' + name: Test prepaid expenses child account 2 + value: 100 + items: [] + - accountId: '104957000000096001' + name: Test prepaid expenses child child account + value: -50 + items: [] + - accountId: '104957000000085001' + name: Test stock account + value: 40 + items: [] + - name: Other Assets + value: 0 + items: [] + - name: Fixed Assets + value: 20 + items: + - accountId: '104957000000000355' + name: Furniture and Equipment + value: 20 + items: [] + liabilities: + name: Liabilities + value: 8615.39 + items: + - name: Liabilities + value: 8615.39 + items: + - name: Current Liabilities + value: 8615.39 + items: + - accountId: '104957000000000361' + name: Accounts Payable + value: 2084.6 + items: [] + - accountId: '104957000000618001' + name: Creadit Card - BA Company + value: 656.05 + items: [] + - accountId: '104957000000183010' + name: Credit Card + value: 26.25 + items: [] + - accountId: '104957000000000460' + name: Employee Reimbursements + value: 10.35 + items: [] + - accountId: '104957000000000499' + name: Opening Balance Adjustments + value: 0 + items: [] + - accountId: '104957000000033017' + name: Output VAT + value: 3934.75 + items: [] + - accountId: '104957000000000501' + name: Unearned Revenue + value: 1903.39 + items: [] + - accountId: '104957000000054026' + name: VAT MOSS Payable + value: 0 + items: [] + - accountId: '104957000000000364' + name: VAT Payable + value: 0 + items: [] + - name: Long Term Liabilities + value: 0 + items: [] + - name: Other Liabilities + value: 0 + items: + - accountId: '104957000000006001' + name: Tag Adjustments + value: 0 + items: [] + netAssets: 54555.22 + equity: + name: Equities + value: 54555.22 + items: + - accountId: '' + name: Current Year Earnings + value: -15199.89 + items: [] + - accountId: '104957000000000451' + name: Drawing + value: 0 + items: [] + - accountId: '104957000000000373' + name: Opening Balance Offset + value: 10000 + items: [] + - accountId: '104957000000000370' + name: Owner's Equity + value: 0 + items: [] + - accountId: '104957000000000367' + name: Retained Earnings + value: 59755.11 + items: [] + mostRecentAvailableMonth: '2022-10-31T00:00:00' + earliestAvailableMonth: '2022-04-01T00:00:00' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/financials/profitAndLoss': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Financial statements + summary: Get profit and loss + description: Gets the latest profit and loss for a company. + operationId: get-accounting-profit-and-loss + x-speakeasy-group: financial-statements.profit-and-loss + parameters: + - $ref: '#/components/parameters/accountingPeriodLength' + - $ref: '#/components/parameters/accountingPeriodsToCompare' + - $ref: '#/components/parameters/accountingStartMonth' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingProfitAndLossReport' + examples: + Clear Books: + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + accountId: '' + name: Income + value: 146840.42 + items: + - accountId: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + value: 146840.42 + items: [] + costOfSales: + accountId: '' + name: Cost of Sales + value: 29955.45 + items: + - accountId: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + value: 29955.45 + items: [] + grossProfit: 116884.97 + expenses: + accountId: '' + name: Expenses + value: 62407.18 + items: + - accountId: 868591ad-f9c2-4956-a5ec-c32c1d48c6f3 + name: Advertising & Marketing + value: 24962.87 + items: [] + - accountId: 940c8a59-3348-4a0b-a1b1-781d9f29cc8b + name: Depreciation Expense + value: 1550.12 + items: [] + - accountId: e7ac3baa-cfbe-40c1-a172-83d22e84435b + name: Entertainment-100% business + value: 1410.61 + items: [] + - accountId: b5e801e8-8dbc-4390-ac99-3b0fff54a89f + name: General Expenses + value: 1283.66 + items: [] + - accountId: 5360066d-1474-49f6-a7a5-c66d5f6032ba + name: 'Light, Power, Heating' + value: 1168.13 + items: [] + - accountId: 138a8eb3-5c08-4e59-a3bc-892119694447 + name: Motor Vehicle Expenses + value: 944.89 + items: [] + - accountId: 1734ff00-2a17-45b4-8db6-2dc2e832c460 + name: 'Postage, Freight & Courier' + value: 977.96 + items: [] + - accountId: 7aa7988a-ff61-4cb8-bef3-15395355d108 + name: Printing & Stationery + value: 889.94 + items: [] + - accountId: 9cbe5fe4-ca60-4792-8bf1-de01fb7010aa + name: Rent + value: 8000 + items: [] + - accountId: 04f7111b-55d4-4efc-b329-1bd5c791933a + name: Repairs & Maintenance + value: 719.86 + items: [] + - accountId: 7d8d0322-f452-47de-a8e8-54b0130e6f38 + name: Subscriptions + value: 40 + items: [] + - accountId: 043b6bcb-dfe6-4c97-9b4c-f9b300fe3f03 + name: Telephone & Internet + value: 45 + items: [] + - accountId: df62060b-41cc-4bf2-9de7-c7e537b5663a + name: Travel - National + value: 6000.46 + items: [] + - accountId: eef78ed1-dfed-447c-bdba-3a49fb2c044b + name: Audit & Accountancy fees + value: 0 + items: [] + - accountId: f3aa84fe-5c31-4107-b207-7e0419f636d7 + name: Bank Fees + value: 609.29 + items: [] + - accountId: c16f5c35-8283-47da-9d09-5fecb183b0cb + name: Cleaning + value: 130 + items: [] + - accountId: fb3210ef-edeb-48af-bb49-b85d40c1e6bb + name: Corporation Tax + value: 630.62 + items: [] + - accountId: 7f6a0e92-65be-4333-9a0a-d981b03bedd1 + name: Wages + value: 12000 + items: [] + - accountId: e8a0a24e-2dab-46b1-bfe1-6e92551c04e8 + name: Purchase Discounts + value: 510.1 + items: [] + - accountId: 4378ddba-36b4-4b35-9970-bd972b20d137 + name: Amortization + value: 5.72 + items: [] + - accountId: 78785fd7-f197-4c34-aa17-6e76b9255d34 + name: Interest Paid (operating) + value: 527.95 + items: [] + netOperatingProfit: 54477.79 + otherExpenses: + accountId: '' + name: Other Expenses + value: 350.44 + items: + - accountId: cbf82e0d-87a7-464d-b567-9274ea94a1c0 + name: Charitable and Political Donations + value: 350.44 + items: [] + otherIncome: + accountId: '' + name: Other Income + value: 850.22 + items: + - accountId: 68794a8f-b22d-4520-b97b-025b7cb10f94 + name: Other Revenue + value: 850.22 + items: [] + netOtherIncome: 499.78 + netProfit: 54977.57 + - fromDate: '2023-02-01T00:00:00' + toDate: '2023-02-28T00:00:00' + income: + accountId: '' + name: Income + value: 108461.81 + items: + - accountId: 72df89d2-512b-4455-af51-a6b563733842 + name: Sales + value: 108461.81 + items: [] + costOfSales: + accountId: '' + name: Cost of Sales + value: 18438.51 + items: + - accountId: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Purchases + value: 18438.51 + items: [] + grossProfit: 90023.3 + expenses: + accountId: '' + name: Expenses + value: 46096.28 + items: + - accountId: 868591ad-f9c2-4956-a5ec-c32c1d48c6f3 + name: Advertising & Marketing + value: 18438.51 + items: [] + - accountId: 940c8a59-3348-4a0b-a1b1-781d9f29cc8b + name: Depreciation Expense + value: 669.33 + items: [] + - accountId: e7ac3baa-cfbe-40c1-a172-83d22e84435b + name: Entertainment-100% business + value: 609.09 + items: [] + - accountId: b5e801e8-8dbc-4390-ac99-3b0fff54a89f + name: General Expenses + value: 554.28 + items: [] + - accountId: 5360066d-1474-49f6-a7a5-c66d5f6032ba + name: 'Light, Power, Heating' + value: 448.35 + items: [] + - accountId: 138a8eb3-5c08-4e59-a3bc-892119694447 + name: Motor Vehicle Expenses + value: 412.48 + items: [] + - accountId: 1734ff00-2a17-45b4-8db6-2dc2e832c460 + name: 'Postage, Freight & Courier' + value: 426.92 + items: [] + - accountId: 7aa7988a-ff61-4cb8-bef3-15395355d108 + name: Printing & Stationery + value: 388.49 + items: [] + - accountId: 9cbe5fe4-ca60-4792-8bf1-de01fb7010aa + name: Rent + value: 8000 + items: [] + - accountId: 04f7111b-55d4-4efc-b329-1bd5c791933a + name: Repairs & Maintenance + value: 314.25 + items: [] + - accountId: 7d8d0322-f452-47de-a8e8-54b0130e6f38 + name: Subscriptions + value: 40 + items: [] + - accountId: 043b6bcb-dfe6-4c97-9b4c-f9b300fe3f03 + name: Telephone & Internet + value: 45 + items: [] + - accountId: df62060b-41cc-4bf2-9de7-c7e537b5663a + name: Travel - National + value: 325.25 + items: [] + - accountId: eef78ed1-dfed-447c-bdba-3a49fb2c044b + name: Audit & Accountancy fees + value: 0 + items: [] + - accountId: f3aa84fe-5c31-4107-b207-7e0419f636d7 + name: Bank Fees + value: 2600.97 + items: [] + - accountId: c16f5c35-8283-47da-9d09-5fecb183b0cb + name: Cleaning + value: 130 + items: [] + - accountId: fb3210ef-edeb-48af-bb49-b85d40c1e6bb + name: Corporation Tax + value: 239.41 + items: [] + - accountId: 7f6a0e92-65be-4333-9a0a-d981b03bedd1 + name: Wages + value: 12000 + items: [] + - accountId: e8a0a24e-2dab-46b1-bfe1-6e92551c04e8 + name: Purchase Discounts + value: 220.26 + items: [] + - accountId: 4378ddba-36b4-4b35-9970-bd972b20d137 + name: Amortization + value: 5.72 + items: [] + - accountId: 78785fd7-f197-4c34-aa17-6e76b9255d34 + name: Interest Paid (operating) + value: 227.97 + items: [] + netOperatingProfit: 43927.02 + otherExpenses: + accountId: '' + name: Other Expenses + value: 350.44 + items: + - accountId: cbf82e0d-87a7-464d-b567-9274ea94a1c0 + name: Charitable and Political Donations + value: 350.44 + items: [] + otherIncome: + accountId: '' + name: Other Income + value: 850.22 + items: + - accountId: 68794a8f-b22d-4520-b97b-025b7cb10f94 + name: Other Revenue + value: 850.22 + items: [] + netOtherIncome: 499.78 + netProfit: 44426.8 + reportBasis: Unknown + currency: GBP + mostRecentAvailableMonth: '2023-03-01T00:00:00' + earliestAvailableMonth: '2018-04-01T00:00:00' + Dynamics 365 Business Central: + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 658.5 + items: + - name: Sales Returns & Allowances + value: 0 + items: + - accountId: 8aba49ae-461a-ed11-90eb-000d3a873324 + name: '0121 - ' + value: 0 + items: [] + - accountId: 1e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10400 - Sales Returns & Allowances + value: 0 + items: [] + - name: 'Income, Services' + value: 0 + items: + - accountId: ac6a3a74-c69f-ec11-80f1-0022481b4546 + name: 10005-1 - Child + value: 0 + items: [] + - accountId: 161217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '10100 - Income, Services' + value: 0 + items: [] + - name: 'Income, Jobs' + value: 0 + items: + - accountId: 1f2618f9-c79f-ec11-80f1-0022481b4546 + name: 10005-2 - Child Child + value: 0 + items: [] + - accountId: 1a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10250 - Job Sales + value: 0 + items: [] + - name: '' + value: 0 + items: + - accountId: de1cabee-4a33-ed11-97e8-0022481aa72d + name: 1005002 - Test account no cat 2 + value: 0 + items: [] + - accountId: b74b0c08-aa59-eb11-89f9-00224800a7ae + name: '1006 - Account without category Income ' + value: 0 + items: [] + - accountId: 023a8eba-c12e-ed11-97e8-000d3a8753f5 + name: 3213 - vdfgdf + value: 0 + items: [] + - accountId: aa666f5a-c22e-ed11-97e8-0022480052b7 + name: 'TEST INCOME A/C - ' + value: 0 + items: [] + - name: 'Income, Product Sales' + value: 658.5 + items: + - accountId: 181217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '10200 - Income, Product Sales' + value: 658.5 + items: [] + - name: Sales Discounts + value: 0 + items: + - accountId: 1c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10300 - Sales Discounts + value: 0 + items: [] + - name: Job Sales Contra + value: 0 + items: + - accountId: 201217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10450 - Job Sales Applied + value: 0 + items: [] + - name: Income + value: 0 + items: + - accountId: 221217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10500 - Interest Income + value: 0 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 2735.64 + items: + - name: Materials + value: 2735.64 + items: + - accountId: 281217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20100 - Cost of Materials + value: 2735.64 + items: [] + - name: Labour + value: 0 + items: + - accountId: 2a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20200 - Cost of Labour + value: 0 + items: [] + - name: Jobs Cost + value: 0 + items: + - accountId: 2c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20300 - Job Costs + value: 0 + items: [] + grossProfit: -2077.14 + expenses: + name: Expense + value: 41.77 + items: + - name: '' + value: 0 + items: + - accountId: e9b4e2c2-4b33-ed11-97e8-0022481aa72d + name: 1005003 - Expense Test account no cat + value: 0 + items: [] + - accountId: 1d60f4a2-6d19-ed11-90eb-002248009024 + name: 1234512345 - Invalid VAT Posting Setup + value: 0 + items: [] + - name: Interest Expense + value: 0 + items: + - accountId: bd407350-340b-ec11-86bc-0022481a4971 + name: 1093 - export with misc type + value: 0 + items: [] + - accountId: 381217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30300 - Interest Expense + value: 0 + items: [] + - name: Other Income & Expenses + value: 0 + items: + - accountId: 2e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20399 - Job Costs Applied + value: 0 + items: [] + - accountId: 4e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31400 - Office Supplies Expense + value: 0 + items: [] + - accountId: 501217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31500 - Miscellaneous Expense + value: 0 + items: [] + - accountId: 521217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '31600 - Depreciation, Equipment' + value: 0 + items: [] + - accountId: 541217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31900 - Rounding + value: 0 + items: [] + - name: Benefits Expense + value: 0 + items: + - accountId: 57a95f12-9ecf-ec11-8e7e-00224800faf5 + name: 23 - test account + value: 0 + items: [] + - name: Fees Expense + value: 0 + items: + - accountId: 3f6818aa-a4cf-ec11-8e7e-00224800faf5 + name: 30 - test expenses 2 + value: 0 + items: [] + - accountId: 3a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30400 - Bank Charges and Fees + value: 0 + items: [] + - accountId: 3c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30500 - Processing Fees + value: 0 + items: [] + - name: Rent Expense + value: 0 + items: + - accountId: 341217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30100 - Rent Expense + value: 0 + items: [] + - name: Advertising Expense + value: 0 + items: + - accountId: 361217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30200 - Advertising Expense + value: 0 + items: [] + - name: Bad Debt Expense + value: 0 + items: + - accountId: 3e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30600 - Bad Debt Expense + value: 0 + items: [] + - name: Salaries Expense + value: 0 + items: + - accountId: 401217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30700 - Salaries Expense + value: 0 + items: [] + - name: Payroll Expense + value: 0 + items: + - accountId: 421217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30800 - Payroll Tax Expense + value: 0 + items: [] + - accountId: 441217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '30900 - Workers Compensation ' + value: 0 + items: [] + - name: Insurance Expense + value: 41.77 + items: + - accountId: 461217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31000 - Health & Dental Insurance Expense + value: 41.77 + items: [] + - accountId: 481217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31100 - Life Insurance Expense + value: 0 + items: [] + - name: Repairs and Maintenance Expense + value: 0 + items: + - accountId: 4a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31200 - Repairs and Maintenance Expense + value: 0 + items: [] + - name: Utilities Expense + value: 0 + items: + - accountId: 4c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31300 - Utilities Expense + value: 0 + items: [] + - name: Travel Expense + value: 0 + items: + - accountId: 61d17174-61db-ec11-82f9-002248008de8 + name: 999992 - Payhawk General + value: 0 + items: [] + - accountId: 3a37ed38-a6cf-ec11-8e7e-00224800faf5 + name: 999998 - Payhawk General + value: 0 + items: [] + - accountId: 64ee049b-a1cf-ec11-8e7e-00224800faf5 + name: 999999 - Payhawk General + value: 0 + items: [] + netOperatingProfit: -2118.91 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -2118.91 + - fromDate: '2023-02-01T00:00:00' + toDate: '2023-02-28T00:00:00' + income: + name: Income + value: 414.51 + items: + - name: Sales Returns & Allowances + value: -125.17 + items: + - accountId: 8aba49ae-461a-ed11-90eb-000d3a873324 + name: '0121 - ' + value: -125.17 + items: [] + - accountId: 1e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10400 - Sales Returns & Allowances + value: 0 + items: [] + - name: 'Income, Services' + value: -10 + items: + - accountId: ac6a3a74-c69f-ec11-80f1-0022481b4546 + name: 10005-1 - Child + value: -10 + items: [] + - accountId: 161217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '10100 - Income, Services' + value: 0 + items: [] + - name: 'Income, Jobs' + value: -12.91 + items: + - accountId: 1f2618f9-c79f-ec11-80f1-0022481b4546 + name: 10005-2 - Child Child + value: -12.91 + items: [] + - accountId: 1a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10250 - Job Sales + value: 0 + items: [] + - name: '' + value: 0 + items: + - accountId: de1cabee-4a33-ed11-97e8-0022481aa72d + name: 1005002 - Test account no cat 2 + value: 0 + items: [] + - accountId: b74b0c08-aa59-eb11-89f9-00224800a7ae + name: '1006 - Account without category Income ' + value: 0 + items: [] + - accountId: 023a8eba-c12e-ed11-97e8-000d3a8753f5 + name: 3213 - vdfgdf + value: 0 + items: [] + - accountId: aa666f5a-c22e-ed11-97e8-0022480052b7 + name: 'TEST INCOME A/C - ' + value: 0 + items: [] + - name: 'Income, Product Sales' + value: 430.4 + items: + - accountId: 181217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '10200 - Income, Product Sales' + value: 430.4 + items: [] + - name: Sales Discounts + value: 0 + items: + - accountId: 1c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10300 - Sales Discounts + value: 0 + items: [] + - name: Job Sales Contra + value: 0 + items: + - accountId: 201217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10450 - Job Sales Applied + value: 0 + items: [] + - name: Income + value: 132.19 + items: + - accountId: 221217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 10500 - Interest Income + value: 132.19 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 328 + items: + - name: Materials + value: 328 + items: + - accountId: 281217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20100 - Cost of Materials + value: 328 + items: [] + - name: Labour + value: 0 + items: + - accountId: 2a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20200 - Cost of Labour + value: 0 + items: [] + - name: Jobs Cost + value: 0 + items: + - accountId: 2c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20300 - Job Costs + value: 0 + items: [] + grossProfit: 86.51 + expenses: + name: Expense + value: 1482.02 + items: + - name: '' + value: 9.52 + items: + - accountId: e9b4e2c2-4b33-ed11-97e8-0022481aa72d + name: 1005003 - Expense Test account no cat + value: 0 + items: [] + - accountId: 1d60f4a2-6d19-ed11-90eb-002248009024 + name: 1234512345 - Invalid VAT Posting Setup + value: 9.52 + items: [] + - name: Interest Expense + value: 0 + items: + - accountId: bd407350-340b-ec11-86bc-0022481a4971 + name: 1093 - export with misc type + value: 0 + items: [] + - accountId: 381217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30300 - Interest Expense + value: 0 + items: [] + - name: Other Income & Expenses + value: 0 + items: + - accountId: 2e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 20399 - Job Costs Applied + value: 0 + items: [] + - accountId: 4e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31400 - Office Supplies Expense + value: 0 + items: [] + - accountId: 501217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31500 - Miscellaneous Expense + value: 0 + items: [] + - accountId: 521217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '31600 - Depreciation, Equipment' + value: 0 + items: [] + - accountId: 541217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31900 - Rounding + value: 0 + items: [] + - name: Benefits Expense + value: 0 + items: + - accountId: 57a95f12-9ecf-ec11-8e7e-00224800faf5 + name: 23 - test account + value: 0 + items: [] + - name: Fees Expense + value: 0 + items: + - accountId: 3f6818aa-a4cf-ec11-8e7e-00224800faf5 + name: 30 - test expenses 2 + value: 0 + items: [] + - accountId: 3a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30400 - Bank Charges and Fees + value: 0 + items: [] + - accountId: 3c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30500 - Processing Fees + value: 0 + items: [] + - name: Rent Expense + value: 0 + items: + - accountId: 341217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30100 - Rent Expense + value: 0 + items: [] + - name: Advertising Expense + value: 0 + items: + - accountId: 361217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30200 - Advertising Expense + value: 0 + items: [] + - name: Bad Debt Expense + value: -1.82 + items: + - accountId: 3e1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30600 - Bad Debt Expense + value: -1.82 + items: [] + - name: Salaries Expense + value: 0 + items: + - accountId: 401217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30700 - Salaries Expense + value: 0 + items: [] + - name: Payroll Expense + value: 0 + items: + - accountId: 421217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 30800 - Payroll Tax Expense + value: 0 + items: [] + - accountId: 441217b3-89d1-ea11-bbaa-000d3a2b9185 + name: '30900 - Workers Compensation ' + value: 0 + items: [] + - name: Insurance Expense + value: 1474.32 + items: + - accountId: 461217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31000 - Health & Dental Insurance Expense + value: 1474.32 + items: [] + - accountId: 481217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31100 - Life Insurance Expense + value: 0 + items: [] + - name: Repairs and Maintenance Expense + value: 0 + items: + - accountId: 4a1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31200 - Repairs and Maintenance Expense + value: 0 + items: [] + - name: Utilities Expense + value: 0 + items: + - accountId: 4c1217b3-89d1-ea11-bbaa-000d3a2b9185 + name: 31300 - Utilities Expense + value: 0 + items: [] + - name: Travel Expense + value: 0 + items: + - accountId: 61d17174-61db-ec11-82f9-002248008de8 + name: 999992 - Payhawk General + value: 0 + items: [] + - accountId: 3a37ed38-a6cf-ec11-8e7e-00224800faf5 + name: 999998 - Payhawk General + value: 0 + items: [] + - accountId: 64ee049b-a1cf-ec11-8e7e-00224800faf5 + name: 999999 - Payhawk General + value: 0 + items: [] + netOperatingProfit: -1395.51 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -1395.51 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-03-01T00:00:00' + earliestAvailableMonth: '2021-04-01T00:00:00' + Exact (Netherlands): + value: + reports: + - fromDate: '2022-09-01T00:00:00Z' + toDate: '2022-09-30T00:00:00Z' + income: + name: Income + value: -286 + items: + - accountId: 2421e8a0-5355-4ec0-af11-021fe4f39fcd + name: 8000 - Omzet binnenland hoog tarief + value: -286 + items: [] + - accountId: 0b5b5d8b-1c0c-4767-88d8-c99206da6ace + name: 555777 - Sales + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: -286 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: -286 + otherExpenses: + name: Other Expenses + value: 5.25 + items: + - accountId: e405eff6-5c15-43b9-a5f0-ba592b26fbbe + name: 9410 - Inkoopkortingen + value: 5.25 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: -5.25 + netProfit: -291.25 + - fromDate: '2022-08-01T00:00:00Z' + toDate: '2022-08-31T00:00:00Z' + income: + name: Income + value: 664.73 + items: + - accountId: 2421e8a0-5355-4ec0-af11-021fe4f39fcd + name: 8000 - Omzet binnenland hoog tarief + value: 643.33 + items: [] + - accountId: 62981769-c358-4ee5-aa8a-c9d5c559dd5c + name: 9275 - Activa realisatie verlies + value: -13.6 + items: [] + - accountId: f93008c5-f45b-4200-82a8-d0d5e1584ee7 + name: 1234567 - james_test2 + value: 35 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 664.73 + expenses: + name: Expenses + value: 13.6 + items: + - accountId: 62981769-c358-4ee5-aa8a-c9d5c559dd5c + name: 9275 - Activa realisatie verlies + value: 13.6 + items: [] + netOperatingProfit: 651.13 + otherExpenses: + name: Other Expenses + value: 45 + items: + - accountId: e405eff6-5c15-43b9-a5f0-ba592b26fbbe + name: 9410 - Inkoopkortingen + value: 45 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: -45 + netProfit: 606.13 + reportBasis: Unknown + currency: EUR + mostRecentAvailableMonth: '2022-09-01T00:00:00' + earliestAvailableMonth: '2020-11-01T00:00:00' + Exact (UK): + value: + reports: + - fromDate: '2022-10-01T00:00:00Z' + toDate: '2022-10-31T00:00:00Z' + income: + name: Income + value: -2 + items: + - accountId: 43acd218-6a95-445f-994c-660273e0ced9 + name: 41000 - Sales + value: -2 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: -2 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: -2 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -2 + - fromDate: '2022-09-01T00:00:00Z' + toDate: '2022-09-30T00:00:00Z' + income: + name: Income + value: 208 + items: + - accountId: 43acd218-6a95-445f-994c-660273e0ced9 + name: 41000 - Sales + value: 208 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 208 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 208 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 208 + reportBasis: Unknown + currency: GBP + mostRecentAvailableMonth: '2022-10-01T00:00:00' + earliestAvailableMonth: '2020-11-01T00:00:00' + FreshBooks: + value: + reports: + - fromDate: '2023-04-01T00:00:00' + toDate: '2023-04-30T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 24.05 + items: + - accountId: '3384197' + name: Advertising + value: 0.21 + items: [] + - accountId: '3380421' + name: Car & Truck Expenses + value: 11 + items: [] + - accountId: '3361426' + name: Meals & Entertainment + value: 12.82 + items: [] + - accountId: '3379249' + name: Supplies + value: 0.02 + items: [] + netOperatingProfit: -24.05 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -24.04 + reportBasis: Cash + currency: GBP + mostRecentAvailableMonth: '2023-04-01T00:00:00' + earliestAvailableMonth: '2021-05-01T00:00:00' + KashFlow: + value: + reports: + - fromDate: '2022-09-01T00:00:00' + toDate: '2022-09-30T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost Of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2022-08-01T00:00:00' + toDate: '2022-08-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost Of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + reportBasis: Unknown + currency: GBP + mostRecentAvailableMonth: '2022-09-01T00:00:00' + earliestAvailableMonth: '2020-10-01T00:00:00' + MYOB AccountRight and Essentials: + value: + reports: + - fromDate: '2022-11-01T00:00:00' + toDate: '2022-11-30T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2022-10-01T00:00:00' + toDate: '2022-10-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2022-11-01T00:00:00' + earliestAvailableMonth: '2020-12-01T00:00:00' + Oracle NetSuite: + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: -123.45 + items: + - accountId: '58' + name: Expenses + value: -123.45 + items: [] + netOperatingProfit: 123.45 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 123.45 + - fromDate: '2023-01-01T00:00:00' + toDate: '2023-01-31T00:00:00' + income: + name: Income + value: 11 + items: + - accountId: '108' + name: Shipping and Handling + value: 11 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 11 + expenses: + name: Expenses + value: 11 + items: + - accountId: '58' + name: Expenses + value: 11 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-03-01T00:00:00' + earliestAvailableMonth: '2022-11-01T00:00:00' + QuickBooks Desktop: + value: + reports: + - fromDate: '2023-04-01T00:00:00' + toDate: '2023-04-30T00:00:00' + income: + name: Income + value: 7673.5 + items: + - accountId: 170000-933270541 + name: 40100 � Construction Income + value: 7673.5 + items: + - accountId: 190000-933270541 + name: 40130 � Labor Income + value: 840 + items: [] + - accountId: 1A0000-933270542 + name: 40140 � Materials Income + value: 4103.5 + items: [] + - accountId: 1C0000-933270542 + name: 40150 � Subcontracted Labor Income + value: 2730 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 1729.85 + items: + - accountId: 1E0000-933270542 + name: 50100 � Cost of Goods Sold + value: 329.85 + items: [] + - accountId: 300000-933270542 + name: 54000 � Job Expenses + value: 1400 + items: + - accountId: 340000-933270542 + name: 54500 � Subcontractors + value: 1400 + items: [] + grossProfit: 5943.65 + expenses: + name: Expense + value: 2417.29 + items: + - accountId: 1F0000-933270542 + name: 60100 � Automobile + value: 1066.56 + items: + - accountId: 200000-933270542 + name: 60110 � Fuel + value: 162 + items: [] + - accountId: 580000-1071498064 + name: 60120 � Insurance + value: 712.56 + items: [] + - accountId: 210000-933270542 + name: 60130 � Repairs and Maintenance + value: 192 + items: [] + - accountId: 230000-933270542 + name: 60600 � Bank Service Charges + value: 12.5 + items: [] + - accountId: 290000-933270542 + name: 62100 � Insurance + value: 675 + items: + - accountId: 2A0000-933270542 + name: 62110 � Disability Insurance + value: 50 + items: [] + - accountId: 2B0000-933270542 + name: 62120 � Liability Insurance + value: 350 + items: [] + - accountId: 2C0000-933270542 + name: 62130 � Work Comp + value: 275 + items: [] + - accountId: 2D0000-933270542 + name: 62400 � Interest Expense + value: 438.3 + items: + - accountId: 2F0000-933270542 + name: 62420 � Loan Interest + value: 438.3 + items: [] + - accountId: 480000-933270542 + name: 65100 � Utilities + value: 224.93 + items: + - accountId: 490000-933270542 + name: 65110 � Gas and Electric + value: 120.93 + items: [] + - accountId: 4A0000-933270542 + name: 65120 � Telephone + value: 80 + items: [] + - accountId: 4B0000-933270542 + name: 65130 � Water + value: 24 + items: [] + netOperatingProfit: 3526.36 + otherExpenses: + name: Other Expense + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 3526.36 + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 16500 + items: + - accountId: 170000-933270541 + name: 40100 � Construction Income + value: 16500 + items: + - accountId: 1C0000-933270542 + name: 40150 � Subcontracted Labor Income + value: 16500 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 7500 + items: + - accountId: 300000-933270542 + name: 54000 � Job Expenses + value: 7500 + items: + - accountId: 340000-933270542 + name: 54500 � Subcontractors + value: 7500 + items: [] + grossProfit: 9000 + expenses: + name: Expense + value: 3159.99 + items: + - accountId: 1F0000-933270542 + name: 60100 � Automobile + value: 359 + items: + - accountId: 200000-933270542 + name: 60110 � Fuel + value: 127 + items: [] + - accountId: 210000-933270542 + name: 60130 � Repairs and Maintenance + value: 232 + items: [] + - accountId: 230000-933270542 + name: 60600 � Bank Service Charges + value: 12.5 + items: [] + - accountId: 290000-933270542 + name: 62100 � Insurance + value: 675 + items: + - accountId: 2A0000-933270542 + name: 62110 � Disability Insurance + value: 50 + items: [] + - accountId: 2B0000-933270542 + name: 62120 � Liability Insurance + value: 350 + items: [] + - accountId: 2C0000-933270542 + name: 62130 � Work Comp + value: 275 + items: [] + - accountId: 2D0000-933270542 + name: 62400 � Interest Expense + value: 456.29 + items: + - accountId: 2F0000-933270542 + name: 62420 � Loan Interest + value: 456.29 + items: [] + - accountId: 3D0000-933270542 + name: 64200 � Repairs + value: 1164 + items: + - accountId: 3F0000-933270542 + name: 64220 � Computer Repairs + value: 714 + items: [] + - accountId: 400000-933270542 + name: 64230 � Equipment Repairs + value: 450 + items: [] + - accountId: 480000-933270542 + name: 65100 � Utilities + value: 493.2 + items: + - accountId: 490000-933270542 + name: 65110 � Gas and Electric + value: 389.2 + items: [] + - accountId: 4A0000-933270542 + name: 65120 � Telephone + value: 80 + items: [] + - accountId: 4B0000-933270542 + name: 65130 � Water + value: 24 + items: [] + netOperatingProfit: 5840.01 + otherExpenses: + name: Other Expense + value: 0 + items: [] + otherIncome: + name: Other Income + value: 93.42 + items: + - accountId: 4C0000-933270542 + name: 70200 � Interest Income + value: 93.42 + items: [] + netOtherIncome: 93.42 + netProfit: 5933.43 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-04-01T00:00:00' + earliestAvailableMonth: '2021-05-01T00:00:00' + QuickBooks Online Sandbox: + value: + reports: + - fromDate: '2023-04-01T00:00:00' + toDate: '2023-04-30T00:00:00' + income: + name: Income + value: 35.7 + items: + - accountId: '68' + name: Billable Expenses Income + value: -15 + items: [] + - accountId: '44' + name: Sales + value: 130 + items: [] + - accountId: '66' + name: Sales of Product Income + value: 42.5 + items: [] + - accountId: '1' + name: Services + value: -131.8 + items: [] + - accountId: '149' + name: Shipping Income + value: 10 + items: [] + costOfSales: + name: Cost of Sales + value: -8.16 + items: + - accountId: '67' + name: Cost of sales + value: 33.51 + items: [] + - accountId: '69' + name: Cost of Sales - billable expenses + value: -41.67 + items: [] + grossProfit: 43.86 + expenses: + name: Expenses + value: -987 + items: + - accountId: '148' + name: Billable Test + value: -250 + items: [] + - accountId: '16' + name: Computer and Internet Expenses + value: -897 + items: [] + - accountId: '18' + name: Depreciation Expense + value: 100 + items: [] + - accountId: '19' + name: Dues and Subscriptions + value: -40 + items: [] + - accountId: '64' + name: Purchases + value: 100 + items: [] + netOperatingProfit: 1030.86 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 1030.86 + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 1664.93 + items: + - accountId: '14' + name: Commission Income + value: 64 + items: [] + - accountId: '44' + name: Sales + value: 952.29 + items: [] + - accountId: '43' + name: Sales Discounts + value: 9.05 + items: [] + - accountId: '66' + name: Sales of Product Income + value: 223.52 + items: [] + - accountId: '1' + name: Services + value: 392.32 + items: [] + - accountId: '149' + name: Shipping Income + value: 23.75 + items: [] + costOfSales: + name: Cost of Sales + value: 2568.09 + items: + - accountId: '67' + name: Cost of sales + value: 27.09 + items: [] + - accountId: '69' + name: Cost of Sales - billable expenses + value: 41 + items: [] + - accountId: '10' + name: Entertainment Booking Fees paid on behalf of clients + value: 2500 + items: [] + grossProfit: -903.16 + expenses: + name: Expenses + value: 397.62 + items: + - accountId: '148' + name: Billable Test + value: -35.75 + items: [] + - accountId: '12' + name: Business Licenses and Permits + value: -8 + items: [] + - accountId: '16' + name: Computer and Internet Expenses + value: 42.46 + items: [] + - accountId: '20' + name: Equipment rental + value: -22.76 + items: [] + - accountId: '116' + name: HM Revenue & Customs (VAT) Expense + value: -25.2 + items: [] + - accountId: '24' + name: Insurance Expense + value: 5.32 + items: [] + - accountId: '23' + name: Insurance Expense-Health Insurance + value: -34 + items: [] + - accountId: '31' + name: Marketing Expense + value: -11.56 + items: [] + - accountId: '35' + name: Office Supplies + value: -12.89 + items: [] + - accountId: '64' + name: Purchases + value: 500 + items: [] + netOperatingProfit: -1300.78 + otherExpenses: + name: Other Expenses + value: 11.92 + items: + - accountId: '52' + name: Exchange Gain or Loss + value: 11.92 + items: [] + otherIncome: + name: Other Income + value: 29.41 + items: + - accountId: '21' + name: Finance Charge Income + value: -13.44 + items: [] + - accountId: '27' + name: Insurance Proceeds Received + value: 7.85 + items: [] + - accountId: '29' + name: Interest income + value: 15 + items: [] + - accountId: '39' + name: Proceeds from Sale of Assets + value: 20 + items: [] + netOtherIncome: 17.49 + netProfit: -1283.29 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-04-01T00:00:00' + earliestAvailableMonth: '2021-05-01T00:00:00' + QuickBooks Online: + value: + reports: + - fromDate: '2023-01-01T00:00:00' + toDate: '2023-01-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 4300 + items: + - accountId: '68' + name: 303 HM Revenue & Customs (VAT) Expense + value: 250 + items: [] + - accountId: '22' + name: 408 Travelling expenses + value: 4050 + items: [] + netOperatingProfit: -4300 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -4300 + - fromDate: '2022-12-01T00:00:00' + toDate: '2022-12-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 10 + items: + - accountId: '16' + name: 292 Advertising + value: 10 + items: [] + netOperatingProfit: -10 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -10 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-01-01T00:00:00' + earliestAvailableMonth: '2021-02-01T00:00:00' + Sage 200cloud: + value: + reports: + - fromDate: '2020-12-01T00:00:00Z' + toDate: '2020-12-31T00:00:00Z' + income: + name: Income + value: 0 + items: + - name: Total Sales + value: 0 + items: + - accountId: '101' + name: Product Sales + value: 0 + items: [] + - accountId: '102' + name: Export Sales + value: 0 + items: [] + - accountId: '103' + name: Sales of Assets + value: 0 + items: [] + - accountId: '104' + name: Credit Charges (Late Payments) + value: 0 + items: [] + - accountId: '105' + name: Other Sales + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: + - name: Total Purchases + value: 0 + items: + - accountId: '201' + name: Purchases + value: 0 + items: [] + - accountId: '202' + name: Purchase Charges + value: 0 + items: [] + - accountId: '203' + name: Stock + value: 0 + items: [] + - name: Total Direct Expenses + value: 0 + items: + - accountId: '301' + name: Labour + value: 0 + items: [] + - accountId: '302' + name: Commissions + value: 0 + items: [] + - accountId: '303' + name: Sales Promotion + value: 0 + items: [] + - accountId: '304' + name: Miscellaneous Expenses + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: + - name: Total Overheads + value: 0 + items: + - accountId: '401' + name: Gross Wages + value: 0 + items: [] + - accountId: '402' + name: Rent and Rates + value: 0 + items: [] + - accountId: '403' + name: 'Heat, Light and Power' + value: 0 + items: [] + - accountId: '404' + name: Motor Expenses + value: 0 + items: [] + - accountId: '405' + name: Travelling and Entertainment + value: 0 + items: [] + - accountId: '406' + name: Printing and Stationery + value: 0 + items: [] + - accountId: '407' + name: Professional Fees + value: 0 + items: [] + - accountId: '408' + name: Equipment Hire and Rental + value: 0 + items: [] + - accountId: '409' + name: Maintenance + value: 0 + items: [] + - accountId: '410' + name: Bank Charges and Interest + value: 0 + items: [] + - accountId: '411' + name: Depreciation + value: 0 + items: [] + - accountId: '412' + name: Bad Debts + value: 0 + items: [] + - accountId: '413' + name: General Expenses + value: 0 + items: [] + - accountId: '414' + name: Suspense & Mispostings + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: + - accountId: '10,1001' + name: Taxation + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2020-11-01T00:00:00Z' + toDate: '2020-11-30T00:00:00Z' + income: + name: Income + value: 0 + items: + - name: Total Sales + value: 0 + items: + - accountId: '101' + name: Product Sales + value: 0 + items: [] + - accountId: '102' + name: Export Sales + value: 0 + items: [] + - accountId: '103' + name: Sales of Assets + value: 0 + items: [] + - accountId: '104' + name: Credit Charges (Late Payments) + value: 0 + items: [] + - accountId: '105' + name: Other Sales + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: + - name: Total Purchases + value: 0 + items: + - accountId: '201' + name: Purchases + value: 0 + items: [] + - accountId: '202' + name: Purchase Charges + value: 0 + items: [] + - accountId: '203' + name: Stock + value: 0 + items: [] + - name: Total Direct Expenses + value: 0 + items: + - accountId: '301' + name: Labour + value: 0 + items: [] + - accountId: '302' + name: Commissions + value: 0 + items: [] + - accountId: '303' + name: Sales Promotion + value: 0 + items: [] + - accountId: '304' + name: Miscellaneous Expenses + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: + - name: Total Overheads + value: 0 + items: + - accountId: '401' + name: Gross Wages + value: 0 + items: [] + - accountId: '402' + name: Rent and Rates + value: 0 + items: [] + - accountId: '403' + name: 'Heat, Light and Power' + value: 0 + items: [] + - accountId: '404' + name: Motor Expenses + value: 0 + items: [] + - accountId: '405' + name: Travelling and Entertainment + value: 0 + items: [] + - accountId: '406' + name: Printing and Stationery + value: 0 + items: [] + - accountId: '407' + name: Professional Fees + value: 0 + items: [] + - accountId: '408' + name: Equipment Hire and Rental + value: 0 + items: [] + - accountId: '409' + name: Maintenance + value: 0 + items: [] + - accountId: '410' + name: Bank Charges and Interest + value: 0 + items: [] + - accountId: '411' + name: Depreciation + value: 0 + items: [] + - accountId: '412' + name: Bad Debts + value: 0 + items: [] + - accountId: '413' + name: General Expenses + value: 0 + items: [] + - accountId: '414' + name: Suspense & Mispostings + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: + - accountId: '10,1001' + name: Taxation + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2020-12-01T00:00:00' + earliestAvailableMonth: '2015-01-01T00:00:00' + Sage 50 (UK): + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2023-02-01T00:00:00' + toDate: '2023-02-28T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + reportBasis: Unknown + currency: GBP + mostRecentAvailableMonth: '2023-03-01T00:00:00' + earliestAvailableMonth: '2021-04-01T00:00:00' + Sage Business Cloud Accounting: + value: + reports: + - fromDate: '2022-10-01T00:00:00' + toDate: '2022-10-31T00:00:00' + income: + name: Income + value: -7749 + items: + - accountId: 9a994b92267a11e797950a57719b2edb + name: 4000 - Sales Type A + value: -7740 + items: [] + - accountId: 9a994e06267a11e797950a57719b2edb + name: 4009 - Sales Discounts + value: -9 + items: [] + costOfSales: + name: Cost of Sales + value: 11602000 + items: + - accountId: 9a995955267a11e797950a57719b2edb + name: 5000 - Cost of sales - goods + value: 11602000 + items: [] + grossProfit: -11609749 + expenses: + name: Expenses + value: -1.83 + items: + - accountId: 9a99a91c267a11e797950a57719b2edb + name: 8211 - Exchange rate gain/(loss) + value: -1.83 + items: [] + netOperatingProfit: -11609747.17 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -11609747.17 + - fromDate: '2022-09-01T00:00:00' + toDate: '2022-09-30T00:00:00' + income: + name: Income + value: 501 + items: + - accountId: 9a994b92267a11e797950a57719b2edb + name: 4000 - Sales Type A + value: 511 + items: [] + - accountId: 9a994e06267a11e797950a57719b2edb + name: 4009 - Sales Discounts + value: -10 + items: [] + costOfSales: + name: Cost of Sales + value: 13220073.7 + items: + - accountId: 9a995955267a11e797950a57719b2edb + name: 5000 - Cost of sales - goods + value: 13220073.7 + items: [] + grossProfit: -13219572.7 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: -13219572.7 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: -148.34 + items: + - accountId: 9a995491267a11e797950a57719b2edb + name: 4900 - Other income + value: -148.34 + items: [] + netOtherIncome: -148.34 + netProfit: -13219721.04 + reportBasis: Unknown + currency: GBP + mostRecentAvailableMonth: '2022-10-01T00:00:00' + earliestAvailableMonth: '2020-11-01T00:00:00' + Wave: + value: + reports: + - fromDate: '2022-11-01T00:00:00' + toDate: '2022-11-30T00:00:00' + income: + name: Income + value: 7.01 + items: + - name: Unrealized Gain on Foreign Exchange + value: 7.01 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 0 + items: [] + grossProfit: 7.01 + expenses: + name: Operating Expenses + value: 555 + items: + - name: Office Supplies + value: 555 + items: [] + netOperatingProfit: -547.99 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -547.99 + - fromDate: '2022-10-01T00:00:00' + toDate: '2022-10-31T00:00:00' + income: + name: Income + value: 8.36 + items: + - name: Unrealized Gain on Foreign Exchange + value: 8.36 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 0 + items: [] + grossProfit: 8.36 + expenses: + name: Operating Expenses + value: 0 + items: [] + netOperatingProfit: 8.36 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 8.36 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2022-11-01T00:00:00' + earliestAvailableMonth: '2020-12-01T00:00:00' + Xero: + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + income: + name: Income + value: 0 + items: [] + costOfSales: + name: Cost of Sales + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Expenses + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2023-02-01T00:00:00' + toDate: '2023-02-28T00:00:00' + income: + name: Income + value: 14496.51 + items: + - accountId: c563b607-fb0e-4d06-9ddb-76fdeef20ae3 + name: Sales + value: 14496.51 + items: [] + costOfSales: + name: Cost of Sales + value: 700 + items: + - accountId: 127f3b99-8dc2-4b7e-854c-91ef9bd2757b + name: Purchases + value: 700 + items: [] + grossProfit: 13796.51 + expenses: + name: Expenses + value: 2026.92 + items: + - accountId: f96c9458-d724-47bf-8f74-a9d5726465ce + name: General Expenses + value: 215.87 + items: [] + - accountId: d50842c3-af67-4233-b8c9-df3180f5b7bd + name: 'Light, Power, Heating' + value: 103.43 + items: [] + - accountId: 0be1631e-cc7e-4c27-951f-308c3307c0fe + name: Motor Vehicle Expenses + value: 342.79 + items: [] + - accountId: a49cc958-968e-4b54-96d6-8853c036009e + name: 'Postage, Freight & Courier' + value: 94.19 + items: [] + - accountId: cba6527d-f102-4538-b421-e483233e9d5a + name: Printing & Stationery + value: 24.58 + items: [] + - accountId: dae8e236-24bb-4a7a-9787-c5fd89385e03 + name: Rent + value: 984.38 + items: [] + - accountId: a40f43e2-c7b0-4187-919a-04ccdc14a630 + name: Subscriptions + value: 14.9 + items: [] + - accountId: f3c73c3d-9887-4377-b18b-0374ab62e4aa + name: Telephone & Internet + value: 45.11 + items: [] + - accountId: c7b73345-7f25-428a-bb97-7b20a1470a53 + name: Travel - National + value: 201.67 + items: [] + netOperatingProfit: 11769.59 + otherExpenses: + name: Other Expenses + value: 0 + items: [] + otherIncome: + name: Other Income + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 11769.59 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2023-03-01T00:00:00' + earliestAvailableMonth: '2021-04-01T00:00:00' + Zoho Books: + value: + reports: + - fromDate: '2022-10-01T00:00:00' + toDate: '2022-10-31T00:00:00' + income: + name: Operating Income + value: 0 + items: + - accountId: '104957000000000394' + name: Discount + value: 0 + items: [] + - accountId: '104957000000000379' + name: General Income + value: 0 + items: [] + - accountId: '104957000000099070' + name: General Income Child Test + value: 0 + items: [] + - accountId: '104957000000000382' + name: Interest Income + value: 0 + items: [] + - accountId: '104957000000000385' + name: Late Fee Income + value: 0 + items: [] + - accountId: '104957000000000503' + name: Other Charges + value: 0 + items: [] + - accountId: '104957000000000376' + name: Sales + value: 0 + items: [] + - accountId: '104957000000000506' + name: Shipping Charge + value: 0 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 0 + items: + - accountId: '104957000000000509' + name: Cost of Goods Sold + value: 0 + items: [] + grossProfit: 0 + expenses: + name: Operating Expense + value: 0 + items: + - accountId: '104957000000000391' + name: Advertising And Marketing + value: 0 + items: [] + - accountId: '104957000000000406' + name: Air Travel Expense + value: 0 + items: [] + - accountId: '104957000000000412' + name: Automobile Expense + value: 0 + items: [] + - accountId: '104957000000000427' + name: Bad Debt + value: 0 + items: [] + - accountId: '104957000000000397' + name: Bank Fees and Charges + value: 0 + items: [] + - accountId: '104957000000000442' + name: Consultant Expense + value: 0 + items: [] + - accountId: '104957000000000400' + name: Credit Card Charges + value: 0 + items: [] + - accountId: '104957000000000439' + name: Depreciation Expense + value: 0 + items: [] + - accountId: '104957000000243027' + name: Fuel/Mileage Expenses + value: 0 + items: [] + - accountId: '104957000000000415' + name: IT and Internet Expenses + value: 0 + items: [] + - accountId: '104957000000000421' + name: Janitorial Expense + value: 0 + items: [] + - accountId: '104957000000000454' + name: Lodging + value: 0 + items: [] + - accountId: '104957000000000436' + name: Meals and Entertainment + value: 0 + items: [] + - accountId: '104957000000000388' + name: Office Supplies + value: 0 + items: [] + - accountId: '104957000000000448' + name: Other Expenses + value: 0 + items: [] + - accountId: '104957000000000424' + name: Postage + value: 0 + items: [] + - accountId: '104957000000000430' + name: Printing and Stationery + value: 0 + items: [] + - accountId: '104957000000639102' + name: Purchase Discounts + value: 0 + items: [] + - accountId: '104957000000000418' + name: Rent Expense + value: 0 + items: [] + - accountId: '104957000000000445' + name: Repairs and Maintenance + value: 0 + items: [] + - accountId: '104957000000000433' + name: Salaries and Employee Wages + value: 0 + items: [] + - accountId: '104957000000000409' + name: Telephone Expense + value: 0 + items: [] + - accountId: '104957000000000463' + name: Uncategorized + value: 0 + items: [] + netOperatingProfit: 0 + otherExpenses: + name: Non Operating Expense + value: 0 + items: + - accountId: '104957000000000403' + name: Exchange Gain or Loss + value: 0 + items: [] + - accountId: '104957000000099003' + name: Insurance Expenses (Test Other Expense) + value: 0 + items: [] + otherIncome: + name: Non Operating Income + value: 0 + items: + - accountId: '104957000000054032' + name: Flat Rate Profit + value: 0 + items: [] + - accountId: '104957000000099009' + name: Interest Earned (Test Other Income) + value: 0 + items: [] + netOtherIncome: 0 + netProfit: 0 + - fromDate: '2022-09-01T00:00:00' + toDate: '2022-09-30T00:00:00' + income: + name: Operating Income + value: 69 + items: + - accountId: '104957000000000394' + name: Discount + value: 0 + items: [] + - accountId: '104957000000000379' + name: General Income + value: 0 + items: [] + - accountId: '104957000000099070' + name: General Income Child Test + value: 0 + items: [] + - accountId: '104957000000000382' + name: Interest Income + value: 0 + items: [] + - accountId: '104957000000000385' + name: Late Fee Income + value: 0 + items: [] + - accountId: '104957000000000503' + name: Other Charges + value: 0 + items: [] + - accountId: '104957000000000376' + name: Sales + value: 69 + items: [] + - accountId: '104957000000000506' + name: Shipping Charge + value: 0 + items: [] + costOfSales: + name: Cost of Goods Sold + value: 35 + items: + - accountId: '104957000000000509' + name: Cost of Goods Sold + value: 35 + items: [] + grossProfit: 34 + expenses: + name: Operating Expense + value: 69 + items: + - accountId: '104957000000000391' + name: Advertising And Marketing + value: 0 + items: [] + - accountId: '104957000000000406' + name: Air Travel Expense + value: 0 + items: [] + - accountId: '104957000000000412' + name: Automobile Expense + value: 0 + items: [] + - accountId: '104957000000000427' + name: Bad Debt + value: 69 + items: [] + - accountId: '104957000000000397' + name: Bank Fees and Charges + value: 0 + items: [] + - accountId: '104957000000000442' + name: Consultant Expense + value: 0 + items: [] + - accountId: '104957000000000400' + name: Credit Card Charges + value: 0 + items: [] + - accountId: '104957000000000439' + name: Depreciation Expense + value: 0 + items: [] + - accountId: '104957000000243027' + name: Fuel/Mileage Expenses + value: 0 + items: [] + - accountId: '104957000000000415' + name: IT and Internet Expenses + value: 0 + items: [] + - accountId: '104957000000000421' + name: Janitorial Expense + value: 0 + items: [] + - accountId: '104957000000000454' + name: Lodging + value: 0 + items: [] + - accountId: '104957000000000436' + name: Meals and Entertainment + value: 0 + items: [] + - accountId: '104957000000000388' + name: Office Supplies + value: 0 + items: [] + - accountId: '104957000000000448' + name: Other Expenses + value: 0 + items: [] + - accountId: '104957000000000424' + name: Postage + value: 0 + items: [] + - accountId: '104957000000000430' + name: Printing and Stationery + value: 0 + items: [] + - accountId: '104957000000639102' + name: Purchase Discounts + value: 0 + items: [] + - accountId: '104957000000000418' + name: Rent Expense + value: 0 + items: [] + - accountId: '104957000000000445' + name: Repairs and Maintenance + value: 0 + items: [] + - accountId: '104957000000000433' + name: Salaries and Employee Wages + value: 0 + items: [] + - accountId: '104957000000000409' + name: Telephone Expense + value: 0 + items: [] + - accountId: '104957000000000463' + name: Uncategorized + value: 0 + items: [] + netOperatingProfit: -35 + otherExpenses: + name: Non Operating Expense + value: 0 + items: + - accountId: '104957000000000403' + name: Exchange Gain or Loss + value: 0 + items: [] + - accountId: '104957000000099003' + name: Insurance Expenses (Test Other Expense) + value: 0 + items: [] + otherIncome: + name: Non Operating Income + value: 0 + items: + - accountId: '104957000000054032' + name: Flat Rate Profit + value: 0 + items: [] + - accountId: '104957000000099009' + name: Interest Earned (Test Other Income) + value: 0 + items: [] + netOtherIncome: 0 + netProfit: -35 + reportBasis: Accrual + currency: GBP + mostRecentAvailableMonth: '2022-10-01T00:00:00' + earliestAvailableMonth: '2020-11-01T00:00:00' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/data/financials/cashFlowStatement': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - Financial statements + summary: Get cash flow statement + description: Gets the latest cash flow statement for a company. + operationId: get-accounting-cash-flow-statement + x-speakeasy-group: financial-statements.cash-flow + parameters: + - $ref: '#/components/parameters/accountingPeriodLength' + - $ref: '#/components/parameters/accountingPeriodsToCompare' + - $ref: '#/components/parameters/accountingStartMonth' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCashFlowStatement' + examples: + Clear Books: + value: + reports: + - fromDate: '2021-02-01T00:00:00' + toDate: '2021-02-28T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 18377.72 + items: + - accountId: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + name: Accounts Receivable + value: 11417.63 + items: [] + - accountId: 72df89d2-512b-4455-af51-a6b563733842 + name: Income + value: 6960.09 + items: [] + - accountId: 68794a8f-b22d-4520-b97b-025b7cb10f94 + name: Other Income + value: 0 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: 12377.81 + items: + - accountId: 53bf27a7-7497-4c61-9887-dfaad5c6d80a + name: Accounts Payable + value: 7479.21 + items: [] + - accountId: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Cost of Sales + value: 700 + items: [] + - accountId: e6f7e297-59d6-4bd5-9353-478ee9b39685 + name: Expenses + value: 4198.6 + items: [] + - accountId: b5e801e8-8dbc-4390-ac99-3b0fff54a89f + name: Other Expenses + value: 0 + items: [] + - fromDate: '2021-01-01T00:00:00' + toDate: '2021-01-31T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 14508.56 + items: + - accountId: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + name: Accounts Receivable + value: 3055.53 + items: [] + - accountId: 72df89d2-512b-4455-af51-a6b563733842 + name: Income + value: 11453.03 + items: [] + - accountId: 68794a8f-b22d-4520-b97b-025b7cb10f94 + name: Other Income + value: 0 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: 18902.85 + items: + - accountId: 53bf27a7-7497-4c61-9887-dfaad5c6d80a + name: Accounts Payable + value: 9673.66 + items: [] + - accountId: 7403e960-5b72-42ff-abf4-c870ad8910bd + name: Cost of Sales + value: 1250 + items: [] + - accountId: e6f7e297-59d6-4bd5-9353-478ee9b39685 + name: Expenses + value: 7979.19 + items: [] + - accountId: b5e801e8-8dbc-4390-ac99-3b0fff54a89f + name: Other Expenses + value: 0 + items: [] + reportBasis: Cash + reportInput: Direct + currency: GBP + mostRecentAvailableMonth: '2021-02-28T00:00:00' + earliestAvailableMonth: '2019-03-01T00:00:00' + FreshBooks: + value: + reports: + - fromDate: '2023-04-01T00:00:00' + toDate: '2023-04-30T00:00:00' + cashReceipts: + accountId: CashReceipts + name: CashReceipts + value: 0 + items: [] + cashPayments: + accountId: CashPayments + name: CashPayments + value: 0 + items: [] + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + cashReceipts: + accountId: CashReceipts + name: CashReceipts + value: 0 + items: [] + cashPayments: + accountId: CashPayments + name: CashPayments + value: 0 + items: [] + reportBasis: Cash + reportInput: Indirect + currency: GBP + mostRecentAvailableMonth: '2023-04-30T00:00:00' + earliestAvailableMonth: '2021-05-01T00:00:00' + QuickBooks Online Sandbox: + value: + reports: + - fromDate: '2023-04-01T00:00:00' + toDate: '2023-04-30T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 754.59 + items: + - accountId: income + name: Income + value: 729.59 + items: [] + - accountId: accountsReceivable + name: Accounts Receivable + value: 25 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: -987.94 + items: + - accountId: costOfSales + name: Cost of Sales + value: 24.06 + items: [] + - accountId: expenses + name: Expenses + value: -1012 + items: [] + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 1776.25 + items: + - accountId: income + name: Income + value: 1652.12 + items: [] + - accountId: accountsReceivable + name: Accounts Receivable + value: 124.13 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: 2494.43 + items: + - accountId: costOfSales + name: Cost of Sales + value: 2562 + items: [] + - accountId: accountsPayable + name: Accounts Payable + value: 38.02 + items: [] + - accountId: expenses + name: Expenses + value: -105.59 + items: [] + reportBasis: Cash + reportInput: Direct + currency: GBP + mostRecentAvailableMonth: '2023-04-30T00:00:00' + earliestAvailableMonth: '2021-05-01T00:00:00' + QuickBooks Online: + value: + reports: + - fromDate: '2023-01-01T00:00:00' + toDate: '2023-01-31T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 0 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: 4300 + items: + - accountId: expenses + name: Expenses + value: 4300 + items: [] + - fromDate: '2022-12-01T00:00:00' + toDate: '2022-12-31T00:00:00' + cashReceipts: + accountId: cashReceipts + name: Cash Receipts + value: 0 + items: [] + cashPayments: + accountId: cashPayments + name: Cash Payments + value: 10 + items: + - accountId: expenses + name: Expenses + value: 10 + items: [] + reportBasis: Cash + reportInput: Direct + currency: GBP + mostRecentAvailableMonth: '2023-01-31T00:00:00' + earliestAvailableMonth: '2021-02-01T00:00:00' + Xero: + value: + reports: + - fromDate: '2023-03-01T00:00:00' + toDate: '2023-03-31T23:59:59.9999999' + cashReceipts: + accountId: cashReceipt + name: Cash Receipts + value: 0 + items: [] + cashPayments: + accountId: cashPayment + name: Cash Payments + value: 0 + items: [] + - fromDate: '2023-02-01T00:00:00' + toDate: '2023-02-28T23:59:59.9999999' + cashReceipts: + accountId: cashReceipt + name: Cash Receipts + value: 0 + items: [] + cashPayments: + accountId: cashPayment + name: Cash Payments + value: 0 + items: [] + reportBasis: Cash + reportInput: Direct + currency: GBP + mostRecentAvailableMonth: '2023-03-31T00:00:00' + earliestAvailableMonth: '2021-04-01T00:00:00' + Zoho Books: + value: + reports: + - fromDate: '2022-10-01T00:00:00' + toDate: '2022-10-31T00:00:00' + cashReceipts: + accountId: receipts + name: Cash Receipts + value: 0 + items: + - accountId: income + name: Net Income + value: 0 + items: [] + - accountId: '104957000000000352' + name: Accounts Receivable + value: 0 + items: [] + - accountId: '104957000000000358' + name: Advance Tax + value: 0 + items: [] + - accountId: '104957000000618001' + name: Creadit Card - BA Company + value: 0 + items: [] + - accountId: '104957000000183010' + name: Credit Card + value: 0 + items: [] + - accountId: '104957000000000460' + name: Employee Reimbursements + value: 0 + items: [] + - accountId: '104957000000033015' + name: Input VAT + value: 0 + items: [] + - accountId: '104957000000000511' + name: Inventory Asset + value: 0 + items: [] + - accountId: '104957000000033017' + name: Output VAT + value: 0 + items: [] + - accountId: '104957000000032010' + name: Prepaid Expenses + value: 0 + items: [] + - accountId: '104957000000006001' + name: Tag Adjustments + value: 0 + items: [] + - accountId: '104957000000085001' + name: Test stock account + value: 0 + items: [] + - accountId: '104957000000000501' + name: Unearned Revenue + value: 0 + items: [] + cashPayments: + accountId: payments + name: Cash Payments + value: 0 + items: + - accountId: '104957000000000361' + name: Accounts Payable + value: 0 + items: [] + - fromDate: '2022-09-01T00:00:00' + toDate: '2022-09-30T00:00:00' + cashReceipts: + accountId: receipts + name: Cash Receipts + value: -5 + items: + - accountId: income + name: Net Income + value: -35 + items: [] + - accountId: '104957000000000352' + name: Accounts Receivable + value: 30 + items: [] + - accountId: '104957000000000358' + name: Advance Tax + value: 0 + items: [] + - accountId: '104957000000618001' + name: Creadit Card - BA Company + value: 0 + items: [] + - accountId: '104957000000183010' + name: Credit Card + value: 0 + items: [] + - accountId: '104957000000000460' + name: Employee Reimbursements + value: 0 + items: [] + - accountId: '104957000000000511' + name: Inventory Asset + value: 0 + items: [] + - accountId: '104957000000033017' + name: Output VAT + value: 0 + items: [] + - accountId: '104957000000032010' + name: Prepaid Expenses + value: 0 + items: [] + - accountId: '104957000000006001' + name: Tag Adjustments + value: 0 + items: [] + - accountId: '104957000000085001' + name: Test stock account + value: 0 + items: [] + - accountId: '104957000000000501' + name: Unearned Revenue + value: 0 + items: [] + cashPayments: + accountId: payments + name: Cash Payments + value: 7 + items: + - accountId: '104957000000000361' + name: Accounts Payable + value: 0 + items: [] + - accountId: '104957000000033015' + name: Input VAT + value: 7 + items: [] + reportBasis: Accrual + reportInput: Indirect + currency: GBP + mostRecentAvailableMonth: '2022-10-31T00:00:00' + earliestAvailableMonth: '2019-11-01T00:00:00' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/banking-accountBalances': + get: + tags: + - Bank statements + summary: List account balances + operationId: list-banking-account-balances + x-speakeasy-group: banking.account-balances + description: "The *List account balances* endpoint returns a list of [account balances](https://docs.codat.io/lending-api#/schemas/AccountBalance) for a given company's connection.\n\n[Account balances](https://docs.codat.io/lending-api#/schemas/AccountBalance) are balances for a bank account, including end-of-day batch balance or running balances per transaction.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingAccountBalances' + examples: + Basiq: + value: + results: + - accountId: 4811e776-6187-48d9-afee-635fb0d89d93 + balance: + current: 11389.85 + date: '2017-12-31T00:00:00Z' + modifiedDate: '2022-10-28T07:15:07Z' + - accountId: 4811e776-6187-48d9-afee-635fb0d89d93 + balance: + current: 8002.09 + date: '2018-01-01T00:00:00Z' + modifiedDate: '2022-10-28T07:15:07Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3103 + _links: + current: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accountBalances?page=1&pageSize=2 + self: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accountBalances + next: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accountBalances?page=2&pageSize=2 + Plaid: + value: + results: + - accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + balance: + current: 205.78 + date: '2022-10-13T00:00:00' + modifiedDate: '2022-10-27T10:50:16Z' + - accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + balance: + current: 205.78 + date: '2022-10-14T00:00:00' + modifiedDate: '2022-10-27T10:50:16Z' + pageNumber: 1 + pageSize: 2 + totalResults: 14 + _links: + current: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accountBalances?page=1&pageSize=2 + self: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accountBalances + next: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accountBalances?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/banking-accounts': + get: + tags: + - Bank statements + summary: List accounts + operationId: list-banking-accounts + x-speakeasy-group: banking.accounts + description: "The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/lending-api#/schemas/Account) for a given company's connection.\n\n[Accounts](https://docs.codat.io/lending-api#/schemas/Account) 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/lending-api#/operations/refresh-company-data).\n " + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingAccounts' + examples: + Basiq: + value: + results: + - id: 4811e776-6187-48d9-afee-635fb0d89d93 + name: Hooli Saver + holder: david smith + type: Debit + balance: + available: 2932.85 + current: 2932.85 + identifiers: + type: Account + number: '14293919644182' + bankCode: 416-982 + currency: AUD + institution: + id: AU00000 + name: Hooli Bank + modifiedDate: '2022-10-28T07:14:48Z' + sourceModifiedDate: '2022-10-27T13:00:00Z' + accountName: Hooli Saver + accountHolder: david smith + accountType: Debit + accountNumbers: + type: Account + number: '14293919644182' + bankCode: 416-982 + - id: 736d90a5-f836-4ae0-a161-1e8056f39701 + name: Standard Variable Rate Home Loan + holder: david smith + type: Credit + balance: + available: 6940.31 + current: 6940.31 + identifiers: + type: Loan + number: '14293919644183' + bankCode: 416-982 + currency: AUD + institution: + id: AU00000 + name: Hooli Bank + modifiedDate: '2022-10-28T07:14:48Z' + sourceModifiedDate: '2022-10-27T13:00:00Z' + accountName: Standard Variable Rate Home Loan + accountHolder: david smith + accountType: Credit + accountNumbers: + type: Loan + number: '14293919644183' + bankCode: 416-982 + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accounts?page=1&pageSize=2 + self: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accounts + next: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-accounts?page=2&pageSize=2 + Plaid: + value: + results: + - id: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + name: Plaid Silver Standard 0.1% Interest Saving + informalName: Plaid Saving + type: Debit + balance: + available: 200 + current: 210 + identifiers: + type: Depository + number: '1111222233331111' + bankCode: '00021' + maskedAccountNumber: '1111' + currency: CAD + institution: + id: ins_100533 + name: American Express (CA) + modifiedDate: '2022-10-27T10:50:16Z' + accountName: Plaid Silver Standard 0.1% Interest Saving + accountType: Debit + accountNumbers: + type: Depository + number: '1111222233331111' + bankCode: '00021' + maskedAccountNumber: '1111' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accounts?page=1&pageSize=2 + self: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-accounts + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/banking-accounts/{accountId}': + get: + tags: + - Bank statements + summary: Get account + operationId: get-banking-account + x-speakeasy-group: banking.accounts + description: |- + The *Get account* endpoint returns a single account for a given accountId. + + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) 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/lending-api#/operations/refresh-company-data). + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingAccountId' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingAccount' + examples: + Basiq: + value: + id: 4811e776-6187-48d9-afee-635fb0d89d93 + name: Hooli Saver + holder: david smith + type: Debit + balance: + available: 2932.85 + current: 2932.85 + identifiers: + type: Account + number: '14293919644182' + bankCode: 416-982 + currency: AUD + institution: + id: AU00000 + name: Hooli Bank + modifiedDate: '2022-10-28T07:14:48Z' + sourceModifiedDate: '2022-10-27T13:00:00Z' + accountName: Hooli Saver + accountHolder: david smith + accountType: Debit + accountNumbers: + type: Account + number: '14293919644182' + bankCode: 416-982 + Plaid: + value: + id: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + name: Plaid Silver Standard 0.1% Interest Saving + informalName: Plaid Saving + type: Debit + balance: + available: 200 + current: 210 + identifiers: + type: Depository + number: '1111222233331111' + bankCode: '00021' + maskedAccountNumber: '1111' + currency: CAD + institution: + id: ins_100533 + name: American Express (CA) + modifiedDate: '2022-10-27T10:50:16Z' + accountName: Plaid Silver Standard 0.1% Interest Saving + accountType: Debit + accountNumbers: + type: Depository + number: '1111222233331111' + bankCode: '00021' + maskedAccountNumber: '1111' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/banking-transactions': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Bank statements + operationId: list-banking-transactions + x-speakeasy-group: banking.transactions + summary: List transactions + description: "The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/lending-api#/schemas/Transaction) for a given company's connection.\n\n[Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + x-speakeasy-usage-example: true + schema: + $ref: '#/components/schemas/BankingTransactions' + examples: + Basiq: + value: + results: + - id: 00017a94-c681-448d-ba8d-585a81b4128f + accountId: feb76128-7650-4b02-a323-e1606146be0c + description: 'RENTALCARTOLLPH131865 PARRAMATTA AU Card xx0399 Value Date: 25/07/2019' + amount: -14.26 + currency: AUD + postedDate: '2019-07-31T00:00:00Z' + code: Unknown + merchantName: '' + transactionCategoryRef: + id: payment + name: Payment + modifiedDate: '2022-10-28T07:15:10Z' + - id: 0023c431-35c8-41f5-b75e-9239413cde7e + accountId: 4811e776-6187-48d9-afee-635fb0d89d93 + description: Transfer from xx9263 CommBank app Shop + amount: 191 + currency: AUD + postedDate: '2018-07-31T00:00:00Z' + code: Unknown + merchantName: '' + transactionCategoryRef: + id: transfer + name: Transfer + modifiedDate: '2022-10-28T07:15:10Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3319 + _links: + current: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactions?page=1&pageSize=2 + self: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactions + next: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactions?page=2&pageSize=2 + Plaid: + value: + results: + - id: 1514wvMMajumgG7xWA1Bt8o15xP5k3fmeo9Bg_EC6E0DC820E1F9D1A2300BF4A5B80513 + accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + description: CREDIT CARD 3333 PAYMENT *// + amount: -25 + currency: CAD + postedDate: '2021-05-10T00:00:00' + authorizedDate: '2021-05-09T00:00:00' + code: Unknown + transactionCategoryRef: + id: TRANSFER_OUT.TRANSFER_OUT_ACCOUNT_TRANSFER + name: TRANSFER_OUT_ACCOUNT_TRANSFER + modifiedDate: '2022-10-27T10:50:25Z' + - id: 1514wvMMajumgG7xWA1Bt8oDLxlpm3i3zraD7_6DB63D1DACF6F5824C80F8BE2E066DB5 + accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + description: CREDIT CARD 3333 PAYMENT *// + amount: -25 + currency: CAD + postedDate: '2022-10-02T00:00:00' + authorizedDate: '2022-10-01T00:00:00' + code: Unknown + transactionCategoryRef: + id: TRANSFER_OUT.TRANSFER_OUT_ACCOUNT_TRANSFER + name: TRANSFER_OUT_ACCOUNT_TRANSFER + modifiedDate: '2022-10-27T10:50:25Z' + pageNumber: 1 + pageSize: 2 + totalResults: 49 + _links: + current: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactions?page=1&pageSize=2 + self: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactions + next: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactions?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/banking-transactions/{transactionId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - schema: + type: string + name: transactionId + in: path + required: true + description: The unique identifier for a transaction + get: + summary: Get bank transaction + tags: + - Bank statements + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingTransaction' + examples: + Basiq: + value: + id: 00017a94-c681-448d-ba8d-585a81b4128f + accountId: feb76128-7650-4b02-a323-e1606146be0c + description: 'RENTALCARTOLLPH131865 PARRAMATTA AU Card xx0399 Value Date: 25/07/2019' + amount: -14.26 + currency: AUD + postedDate: '2019-07-31T00:00:00Z' + code: Unknown + merchantName: '' + transactionCategoryRef: + id: payment + name: Payment + modifiedDate: '2022-10-28T07:15:10Z' + Plaid: + value: + id: 1514wvMMajumgG7xWA1Bt8o15xP5k3fmeo9Bg_EC6E0DC820E1F9D1A2300BF4A5B80513 + accountId: 3opGv6XXNeHPEgNVbQpyCr8MAKQ3noC8Qz1zB + description: CREDIT CARD 3333 PAYMENT *// + amount: -25 + currency: CAD + postedDate: '2021-05-10T00:00:00' + authorizedDate: '2021-05-09T00:00:00' + code: Unknown + transactionCategoryRef: + id: TRANSFER_OUT.TRANSFER_OUT_ACCOUNT_TRANSFER + name: TRANSFER_OUT_ACCOUNT_TRANSFER + modifiedDate: '2022-10-27T10:50:25Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get transaction* endpoint returns a single transaction for a given transactionId. + + [Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) provide an immutable source of up-to-date information on income and expenditure. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + operationId: get-banking-transaction + x-speakeasy-group: banking.transactions + '/companies/{companyId}/connections/{connectionId}/data/banking-transactionCategories': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Bank statements + operationId: list-banking-transaction-categories + x-speakeasy-group: banking.transaction-categories + summary: List transaction categories + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingTransactionCategories' + examples: + Basiq: + value: + results: + - id: bank-fee + name: Bank Fee + hasChildren: false + status: Active + modifiedDate: '2022-10-28T07:14:46' + - id: cash-withdrawal + name: Cash Withdrawal + hasChildren: false + status: Active + modifiedDate: '2022-10-28T07:14:46' + pageNumber: 1 + pageSize: 2 + totalResults: 9 + _links: + current: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactionCategories?page=1&pageSize=2 + self: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactionCategories + next: + href: /companies/17129e41-5389-4f10-ac06-e0a37e47d177/connections/b4703906-e631-46f1-9acc-7e237acdc64d/data/banking-transactionCategories?page=2&pageSize=2 + Plaid: + value: + results: + - id: BANK_FEES + name: BANK_FEES + hasChildren: true + status: Active + modifiedDate: '2022-10-27T10:50:17' + - id: BANK_FEES.BANK_FEES_ATM_FEES + name: BANK_FEES_ATM_FEES + parentId: BANK_FEES + hasChildren: false + status: Active + modifiedDate: '2022-10-27T10:50:17' + pageNumber: 1 + pageSize: 2 + totalResults: 120 + _links: + current: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactionCategories?page=1&pageSize=2 + self: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactionCategories + next: + href: /companies/efc2d985-cdb3-4724-8be3-c7310f7ead6c/connections/6c44dc44-e1b1-4578-800f-0bdefb658db7/data/banking-transactionCategories?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List transaction categories* endpoint returns a list of [transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) for a given company's connection.\n\n[Transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + '/companies/{companyId}/connections/{connectionId}/data/banking-transactionCategories/{transactionCategoryId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - schema: + type: string + name: transactionCategoryId + in: path + required: true + description: The unique identifier for a banking transaction category + get: + tags: + - Bank statements + operationId: get-banking-transaction-category + x-speakeasy-group: banking.transaction-categories + summary: Get transaction category + description: | + The *Get transaction category* endpoint returns a single transaction category for a given transactionCategoryId. + + [Transaction categories](https://docs.codat.io/lending-api#/schemas/TransactionCategory) are associated with a transaction to provide greater contextual meaning to transaction activity. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankingTransactionCategory' + examples: + Basiq: + value: + id: bank-fee + name: Bank Fee + hasChildren: false + status: Active + modifiedDate: '2022-10-28T07:14:46' + Plaid: + value: + id: BANK_FEES + name: BANK_FEES + hasChildren: true + status: Active + modifiedDate: '2022-10-27T10:50:17' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/commerce-customers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Sales + summary: List customers + operationId: list-commerce-customers + x-speakeasy-group: sales.customers + description: "The *List customers* endpoint returns a list of [customers](https://docs.codat.io/lending-api#/schemas/Customer) for a given company's connection.\n\n[Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that place orders, make payments and recieve goods and/or services from the SMB.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + parameters: + - $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/CommerceCustomers' + examples: + BigCommerce: + value: + results: + - id: '1' + customerName: Amy Jones + emailAddress: a.jackson@email.me + defaultCurrency: XXX + phone: 07770 666777 + addresses: + - type: Unknown + line1: My Billing Address ./*drop table + city: Portsmouth + region: '' + country: United Kingdom + postalCode: PS13HJ + - type: Unknown + line1: 'This is my address, I cant hit enter.' + city: Portsmouth + region: '' + country: United Kingdom + postalCode: PS13HJ + createdDate: '2022-06-15T15:54:15Z' + modifiedDate: '2023-04-11T10:33:49Z' + sourceModifiedDate: '2022-06-15T15:54:15Z' + - id: '2' + customerName: Cust001 Cust001 + emailAddress: Cust001@example.com + defaultCurrency: XXX + phone: 05442 203941 + addresses: [] + createdDate: '2023-04-11T15:49:25Z' + modifiedDate: '2023-04-17T15:42:55Z' + sourceModifiedDate: '2023-04-11T15:49:25Z' + pageNumber: 1 + pageSize: 2 + totalResults: 201 + _links: + current: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-customers + next: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-customers?page=2&pageSize=2 + Clover: + value: + results: + - id: 2CBJ8R898ZJAR + customerName: '' + addresses: [] + createdDate: '2021-09-22T13:10:12Z' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '0001-01-01T00:00:00' + - id: 511JV0FRN2QYC + customerName: '' + addresses: [] + createdDate: '2021-09-21T14:54:38Z' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '0001-01-01T00:00:00' + pageNumber: 1 + pageSize: 2 + totalResults: 9 + _links: + current: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-customers + next: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-customers?page=2&pageSize=2 + Mollie: + value: + results: + - id: cst_NUkBHQmekz + customerName: Frod Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:41:54' + modifiedDate: '2022-03-17T15:47:28Z' + - id: cst_BvBxwuwfvH + customerName: Frodo Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:42:05' + modifiedDate: '2022-03-17T15:47:28Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-customers + next: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-customers?page=2&pageSize=2 + Mollie Test: + value: + results: + - id: cst_NUkBHQmekz + customerName: Frod Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:41:54' + modifiedDate: '2022-08-17T11:33:19Z' + - id: cst_BvBxwuwfvH + customerName: Frodo Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:42:05' + modifiedDate: '2022-08-17T11:33:19Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-customers + next: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-customers?page=2&pageSize=2 + PrestaShop: + value: + results: + - id: '2' + customerName: Bob Smith + emailAddress: bob.smith@example.com + addresses: + - type: Unknown + line1: 1 test street + city: City Test + region: Virginia + country: US + postalCode: '55678' + createdDate: '2021-09-02T07:54:26' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T07:54:26' + - id: '3' + customerName: Fake Name + emailAddress: bob@bob.com + addresses: [] + createdDate: '2021-09-03T01:55:13' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-03T01:55:13' + pageNumber: 1 + pageSize: 2 + totalResults: 5 + _links: + current: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-customers + next: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-customers?page=2&pageSize=2 + Shopify: + value: + results: + - id: '5839032287390' + customerName: AL A + emailAddress: a.macra@codat.io + addresses: + - type: Unknown + line1: '301 Ink Rooms, 28 Easton St, Farringdon' + line2: '28 Easton St, Farringdon' + city: London + region: England + country: United Kingdom + postalCode: WC1X 0BE + createdDate: '2021-11-18T15:24:03' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2021-11-18T15:24:03' + - id: '5097398534302' + customerName: Qa Test + phone: '+445593368390' + addresses: + - type: Unknown + line1: Look Street + city: London + postalCode: PO16 7GZ + - type: Unknown + line1: Look Street + city: London + region: England + country: United Kingdom + postalCode: PO16 7GZ + note: '' + createdDate: '2021-03-19T10:12:37' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2022-08-01T13:07:59' + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-customers + next: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-customers?page=2&pageSize=2 + Square: + value: + results: + - id: FT9948H3VD6GF8MPDD5438KY1M + emailAddress: fake@name.com + phone: '+441234567890' + addresses: + - type: Unknown + line1: 1 Main Street + line2: Flat 20 + city: London + region: London + postalCode: W1A 1AA + createdDate: '2021-03-08T11:21:11Z' + modifiedDate: '2022-08-02T10:27:32Z' + sourceModifiedDate: '2021-03-08T11:21:11Z' + - id: GXQDPSZSMN6C58270SZN4YJZ8R + emailAddress: s.shandil+square@codat.io + phone: '+447729946295' + addresses: [] + createdDate: '2020-11-19T14:56:00Z' + modifiedDate: '2022-08-02T10:27:32Z' + sourceModifiedDate: '2020-11-19T14:56:00Z' + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-customers + Stripe Test: + value: + results: + - id: cus_LXdjls7KY5ZHaz + customerName: Barry Smith + emailAddress: barry@example.com + defaultCurrency: gbp + addresses: [] + note: Test Subscription + createdDate: '2022-04-20T07:59:52Z' + modifiedDate: '2022-09-30T11:18:27Z' + - id: cus_LXdFFgHqqVURIv + customerName: David Dunlow + emailAddress: david@example.com + defaultCurrency: gbp + phone: '+447545309714' + addresses: + - type: Billing + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + country: GB + postalCode: WC1X 0BE + - type: Delivery + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + country: GB + postalCode: WC1X 0BE + note: Test Subscriptions + createdDate: '2022-04-20T07:30:01Z' + modifiedDate: '2022-09-30T11:18:27Z' + pageNumber: 1 + pageSize: 2 + totalResults: 14 + _links: + current: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-customers + next: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-customers?page=2&pageSize=2 + WooCommerce: + value: + results: + - id: '201694267' + customerName: Qa Test + emailAddress: a.macra@codat.io + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + createdDate: '2021-03-11T09:04:27' + modifiedDate: '2021-07-13T16:19:00Z' + sourceModifiedDate: '2021-03-11T09:07:00' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-customers + Zettle: + value: + results: + - id: firstname.lastname@example.com + customerName: Firstname Lastname + emailAddress: firstname.lastname@example.com + addresses: + - type: Unknown + line1: Line1 + city: City + country: GB + postalCode: TT1 1TT + createdDate: '2021-01-07T16:17:34' + modifiedDate: '2021-01-27T13:08:51Z' + sourceModifiedDate: '2021-01-08T09:57:56' + - id: joe@bloggs.com + customerName: Joe Bloggs + emailAddress: joe@bloggs.com + phone: 02012 345678 + addresses: + - type: Unknown + line1: Flat 1 + line2: 1 High Street + city: London + region: London + country: GB + - type: Unknown + line1: Flat 2 + line2: 2 High Street + city: London + region: London + country: GB + createdDate: '2020-12-21T14:52:15' + modifiedDate: '2021-01-27T13:08:51Z' + sourceModifiedDate: '2020-12-21T14:52:15' + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/fe8e3158-47e6-4367-9537-7d5001295500/connections/d60b15e7-7db9-459b-92a0-9557f7ebdeea/data/commerce-customers?page=1&pageSize=2 + self: + href: /companies/fe8e3158-47e6-4367-9537-7d5001295500/connections/d60b15e7-7db9-459b-92a0-9557f7ebdeea/data/commerce-customers + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/commerce-customers/{customerId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/customerId' + get: + tags: + - Sales + summary: Get customer + operationId: get-commerce-customer + x-speakeasy-group: sales.customers + description: | + The *Get customer* endpoint returns a single customer for a given customerId. + + [Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that place orders, make payments and receive goods and/or services from the SMB. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceCustomer' + examples: + BigCommerce: + value: + id: '1' + customerName: Amy Jones + emailAddress: a.durbanjackson+amy@codat.io + defaultCurrency: XXX + phone: '07770666777' + addresses: + - type: Unknown + line1: My Billing Address ./*drop table + city: Portsmouth + region: '' + country: United Kingdom + postalCode: PS13HJ + - type: Unknown + line1: 'This is my address, I cant hit enter.' + city: Portsmouth + region: '' + country: United Kingdom + postalCode: PS13HJ + createdDate: '2022-06-15T15:54:15Z' + modifiedDate: '2023-04-11T10:33:49Z' + sourceModifiedDate: '2022-06-15T15:54:15Z' + Clover: + value: + id: 2CBJ8R898ZJAR + customerName: '' + addresses: [] + createdDate: '2021-09-22T13:10:12Z' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '0001-01-01T00:00:00' + Mollie: + value: + id: cst_NUkBHQmekz + customerName: Frod Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:41:54' + modifiedDate: '2022-03-17T15:47:28Z' + Mollie Test: + value: + id: cst_NUkBHQmekz + customerName: Frod Baggins + emailAddress: frodo.baggings@theshire.com + addresses: [] + createdDate: '2022-01-18T11:41:54' + modifiedDate: '2022-08-17T11:33:19Z' + PrestaShop: + value: + id: '2' + customerName: Bob Smith + emailAddress: bob.smith@example.com + addresses: + - type: Unknown + line1: 1 test street + city: City Test + region: Virginia + country: US + postalCode: '55678' + createdDate: '2021-09-02T07:54:26' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T07:54:26' + Shopify: + value: + id: '5839032287390' + customerName: AL A + emailAddress: a.macra@codat.io + addresses: + - type: Unknown + line1: '301 Ink Rooms, 28 Easton St, Farringdon' + line2: '28 Easton St, Farringdon' + city: London + region: England + country: United Kingdom + postalCode: WC1X 0BE + createdDate: '2021-11-18T15:24:03' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2021-11-18T15:24:03' + Square: + value: + id: FT9948H3VD6GF8MPDD5438KY1M + emailAddress: fake@name.com + phone: '+441234567890' + addresses: + - type: Unknown + line1: 1 Main Street + line2: Flat 20 + city: London + region: London + postalCode: W1A 1AA + createdDate: '2021-03-08T11:21:11Z' + modifiedDate: '2022-08-02T10:27:32Z' + sourceModifiedDate: '2021-03-08T11:21:11Z' + Stripe Test: + value: + id: cus_LXdjls7KY5ZHaz + customerName: Barry Smith + emailAddress: barry@example.com + defaultCurrency: gbp + addresses: [] + note: Test Subscription + createdDate: '2022-04-20T07:59:52Z' + modifiedDate: '2022-09-30T11:18:27Z' + WooCommerce: + value: + id: '201694267' + customerName: Qa Test + emailAddress: a.macra@codat.io + phone: '' + addresses: + - type: Billing + line1: '' + line2: '' + city: '' + region: '' + country: '' + postalCode: '' + createdDate: '2021-03-11T09:04:27' + modifiedDate: '2021-07-13T16:19:00Z' + sourceModifiedDate: '2021-03-11T09:07:00' + Zettle: + value: + id: firstname.lastname@example.com + customerName: Firstname Lastname + emailAddress: firstname.lastname@example.com + addresses: + - type: Unknown + line1: Line1 + city: City + country: GB + postalCode: TT1 1TT + createdDate: '2021-01-07T16:17:34' + modifiedDate: '2021-01-27T13:08:51Z' + sourceModifiedDate: '2021-01-08T09:57:56' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/data/commerce-disputes': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List disputes + tags: + - Sales + operationId: list-commerce-disputes + x-speakeasy-group: sales.disputes + parameters: + - $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/CommerceDisputes' + examples: + Shopify: + value: + results: + - id: '8502411422' + disputedTransactions: + - id: '3684116791454' + type: Order + totalAmount: 175 + currency: GBP + status: Processing + reason: fraudulent + dueDate: '2021-03-28T00:00:00' + createdDate: '2021-03-19T13:16:27' + modifiedDate: '2023-02-10T15:18:22Z' + sourceModifiedDate: '2021-03-28T11:00:17' + - id: '8502444190' + disputedTransactions: + - id: '3684119445662' + type: Order + totalAmount: 600 + currency: GBP + status: Processing + reason: fraudulent + dueDate: '2021-03-28T00:00:00' + createdDate: '2021-03-19T13:18:31' + modifiedDate: '2023-02-10T15:18:22Z' + sourceModifiedDate: '2021-03-28T11:00:18' + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-disputes?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-disputes + Stripe Test: + value: + results: + - id: dp_1Hqhl8A8m8S1Gh7OJrvF3gsK + disputedTransactions: + - id: txn_1Hqhl8A8m8S1Gh7OtmAPNr9e + type: Payment + totalAmount: 25 + currency: GBP + status: Processing + reason: fraudulent + dueDate: '2020-12-02T23:59:59Z' + createdDate: '2020-11-23T16:19:22Z' + modifiedDate: '2022-09-30T11:18:27Z' + - id: dp_1HqiwVA8m8S1Gh7OpS3ozlcd + disputedTransactions: + - id: txn_1HqiwVA8m8S1Gh7O0IVelTQ5 + type: Payment + totalAmount: 55 + currency: GBP + status: Lost + reason: product_not_received + dueDate: '2020-12-02T23:59:59Z' + createdDate: '2020-11-23T17:35:11Z' + modifiedDate: '2022-09-30T11:18:27Z' + pageNumber: 1 + pageSize: 2 + totalResults: 5 + _links: + current: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-disputes?page=1&pageSize=2 + self: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-disputes + next: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-disputes?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List disputes* endpoint returns a list of [disputes](https://docs.codat.io/lending-api#/schemas/Dispute) for a given company's connection.\n\n[Disputes](https://docs.codat.io/lending-api#/schemas/Dispute) are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + '/companies/{companyId}/connections/{connectionId}/data/commerce-disputes/{disputeId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: disputeId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a dispute. + get: + summary: Get dispute + tags: + - Sales + operationId: get-commerce-dispute + x-speakeasy-group: sales.disputes + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceDispute' + examples: + Shopify: + value: + id: '8502411422' + disputedTransactions: + - id: '3684116791454' + type: Order + totalAmount: 175 + currency: GBP + status: Processing + reason: fraudulent + dueDate: '2021-03-28T00:00:00' + createdDate: '2021-03-19T13:16:27' + modifiedDate: '2023-02-10T15:18:22Z' + sourceModifiedDate: '2021-03-28T11:00:17' + Stripe Test: + value: + id: dp_1Hqhl8A8m8S1Gh7OJrvF3gsK + disputedTransactions: + - id: txn_1Hqhl8A8m8S1Gh7OtmAPNr9e + type: Payment + totalAmount: 25 + currency: GBP + status: Processing + reason: fraudulent + dueDate: '2020-12-02T23:59:59Z' + createdDate: '2020-11-23T16:19:22Z' + modifiedDate: '2022-09-30T11:18:27Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get dispute* endpoint returns a single dispute for a given disputeId. + + [Disputes](https://docs.codat.io/lending-api#/schemas/Dispute) are created when a customer is unsatisfied with their purchase or believe they have been charged incorrectly. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-info': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get company commerce profile + tags: + - Company info + operationId: get-commerce-profile + x-speakeasy-name-override: get-commerce-profile + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceCompanyInfo' + examples: + Example 1: + value: + companyName: Codat + companyLegalName: Codat Ltd + addresses: + - type: Billing + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + region: England + country: United Kingdom + postalCode: WC1X 0BE + - type: Delivery + line1: 28 Easton Street + city: London + country: UK + postalCode: WC1X 0BE + phoneNumbers: + - number: 02012 345678 + type: Landline + - number: 07123 456789 + type: Mobile + - number: 02012 345678 + type: Fax + webLinks: + - type: Website + url: 'https://www.codat.io/' + - type: Social + url: 'https://www.linkedin.com/company/codat-limited/' + registrationNumber: '5590111724' + baseCurrency: GBP + accountBalances: + - available: 20053.23 + pending: 2034.23 + reserved: 517.23 + currency: GBP + sourceUrls: + Api: 'https://api.codat.io' + createdDate: '2019-03-07T16:50:49' + modifiedDate: '2022-03-10T15:42:13' + sourceModifiedDate: '2021-06-10T01:48:49' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + Retrieve information about the company, as seen in the commerce + platform. + + This may include information like addresses, tax registration details and + social media or website information." + '/companies/{companyId}/connections/{connectionId}/data/commerce-locations': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List locations + tags: + - Sales + operationId: list-commerce-locations + x-speakeasy-group: sales.locations + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceLocations' + examples: + Clover: + value: + results: + - id: GA3WP1ZC3ZFK1 + name: Codat + address: + type: Inventory + line1: '301 Ink Rooms, 28 Easton Street' + city: London + region: London + country: GB + postalCode: WC1X 0BE + modifiedDate: '2023-01-09T11:01:03Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-locations?page=1&pageSize=2 + self: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-locations + Lightspeed K Trial: + value: + results: + - id: '647208621834538' + name: QA Shared - New Test Site + address: + type: Unknown + country: AU + modifiedDate: '2023-03-02T09:48:48Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-locations?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-locations + Shopify: + value: + results: + - id: '61375348894' + name: '301 Ink Rooms, 28 Easton St' + address: + type: Inventory + line1: '301 Ink Rooms, 28 Easton St' + city: London + region: London + country: GB + postalCode: WC1X 0BE + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2021-03-19T10:06:06' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-locations?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-locations + Square: + value: + results: + - id: D8DVHD1G6NT2J + name: Codat Limited + address: + type: Inventory + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + country: GB + postalCode: WC1X0BE + modifiedDate: '2022-08-02T10:27:32Z' + sourceModifiedDate: '2020-01-17T14:07:30Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-locations?page=1&pageSize=2 + self: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-locations + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List locations* endpoint returns a list of [locations](https://docs.codat.io/lending-api#/schemas/Location) for a given company's connection.\n\n[Locations](https://docs.codat.io/lending-api#/schemas/Location) hold information on the geographic location at which stocks of [products](https://docs.codat.io/lending-api#/schemas/Product) may be held or where [orders](https://docs.codat.io/lending-api#/schemas/Order) were placed.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + '/companies/{companyId}/connections/{connectionId}/data/commerce-locations/{locationId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: locationId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a location. + get: + summary: Get location + tags: + - Sales + operationId: get-commerce-location + x-speakeasy-group: sales.locations + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceLocation' + examples: + Clover: + value: + id: GA3WP1ZC3ZFK1 + name: Codat + address: + type: Inventory + line1: '301 Ink Rooms, 28 Easton Street' + city: London + region: London + country: GB + postalCode: WC1X 0BE + modifiedDate: '2023-01-09T11:01:03Z' + Lightspeed K Trial: + value: + id: '647208621834538' + name: QA Shared - New Test Site + address: + type: Unknown + country: AU + modifiedDate: '2023-03-02T09:48:48Z' + Shopify: + value: + id: '61375348894' + name: '301 Ink Rooms, 28 Easton St' + address: + type: Inventory + line1: '301 Ink Rooms, 28 Easton St' + city: London + region: London + country: GB + postalCode: WC1X 0BE + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2021-03-19T10:06:06' + Square: + value: + id: D8DVHD1G6NT2J + name: Codat Limited + address: + type: Inventory + line1: 301 Ink Rooms + line2: 28 Easton Street + city: London + country: GB + postalCode: WC1X0BE + modifiedDate: '2022-08-02T10:27:32Z' + sourceModifiedDate: '2020-01-17T14:07:30Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get location* endpoint returns a single location for a given locationId. + + [Locations](https://docs.codat.io/lending-api#/schemas/Location) hold information on the geographic location at which stocks of [products](https://docs.codat.io/lending-api#/schemas/Product) may be held or where [orders](https://docs.codat.io/lending-api#/schemas/Order) were placed. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-orders': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List orders + tags: + - Sales + operationId: list-commerce-orders + x-speakeasy-group: sales.orders + responses: + '200': + description: OK + content: + application/json: + x-speakeasy-usage-example: true + schema: + $ref: '#/components/schemas/CommerceOrders' + examples: + Amazon Seller Central: + value: + results: + - id: 902-1845936-5435065 + orderNumber: 902-1845936-5435065 + country: 'US ' + currency: USD + createdDate: '1970-01-19T03:58:30Z' + totalAmount: 10 + totalRefund: 0 + totalTaxAmount: 1.01 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: O05015851154158 + quantity: 1 + taxPercentage: 11.23 + totalAmount: 10 + totalTaxAmount: 1.01 + unitPrice: 8.99 + taxes: [] + productVariantRef: + id: NABetaASINB00551Q3CS + discountAllocations: [] + payments: [] + serviceCharges: [] + modifiedDate: '2023-01-09T09:12:12Z' + sourceModifiedDate: '1970-01-19T03:58:32Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-orders + BigCommerce: + value: + results: + - id: '100' + orderNumber: '100' + country: GBR + currency: GBP + createdDate: '2022-06-15T15:48:18Z' + totalAmount: 675 + totalRefund: 0 + totalTaxAmount: 112.5 + totalDiscount: 10 + totalGratuity: 0 + orderLineItems: + - id: '1' + quantity: 1 + taxPercentage: 20 + totalAmount: 221.64 + totalTaxAmount: 36.94 + unitPrice: 187.5 + taxes: [] + productRef: + id: '86' + name: '[Sample] Able Brewing System' + productVariantRef: + id: '66' + name: '[Sample] Able Brewing System' + discountAllocations: + - name: Manual Discount + totalAmount: 3.36 + - id: '2' + quantity: 5 + taxPercentage: 19.9999 + totalAmount: 438.36 + totalTaxAmount: 73.06 + unitPrice: 74.1667 + taxes: [] + productRef: + id: '81' + name: '[Sample] Orbit Terrarium - Small' + productVariantRef: + id: '65' + name: '[Sample] Orbit Terrarium - Small' + discountAllocations: + - name: Manual Discount + totalAmount: 6.64 + payments: [] + serviceCharges: + - description: Shipping Charge + totalAmount: 15 + taxPercentage: 20 + taxAmount: 2.5 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '0' + modifiedDate: '2023-04-11T10:33:56Z' + sourceModifiedDate: '2022-06-15T15:48:18Z' + - id: '101' + orderNumber: '101' + country: GBR + currency: GBP + createdDate: '2022-06-15T15:49:02Z' + totalAmount: 675 + totalRefund: 0 + totalTaxAmount: 112.5 + totalDiscount: 10 + totalGratuity: 0 + orderLineItems: + - id: '3' + quantity: 1 + taxPercentage: 20 + totalAmount: 221.64 + totalTaxAmount: 36.94 + unitPrice: 187.5 + taxes: [] + productRef: + id: '86' + name: '[Sample] Able Brewing System' + productVariantRef: + id: '66' + name: '[Sample] Able Brewing System' + discountAllocations: + - name: Manual Discount + totalAmount: 3.36 + - id: '4' + quantity: 5 + taxPercentage: 19.9999 + totalAmount: 438.36 + totalTaxAmount: 73.06 + unitPrice: 74.1667 + taxes: [] + productRef: + id: '81' + name: '[Sample] Orbit Terrarium - Small' + productVariantRef: + id: '65' + name: '[Sample] Orbit Terrarium - Small' + discountAllocations: + - name: Manual Discount + totalAmount: 6.64 + payments: [] + serviceCharges: + - description: Shipping Charge + totalAmount: 15 + taxPercentage: 20 + taxAmount: 2.5 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '0' + modifiedDate: '2023-04-11T10:33:56Z' + sourceModifiedDate: '2022-06-15T15:49:02Z' + pageNumber: 1 + pageSize: 2 + totalResults: 14 + _links: + current: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-orders + next: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-orders?page=2&pageSize=2 + Clover: + value: + results: + - id: 0BCZPWGFC3M16 + orderNumber: 0BCZPWGFC3M16 + country: 'GB ' + currency: GBP + createdDate: '2021-05-24T10:33:41Z' + totalAmount: 1200 + totalRefund: 0 + totalTaxAmount: 200 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: 985WY5J4H12XY + quantity: 1 + taxPercentage: 20 + totalAmount: 1200 + totalTaxAmount: 200 + unitPrice: 1000 + taxes: + - taxComponentRef: + id: KAWQTPZP3R9VT + name: VAT 20% + taxAmount: 200 + productRef: + id: NMZHKK6FKF6ZJ + name: Laptop + discountAllocations: [] + payments: + - id: S2D924NX13T2G + serviceCharges: [] + locationRef: + id: GA3WP1ZC3ZFK1 + name: Codat + modifiedDate: '2022-09-08T15:47:43Z' + sourceModifiedDate: '2021-05-24T10:33:45Z' + - id: 0G22TXMYQQE54 + orderNumber: 0G22TXMYQQE54 + country: 'GB ' + currency: GBP + createdDate: '2021-05-24T11:24:48Z' + totalAmount: 1340 + totalRefund: 0 + totalTaxAmount: 240 + totalDiscount: 100 + totalGratuity: 0 + orderLineItems: + - id: GZ73TPFAV6NTP + quantity: 1 + taxPercentage: 20 + totalAmount: 1440 + totalTaxAmount: 240 + unitPrice: 1200 + taxes: + - taxComponentRef: + id: KAWQTPZP3R9VT + name: VAT 20% + taxAmount: 240 + productRef: + id: QVAV6KM1457B0 + name: Desktop + discountAllocations: [] + - id: 'Discount: �10 off' + quantity: 1 + taxPercentage: 0 + totalAmount: -100 + totalTaxAmount: 0 + unitPrice: 0 + taxes: [] + discountAllocations: + - name: �10 off + totalAmount: 100 + payments: + - id: H726AAJQYE3SP + serviceCharges: [] + locationRef: + id: GA3WP1ZC3ZFK1 + name: Codat + modifiedDate: '2022-09-08T15:47:43Z' + sourceModifiedDate: '2021-05-24T11:24:52Z' + pageNumber: 1 + pageSize: 2 + totalResults: 76 + _links: + current: + href: /companies/1535235d-5efb-4d17-9d94-491c1f35ff92/connections/ed802898-f920-486b-b553-d7b4c1ac6c8d/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/1535235d-5efb-4d17-9d94-491c1f35ff92/connections/ed802898-f920-486b-b553-d7b4c1ac6c8d/data/commerce-orders + next: + href: /companies/1535235d-5efb-4d17-9d94-491c1f35ff92/connections/ed802898-f920-486b-b553-d7b4c1ac6c8d/data/commerce-orders?page=2&pageSize=2 + Lightspeed K Trial: + value: + results: + - id: A61465.1 + orderNumber: A61465.1 + country: 'AU ' + currency: AUD + createdDate: '2022-12-09T02:27:14Z' + closedDate: '2022-12-09T02:27:46Z' + totalAmount: 5 + totalRefund: 0 + totalTaxAmount: 0.45 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: S61465.1 + quantity: 1 + taxPercentage: 10 + totalAmount: 5 + totalTaxAmount: 0.45 + unitPrice: 4.5455 + taxes: + - taxComponentRef: + id: GST10 + name: 10% GST + taxAmount: 0.45 + productRef: + id: '647208621834617' + name: Hot Chocolate + discountAllocations: [] + payments: + - id: 'R61465.1_1_A61465.1_2022-12-09T02:27:46.273Z' + amount: 5 + currency: AUD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-12-09T02:27:46' + modifiedDate: '2023-03-02T09:50:43' + serviceCharges: [] + locationRef: + id: '647208621834538' + name: QA Shared - New Test Site + modifiedDate: '2023-03-08T13:49:34Z' + - id: A61465.2 + orderNumber: A61465.2 + country: 'AU ' + currency: AUD + createdDate: '2022-12-12T23:20:12Z' + closedDate: '2022-12-12T23:21:29Z' + totalAmount: 10 + totalRefund: 0 + totalTaxAmount: 0.91 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: S61465.2 + quantity: 1 + taxPercentage: 10 + totalAmount: 5 + totalTaxAmount: 0.46 + unitPrice: 4.5455 + taxes: + - taxComponentRef: + id: GST10 + name: 10% GST + taxAmount: 0.46 + productRef: + id: '647208621834663' + name: Royal + discountAllocations: [] + - id: S61465.3 + quantity: 1 + taxPercentage: 10 + totalAmount: 5 + totalTaxAmount: 0.45 + unitPrice: 4.5455 + taxes: + - taxComponentRef: + id: GST10 + name: 10% GST + taxAmount: 0.45 + productRef: + id: '647208621834623' + name: Mocha + discountAllocations: [] + payments: + - id: 'R61465.2_1_A61465.2_2022-12-12T23:21:29.006Z' + amount: 10 + currency: AUD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-12-12T23:21:29' + modifiedDate: '2023-03-02T09:50:43' + serviceCharges: [] + locationRef: + id: '647208621834538' + name: QA Shared - New Test Site + modifiedDate: '2023-03-08T13:49:34Z' + pageNumber: 1 + pageSize: 2 + totalResults: 24 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-orders + next: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-orders?page=2&pageSize=2 + Mollie: + value: + results: + - id: ord_2at3ck + orderNumber: '1337' + country: NLD + currency: EUR + createdDate: '2022-01-20T09:28:32' + totalAmount: 1027.99 + totalRefund: 0 + totalTaxAmount: 178.41 + totalDiscount: 100 + totalGratuity: 0 + orderLineItems: + - id: odl_1.3tvc32 + quantity: 1 + taxPercentage: 21 + totalAmount: 329.99 + totalTaxAmount: 57.27 + unitPrice: 329.99 + taxes: [] + discountAllocations: [] + - id: odl_1.x95vuk + quantity: 2 + taxPercentage: 21 + totalAmount: 698 + totalTaxAmount: 121.14 + unitPrice: 399 + taxes: [] + discountAllocations: + - name: Discount + totalAmount: 100 + payments: + - id: tr_GpHuaqHrca + amount: 1027.99 + currency: EUR + type: OnlineCard + status: Failed + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-02-08T15:44:22' + modifiedDate: '2022-03-17T15:47:28' + sourceModifiedDate: '2022-02-08T16:02:02' + - id: tr_w7RGQc3k3V + amount: 1027.99 + currency: EUR + type: OnlineCard + status: Failed + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-01-20T09:28:32' + modifiedDate: '2022-03-17T15:47:28' + sourceModifiedDate: '2022-01-20T09:46:02' + serviceCharges: [] + modifiedDate: '2022-03-17T15:47:28Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-orders + Mollie Test: + value: + results: + - id: ord_2at3ck + orderNumber: '1337' + country: NLD + currency: EUR + createdDate: '2022-01-20T09:28:32' + totalAmount: 1027.99 + totalRefund: 0 + totalTaxAmount: 178.41 + totalDiscount: 100 + totalGratuity: 0 + orderLineItems: + - id: odl_1.x95vuk + quantity: 2 + taxPercentage: 21 + totalAmount: 698 + totalTaxAmount: 121.14 + unitPrice: 338.43 + taxes: [] + discountAllocations: + - name: Discount + totalAmount: 100 + - id: odl_1.3tvc32 + quantity: 1 + taxPercentage: 21 + totalAmount: 329.99 + totalTaxAmount: 57.27 + unitPrice: 272.72 + taxes: [] + discountAllocations: [] + payments: + - id: tr_GpHuaqHrca + - id: tr_w7RGQc3k3V + serviceCharges: [] + modifiedDate: '2022-08-17T11:33:19Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-orders + Partner Commerce: + value: + results: + - id: 6d135134-2f77-45f7-af3d-ee873e42da45 + orderNumber: '93128704' + country: 'GM ' + currency: CAD + createdDate: '2021-02-10T01:37:23' + totalAmount: 203.82 + totalRefund: 0 + totalTaxAmount: 40.77 + totalDiscount: 25.63 + totalGratuity: 80.81 + orderLineItems: + - id: 89f5e83a-c87d-4b60-a009-0ea9065867aa + quantity: 3 + taxPercentage: 20 + totalAmount: 85.44 + totalTaxAmount: 17.09 + unitPrice: 28.48 + taxes: [] + productRef: + id: 98ef828e-33e1-4c23-9383-a029f1d6a3a6 + productVariantRef: + id: dffcd99e-13bb-4b89-89ef-719b3b0777e6 + discountAllocations: + - name: Discount + totalAmount: 8.54 + - name: Discount + totalAmount: 17.09 + - id: 4c65f0d9-05c8-48eb-9c4a-1774f5073e66 + quantity: 3 + taxPercentage: 20 + totalAmount: 118.38 + totalTaxAmount: 23.68 + unitPrice: 39.46 + taxes: [] + productRef: + id: 561f8efb-3429-4c1f-a014-1fa595f9b3c6 + productVariantRef: + id: e0715a7a-0179-4a2e-b40d-800fd2f36764 + discountAllocations: [] + payments: + - id: 3ec3d4c4-8003-4f77-a44e-08b3e17057bf + serviceCharges: [] + locationRef: + id: d84a8ce0-d7e4-400a-b07a-d4bddd9c1873 + customerRef: + id: 0dc0206d-f22f-48c9-a4e5-79f8383c3426 + modifiedDate: '2022-05-12T07:22:02Z' + sourceModifiedDate: '2021-02-10T01:37:23' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/4342cb7d-d7b1-492f-851e-4aa5084933c1/connections/9e5422fa-f03f-4d58-bcf4-161b574ab350/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/4342cb7d-d7b1-492f-851e-4aa5084933c1/connections/9e5422fa-f03f-4d58-bcf4-161b574ab350/data/commerce-orders + PrestaShop: + value: + results: + - id: '1' + orderNumber: XKBKNABJK + country: 'US ' + currency: USD + createdDate: '2021-09-02T06:00:54' + totalAmount: 61.8 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '1' + quantity: 1 + taxPercentage: 0 + totalAmount: 23.9 + totalTaxAmount: 0 + unitPrice: 23.9 + taxes: [] + productRef: + id: '1' + name: Hummingbird printed t-shirt + discountAllocations: [] + - id: '2' + quantity: 1 + taxPercentage: 0 + totalAmount: 35.9 + totalTaxAmount: 0 + unitPrice: 35.9 + taxes: [] + productRef: + id: '2' + name: Hummingbird printed sweater + discountAllocations: [] + payments: [] + serviceCharges: + - description: Shipping + totalAmount: 2 + taxPercentage: 0 + taxAmount: 0 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '1' + name: John DOE + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T06:00:54' + - id: '10' + orderNumber: UFQZXPGQU + country: 'US ' + currency: USD + createdDate: '2021-09-28T08:09:46' + totalAmount: 19.12 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 4.78 + totalGratuity: 0 + orderLineItems: + - id: '14' + quantity: 1 + taxPercentage: 0 + totalAmount: 19.12 + totalTaxAmount: 0 + unitPrice: 23.9 + taxes: [] + productRef: + id: '1' + name: Hummingbird printed t-shirt + discountAllocations: + - name: 20% Discount + totalAmount: 4.78 + payments: [] + serviceCharges: [] + customerRef: + id: '5' + name: Tobi Yinusa + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-28T08:09:46' + pageNumber: 1 + pageSize: 2 + totalResults: 10 + _links: + current: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-orders + next: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-orders?page=2&pageSize=2 + Shopify: + value: + results: + - id: '3684119445662' + orderNumber: '1007' + country: XXX + currency: GBP + createdDate: '2021-03-19T13:18:33' + totalAmount: 600 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '9670458146974' + quantity: 4 + taxPercentage: 0 + totalAmount: 600 + totalTaxAmount: 0 + unitPrice: 150 + taxes: [] + productRef: + id: '6595494117534' + name: Monitor + productVariantRef: + id: '39444526694558' + name: Monitor + discountAllocations: [] + payments: + - id: '4630233579678' + amount: 600 + currency: GBP + type: OnlineCard + status: Failed + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:17:49' + modifiedDate: '2023-02-10T15:18:24' + sourceModifiedDate: '2021-03-19T13:17:49' + - id: '4630234497182' + amount: 600 + currency: GBP + type: OnlineCard + status: Paid + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:18:29' + modifiedDate: '2023-02-10T15:18:24' + sourceModifiedDate: '2021-03-19T13:18:29' + serviceCharges: [] + customerRef: + id: '5097398534302' + name: Qa Test + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2022-08-01T13:12:35' + - id: '3684180361374' + orderNumber: '1011' + country: XXX + currency: GBP + createdDate: '2021-03-19T13:57:30' + totalAmount: 105 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '9670570901662' + quantity: 3 + taxPercentage: 0 + totalAmount: 105 + totalTaxAmount: 0 + unitPrice: 35 + taxes: [] + productRef: + id: '6595497787550' + name: Keyboard + productVariantRef: + id: '39444537213086' + name: Keyboard + discountAllocations: [] + payments: + - id: '4630311108766' + amount: 105 + currency: GBP + type: Unknown + status: Paid + paymentProvider: Manual + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:57:30' + modifiedDate: '2023-02-10T15:18:24' + sourceModifiedDate: '2021-03-19T13:57:30' + serviceCharges: [] + customerRef: + id: '5097398534302' + name: Qa Test + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2022-08-01T13:12:35' + pageNumber: 1 + pageSize: 2 + totalResults: 30 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-orders + next: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-orders?page=2&pageSize=2 + Square: + value: + results: + - id: BDYNvtIYyWClkTjnh99CFR3fPwKZY + orderNumber: BDYNvtIYyWClkTjnh99CFR3fPwKZY + country: 'GB ' + currency: GBP + createdDate: '2021-02-14T19:38:28Z' + closedDate: '0001-01-01T00:00:00' + totalAmount: 50 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: lLJpgArKQbBEn9nTvLRHP + quantity: 1 + taxPercentage: 0 + totalAmount: 50 + totalTaxAmount: 0 + unitPrice: 50 + taxes: [] + discountAllocations: [] + payments: [] + serviceCharges: [] + locationRef: + id: D8DVHD1G6NT2J + name: Codat Limited + modifiedDate: '2022-08-02T10:27:33Z' + sourceModifiedDate: '2021-02-14T19:38:28Z' + pageNumber: 1 + pageSize: 2 + totalResults: 1 + _links: + current: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-orders + SumUp: + value: + results: + - id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + orderNumber: TECXTU2KT6 + country: XXX + currency: GBP + createdDate: '2021-03-30T12:20:40Z' + totalAmount: 200 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: Product undefined by SumUp + quantity: 1 + taxPercentage: 0 + totalAmount: 200 + totalTaxAmount: 0 + unitPrice: 200 + taxes: [] + discountAllocations: [] + payments: + - id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + serviceCharges: [] + modifiedDate: '2022-09-14T10:58:04Z' + - id: 46d36a64-ea48-4e37-9340-3548cbf3ca2f + orderNumber: TNEU7333HZ + country: XXX + currency: GBP + createdDate: '2021-03-26T21:09:59Z' + totalAmount: 15 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: Sale of some product + quantity: 1 + taxPercentage: 0 + totalAmount: 15 + totalTaxAmount: 0 + unitPrice: 15 + taxes: [] + discountAllocations: [] + payments: + - id: 46d36a64-ea48-4e37-9340-3548cbf3ca2f + serviceCharges: [] + modifiedDate: '2022-09-14T10:58:04Z' + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-orders + next: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-orders?page=2&pageSize=2 + WooCommerce: + value: + results: + - id: '111' + orderNumber: '111' + country: 'GB ' + currency: GBP + createdDate: '2021-03-27T23:29:38Z' + totalAmount: 39.5 + totalRefund: 0 + totalTaxAmount: 6 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '53' + quantity: 2 + taxPercentage: 20 + totalAmount: 12 + totalTaxAmount: 2 + unitPrice: 5 + taxes: [] + productRef: + id: '82' + discountAllocations: [] + - id: '54' + quantity: 2 + taxPercentage: 20 + totalAmount: 24 + totalTaxAmount: 4 + unitPrice: 10 + taxes: [] + productRef: + id: '81' + discountAllocations: [] + payments: [] + serviceCharges: + - description: Royal Mail + totalAmount: 3.5 + taxPercentage: 0 + taxAmount: 0 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '200585744' + modifiedDate: '2022-07-11T15:35:48Z' + sourceModifiedDate: '2021-04-01T13:34:59Z' + - id: '145' + orderNumber: '145' + country: 'GB ' + currency: GBP + createdDate: '2021-09-24T12:15:29Z' + totalAmount: 27.5 + totalRefund: 0 + totalTaxAmount: 5.5 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '59' + quantity: 2 + taxPercentage: 25 + totalAmount: 27.5 + totalTaxAmount: 5.5 + unitPrice: 11 + taxes: [] + productRef: + id: '87' + discountAllocations: [] + payments: [] + serviceCharges: [] + modifiedDate: '2022-07-11T15:35:48Z' + sourceModifiedDate: '2022-03-24T16:01:23Z' + pageNumber: 1 + pageSize: 2 + totalResults: 25 + _links: + current: + href: /companies/00396b78-7113-4b1f-996f-4c561b00573a/connections/b39ed7d6-5eda-44c5-85bb-647d03edd649/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/00396b78-7113-4b1f-996f-4c561b00573a/connections/b39ed7d6-5eda-44c5-85bb-647d03edd649/data/commerce-orders + next: + href: /companies/00396b78-7113-4b1f-996f-4c561b00573a/connections/b39ed7d6-5eda-44c5-85bb-647d03edd649/data/commerce-orders?page=2&pageSize=2 + Zettle: + value: + results: + - id: 7TunRi2XEeueVK3fSQEQIw + orderNumber: '3' + country: 'GB ' + currency: GBP + createdDate: '2020-11-23T14:27:20Z' + totalAmount: 45 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '0' + quantity: 1 + taxPercentage: 0 + totalAmount: 45 + totalTaxAmount: 0 + unitPrice: 45 + taxes: [] + productRef: + id: 7f9f31e4-2d97-11eb-9f55-acde48001122 + productVariantRef: + id: 7f9f35ea-2d97-11eb-9f55-acde48001122 + discountAllocations: [] + payments: + - id: ed97bcde-2d97-11eb-a42e-25130f2dd258 + amount: 45 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:27:19' + modifiedDate: '2021-10-27T15:22:37' + serviceCharges: [] + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2020-11-23T14:27:20Z' + - id: CV5TJC2YEeueVK3fSQEQIw + orderNumber: '4' + country: 'GB ' + currency: GBP + createdDate: '2020-11-23T14:28:05Z' + totalAmount: 25 + totalRefund: 0 + totalTaxAmount: 1.19 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '0' + quantity: 1 + taxPercentage: 5 + totalAmount: 25 + totalTaxAmount: 1.19 + unitPrice: 23.81 + taxes: [] + productRef: + id: 89570bee-2d97-11eb-9f55-acde48001122 + productVariantRef: + id: 89570c52-2d97-11eb-9f55-acde48001122 + discountAllocations: [] + payments: + - id: 09b94cfc-2d98-11eb-8021-0e1b9dcbeca1 + amount: 25 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:28:04' + modifiedDate: '2021-10-27T15:22:37' + serviceCharges: [] + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2020-11-23T14:28:05Z' + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-orders?page=1&pageSize=2 + self: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-orders + next: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-orders?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List orders* endpoint returns a list of [orders](https://docs.codat.io/lending-api#/schemas/Order) for a given company's connection.\n\n[Orders](https://docs.codat.io/lending-api#/schemas/Order) contain the transaction details for all products sold by the company.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + '/companies/{companyId}/connections/{connectionId}/data/commerce-orders/{orderId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: orderId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for an order. + get: + summary: Get order + tags: + - Sales + operationId: get-commerce-order + x-speakeasy-group: sales.orders + responses: + '200': + description: OK + content: + application/json: + x-speakeasy-usage-example: true + schema: + $ref: '#/components/schemas/CommerceOrder' + examples: + Amazon Seller Central: + value: + id: 902-1845936-5435065 + orderNumber: 902-1845936-5435065 + country: 'US ' + currency: USD + createdDate: '1970-01-19T03:58:30Z' + totalAmount: 10 + totalRefund: 0 + totalTaxAmount: 1.01 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: O05015851154158 + quantity: 1 + taxPercentage: 11.23 + totalAmount: 10 + totalTaxAmount: 1.01 + unitPrice: 8.99 + taxes: [] + productVariantRef: + id: NABetaASINB00551Q3CS + discountAllocations: [] + payments: [] + serviceCharges: [] + modifiedDate: '2023-01-09T09:12:12Z' + sourceModifiedDate: '1970-01-19T03:58:32Z' + BigCommerce: + value: + id: '100' + orderNumber: '100' + country: GBR + currency: GBP + createdDate: '2022-06-15T15:48:18Z' + totalAmount: 675 + totalRefund: 0 + totalTaxAmount: 112.5 + totalDiscount: 10 + totalGratuity: 0 + orderLineItems: + - id: '1' + quantity: 1 + taxPercentage: 20 + totalAmount: 221.64 + totalTaxAmount: 36.94 + unitPrice: 187.5 + taxes: [] + productRef: + id: '86' + name: '[Sample] Able Brewing System' + productVariantRef: + id: '66' + name: '[Sample] Able Brewing System' + discountAllocations: + - name: Manual Discount + totalAmount: 3.36 + - id: '2' + quantity: 5 + taxPercentage: 19.9999 + totalAmount: 438.36 + totalTaxAmount: 73.06 + unitPrice: 74.1667 + taxes: [] + productRef: + id: '81' + name: '[Sample] Orbit Terrarium - Small' + productVariantRef: + id: '65' + name: '[Sample] Orbit Terrarium - Small' + discountAllocations: + - name: Manual Discount + totalAmount: 6.64 + payments: [] + serviceCharges: + - description: Shipping Charge + totalAmount: 15 + taxPercentage: 20 + taxAmount: 2.5 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '0' + modifiedDate: '2023-04-11T10:33:56Z' + sourceModifiedDate: '2022-06-15T15:48:18Z' + Clover: + value: + id: 0BCZPWGFC3M16 + orderNumber: 0BCZPWGFC3M16 + country: 'GB ' + currency: GBP + createdDate: '2021-05-24T10:33:41Z' + totalAmount: 1200 + totalRefund: 0 + totalTaxAmount: 200 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: 985WY5J4H12XY + quantity: 1 + taxPercentage: 20 + totalAmount: 1200 + totalTaxAmount: 200 + unitPrice: 1000 + taxes: + - taxComponentRef: + id: KAWQTPZP3R9VT + name: VAT 20% + taxAmount: 200 + productRef: + id: NMZHKK6FKF6ZJ + name: Laptop + discountAllocations: [] + payments: + - id: S2D924NX13T2G + serviceCharges: [] + locationRef: + id: GA3WP1ZC3ZFK1 + name: Codat + modifiedDate: '2022-09-08T15:47:43Z' + sourceModifiedDate: '2021-05-24T10:33:45Z' + Lightspeed K Trial: + value: + id: A61465.1 + orderNumber: A61465.1 + country: 'AU ' + currency: AUD + createdDate: '2022-12-09T02:27:14Z' + closedDate: '2022-12-09T02:27:46Z' + totalAmount: 5 + totalRefund: 0 + totalTaxAmount: 0.45 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: S61465.1 + quantity: 1 + taxPercentage: 10 + totalAmount: 5 + totalTaxAmount: 0.45 + unitPrice: 4.5455 + taxes: + - taxComponentRef: + id: GST10 + name: 10% GST + taxAmount: 0.45 + productRef: + id: '647208621834617' + name: Hot Chocolate + discountAllocations: [] + payments: + - id: 'R61465.1_1_A61465.1_2022-12-09T02:27:46.273Z' + amount: 5 + currency: AUD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-12-09T02:27:46' + modifiedDate: '2023-03-02T09:50:43' + serviceCharges: [] + locationRef: + id: '647208621834538' + name: QA Shared - New Test Site + modifiedDate: '2023-03-08T13:49:34Z' + Mollie: + value: + id: ord_2at3ck + orderNumber: '1337' + country: NLD + currency: EUR + createdDate: '2022-01-20T09:28:32' + totalAmount: 1027.99 + totalRefund: 0 + totalTaxAmount: 178.41 + totalDiscount: 100 + totalGratuity: 0 + orderLineItems: + - id: odl_1.3tvc32 + quantity: 1 + taxPercentage: 21 + totalAmount: 329.99 + totalTaxAmount: 57.27 + unitPrice: 329.99 + taxes: [] + discountAllocations: [] + - id: odl_1.x95vuk + quantity: 2 + taxPercentage: 21 + totalAmount: 698 + totalTaxAmount: 121.14 + unitPrice: 399 + taxes: [] + discountAllocations: + - name: Discount + totalAmount: 100 + payments: + - id: tr_GpHuaqHrca + amount: 1027.99 + currency: EUR + type: OnlineCard + status: Failed + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-02-08T15:44:22' + modifiedDate: '2022-03-17T15:47:28' + sourceModifiedDate: '2022-02-08T16:02:02' + - id: tr_w7RGQc3k3V + amount: 1027.99 + currency: EUR + type: OnlineCard + status: Failed + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-01-20T09:28:32' + modifiedDate: '2022-03-17T15:47:28' + sourceModifiedDate: '2022-01-20T09:46:02' + serviceCharges: [] + modifiedDate: '2022-03-17T15:47:28Z' + Mollie Test: + value: + id: ord_2at3ck + orderNumber: '1337' + country: NLD + currency: EUR + createdDate: '2022-01-20T09:28:32' + totalAmount: 1027.99 + totalRefund: 0 + totalTaxAmount: 178.41 + totalDiscount: 100 + totalGratuity: 0 + orderLineItems: + - id: odl_1.x95vuk + quantity: 2 + taxPercentage: 21 + totalAmount: 698 + totalTaxAmount: 121.14 + unitPrice: 338.43 + taxes: [] + discountAllocations: + - name: Discount + totalAmount: 100 + - id: odl_1.3tvc32 + quantity: 1 + taxPercentage: 21 + totalAmount: 329.99 + totalTaxAmount: 57.27 + unitPrice: 272.72 + taxes: [] + discountAllocations: [] + payments: + - id: tr_GpHuaqHrca + - id: tr_w7RGQc3k3V + serviceCharges: [] + modifiedDate: '2022-08-17T11:33:19Z' + Partner Commerce: + value: + id: 6d135134-2f77-45f7-af3d-ee873e42da45 + orderNumber: '93128704' + country: 'GM ' + currency: CAD + createdDate: '2021-02-10T01:37:23' + totalAmount: 203.82 + totalRefund: 0 + totalTaxAmount: 40.77 + totalDiscount: 25.63 + totalGratuity: 80.81 + orderLineItems: + - id: 89f5e83a-c87d-4b60-a009-0ea9065867aa + quantity: 3 + taxPercentage: 20 + totalAmount: 85.44 + totalTaxAmount: 17.09 + unitPrice: 28.48 + taxes: [] + productRef: + id: 98ef828e-33e1-4c23-9383-a029f1d6a3a6 + productVariantRef: + id: dffcd99e-13bb-4b89-89ef-719b3b0777e6 + discountAllocations: + - name: Discount + totalAmount: 8.54 + - name: Discount + totalAmount: 17.09 + - id: 4c65f0d9-05c8-48eb-9c4a-1774f5073e66 + quantity: 3 + taxPercentage: 20 + totalAmount: 118.38 + totalTaxAmount: 23.68 + unitPrice: 39.46 + taxes: [] + productRef: + id: 561f8efb-3429-4c1f-a014-1fa595f9b3c6 + productVariantRef: + id: e0715a7a-0179-4a2e-b40d-800fd2f36764 + discountAllocations: [] + payments: + - id: 3ec3d4c4-8003-4f77-a44e-08b3e17057bf + serviceCharges: [] + locationRef: + id: d84a8ce0-d7e4-400a-b07a-d4bddd9c1873 + customerRef: + id: 0dc0206d-f22f-48c9-a4e5-79f8383c3426 + modifiedDate: '2022-05-12T07:22:02Z' + sourceModifiedDate: '2021-02-10T01:37:23' + PrestaShop: + value: + id: '1' + orderNumber: XKBKNABJK + country: 'US ' + currency: USD + createdDate: '2021-09-02T06:00:54' + totalAmount: 61.8 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '1' + quantity: 1 + taxPercentage: 0 + totalAmount: 23.9 + totalTaxAmount: 0 + unitPrice: 23.9 + taxes: [] + productRef: + id: '1' + name: Hummingbird printed t-shirt + discountAllocations: [] + - id: '2' + quantity: 1 + taxPercentage: 0 + totalAmount: 35.9 + totalTaxAmount: 0 + unitPrice: 35.9 + taxes: [] + productRef: + id: '2' + name: Hummingbird printed sweater + discountAllocations: [] + payments: [] + serviceCharges: + - description: Shipping + totalAmount: 2 + taxPercentage: 0 + taxAmount: 0 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '1' + name: John DOE + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T06:00:54' + Shopify: + value: + id: '3684119445662' + orderNumber: '1007' + country: XXX + currency: GBP + createdDate: '2021-03-19T13:18:33' + totalAmount: 600 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '9670458146974' + quantity: 4 + taxPercentage: 0 + totalAmount: 600 + totalTaxAmount: 0 + unitPrice: 150 + taxes: [] + productRef: + id: '6595494117534' + name: Monitor + productVariantRef: + id: '39444526694558' + name: Monitor + discountAllocations: [] + payments: + - id: '4630233579678' + amount: 600 + currency: GBP + type: OnlineCard + status: Failed + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:17:49' + modifiedDate: '2023-02-10T15:18:24' + sourceModifiedDate: '2021-03-19T13:17:49' + - id: '4630234497182' + amount: 600 + currency: GBP + type: OnlineCard + status: Paid + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:18:29' + modifiedDate: '2023-02-10T15:18:24' + sourceModifiedDate: '2021-03-19T13:18:29' + serviceCharges: [] + customerRef: + id: '5097398534302' + name: Qa Test + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2022-08-01T13:12:35' + Square: + value: + id: BDYNvtIYyWClkTjnh99CFR3fPwKZY + orderNumber: BDYNvtIYyWClkTjnh99CFR3fPwKZY + country: 'GB ' + currency: GBP + createdDate: '2021-02-14T19:38:28Z' + closedDate: '0001-01-01T00:00:00' + totalAmount: 50 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: lLJpgArKQbBEn9nTvLRHP + quantity: 1 + taxPercentage: 0 + totalAmount: 50 + totalTaxAmount: 0 + unitPrice: 50 + taxes: [] + discountAllocations: [] + payments: [] + serviceCharges: [] + locationRef: + id: D8DVHD1G6NT2J + name: Codat Limited + modifiedDate: '2022-08-02T10:27:33Z' + sourceModifiedDate: '2021-02-14T19:38:28Z' + SumUp: + value: + id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + orderNumber: TECXTU2KT6 + country: XXX + currency: GBP + createdDate: '2021-03-30T12:20:40Z' + totalAmount: 200 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: Product undefined by SumUp + quantity: 1 + taxPercentage: 0 + totalAmount: 200 + totalTaxAmount: 0 + unitPrice: 200 + taxes: [] + discountAllocations: [] + payments: + - id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + serviceCharges: [] + modifiedDate: '2022-09-14T10:58:04Z' + WooCommerce: + value: + id: '111' + orderNumber: '111' + country: 'GB ' + currency: GBP + createdDate: '2021-03-27T23:29:38Z' + totalAmount: 39.5 + totalRefund: 0 + totalTaxAmount: 6 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '53' + quantity: 2 + taxPercentage: 20 + totalAmount: 12 + totalTaxAmount: 2 + unitPrice: 5 + taxes: [] + productRef: + id: '82' + discountAllocations: [] + - id: '54' + quantity: 2 + taxPercentage: 20 + totalAmount: 24 + totalTaxAmount: 4 + unitPrice: 10 + taxes: [] + productRef: + id: '81' + discountAllocations: [] + payments: [] + serviceCharges: + - description: Royal Mail + totalAmount: 3.5 + taxPercentage: 0 + taxAmount: 0 + taxes: [] + quantity: 1 + type: Shipping + customerRef: + id: '200585744' + modifiedDate: '2022-07-11T15:35:48Z' + sourceModifiedDate: '2021-04-01T13:34:59Z' + Zettle: + value: + id: 7TunRi2XEeueVK3fSQEQIw + orderNumber: '3' + country: 'GB ' + currency: GBP + createdDate: '2020-11-23T14:27:20Z' + totalAmount: 45 + totalRefund: 0 + totalTaxAmount: 0 + totalDiscount: 0 + totalGratuity: 0 + orderLineItems: + - id: '0' + quantity: 1 + taxPercentage: 0 + totalAmount: 45 + totalTaxAmount: 0 + unitPrice: 45 + taxes: [] + productRef: + id: 7f9f31e4-2d97-11eb-9f55-acde48001122 + productVariantRef: + id: 7f9f35ea-2d97-11eb-9f55-acde48001122 + discountAllocations: [] + payments: + - id: ed97bcde-2d97-11eb-a42e-25130f2dd258 + amount: 45 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:27:19' + modifiedDate: '2021-10-27T15:22:37' + serviceCharges: [] + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2020-11-23T14:27:20Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get order* endpoint returns a single order for a given orderId. + + [Orders](https://docs.codat.io/lending-api#/schemas/Order) contain the transaction details for all products sold by the company. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-paymentMethods': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List payment methods + tags: + - Sales + operationId: list-commerce-payment-methods + x-speakeasy-group: sales.payment-methods + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommercePaymentMethods' + examples: + Amazon Seller Central: + value: + results: + - id: COD + name: Cash On Delivery + status: Active + modifiedDate: '2023-01-09T09:12:03Z' + - id: GC + name: Gift Card + status: Active + modifiedDate: '2023-01-09T09:12:03Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-paymentMethods + next: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-paymentMethods?page=2&pageSize=2 + BigCommerce: + value: + results: + - id: bigcommerce_gift_certificate + name: Gift Certificate + status: Active + modifiedDate: '2023-04-11T10:33:48Z' + - id: bigcommerce_store_credit + name: Store Credit + status: Active + modifiedDate: '2023-04-11T10:33:48Z' + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-paymentMethods + Clover: + value: + results: + - id: 0DPQ6QP48YYHW + name: TapMango Wallet + status: Active + modifiedDate: '2023-01-09T11:01:04Z' + - id: 24H1ANYP1BNXG + name: MyTab + status: Active + modifiedDate: '2023-01-09T11:01:04Z' + pageNumber: 1 + pageSize: 2 + totalResults: 13 + _links: + current: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-paymentMethods + next: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-paymentMethods?page=2&pageSize=2 + Lightspeed K Trial: + value: + results: + - id: '647208621834260' + name: Cash + status: Active + modifiedDate: '2023-03-02T09:48:56Z' + - id: '647208621834261' + name: Credit Card + status: Active + modifiedDate: '2023-03-02T09:48:56Z' + pageNumber: 1 + pageSize: 2 + totalResults: 11 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-paymentMethods + next: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-paymentMethods?page=2&pageSize=2 + Mollie: + value: + results: + - id: applepay + name: Apple Pay + status: Unknown + modifiedDate: '2022-08-09T15:08:19Z' + - id: bancontact + name: Bancontact + status: Unknown + modifiedDate: '2022-08-09T15:08:19Z' + pageNumber: 1 + pageSize: 2 + totalResults: 19 + _links: + current: + href: /companies/a2503b54-143c-4705-8bec-9ef84f51ca86/connections/4c8df852-f1b3-4642-939b-c33d6f34a312/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/a2503b54-143c-4705-8bec-9ef84f51ca86/connections/4c8df852-f1b3-4642-939b-c33d6f34a312/data/commerce-paymentMethods + next: + href: /companies/a2503b54-143c-4705-8bec-9ef84f51ca86/connections/4c8df852-f1b3-4642-939b-c33d6f34a312/data/commerce-paymentMethods?page=2&pageSize=2 + Mollie Test: + value: + results: + - id: applepay + name: Apple Pay + status: Unknown + modifiedDate: '2022-08-17T11:33:19Z' + - id: bancontact + name: Bancontact + status: Unknown + modifiedDate: '2022-08-17T11:33:19Z' + pageNumber: 1 + pageSize: 2 + totalResults: 19 + _links: + current: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-paymentMethods + next: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-paymentMethods?page=2&pageSize=2 + Square: + value: + results: + - id: BANK_ACCOUNT + name: Bank Account + status: Unknown + modifiedDate: '2022-08-02T10:27:32Z' + - id: BUY_NOW_PAY_LATER + name: Buy Now Pay Later + status: Unknown + modifiedDate: '2022-08-02T10:27:32Z' + pageNumber: 1 + pageSize: 2 + totalResults: 20 + _links: + current: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-paymentMethods + next: + href: /companies/d779fc82-a098-4107-a9fc-c2a1dda3d522/connections/9b098b74-3770-4dad-9001-4c283a39f1e5/data/commerce-paymentMethods?page=2&pageSize=2 + SumUp: + value: + results: + - id: CASH + name: Cash + status: Active + modifiedDate: '2022-09-14T10:58:03Z' + - id: CC_CUSTOMER_ENTERED + name: Credit Card + status: Active + modifiedDate: '2022-09-14T10:58:03Z' + pageNumber: 1 + pageSize: 2 + totalResults: 8 + _links: + current: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-paymentMethods?page=1&pageSize=2 + self: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-paymentMethods + next: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-paymentMethods?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List payment methods* endpoint returns a list of [payment methods](https://docs.codat.io/lending-api#/schemas/PaymentMethod) for a given company's connection.\n\n[Payment methods](https://docs.codat.io/lending-api#/schemas/PaymentMethod) represent the payment method(s) used to make payments.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + '/companies/{companyId}/connections/{connectionId}/data/commerce-paymentMethods/{paymentMethodId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: paymentMethodId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a payment method. + get: + summary: Get payment method + tags: + - Sales + operationId: get-commerce-payment-method + x-speakeasy-group: sales.payment-methods + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommercePaymentMethod' + examples: + Amazon Seller Central: + value: + id: COD + name: Cash On Delivery + status: Active + modifiedDate: '2023-01-09T09:12:03Z' + BigCommerce: + value: + id: bigcommerce_gift_certificate + name: Gift Certificate + status: Active + modifiedDate: '2023-04-11T10:33:48Z' + Clover: + value: + id: 0DPQ6QP48YYHW + name: TapMango Wallet + status: Active + modifiedDate: '2023-01-09T11:01:04Z' + Lightspeed K Trial: + value: + id: '647208621834260' + name: Cash + status: Active + modifiedDate: '2023-03-02T09:48:56Z' + Mollie: + value: + id: applepay + name: Apple Pay + status: Unknown + modifiedDate: '2022-08-09T15:08:19Z' + Mollie Test: + value: + id: applepay + name: Apple Pay + status: Unknown + modifiedDate: '2022-08-17T11:33:19Z' + Square: + value: + id: BANK_ACCOUNT + name: Bank Account + status: Unknown + modifiedDate: '2022-08-02T10:27:32Z' + SumUp: + value: + id: CASH + name: Cash + status: Active + modifiedDate: '2022-09-14T10:58:03Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get payment method* endpoint returns a single payment method for a given paymentMethodId. + + [Payment methods](https://docs.codat.io/lending-api#/schemas/PaymentMethod) represent the payment method(s) used to make payments. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-payments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List payments + tags: + - Sales + operationId: list-commerce-payments + x-speakeasy-group: sales.payments + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommercePayments' + examples: + BigCommerce: + value: + results: + - id: 103_1_1_refund + amount: -64 + currency: GBP + type: Unknown + status: Paid + paymentProvider: bigpaypay + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-06-15T17:13:13Z' + modifiedDate: '2023-04-11T10:33:52Z' + - id: 105_2_2_refund + amount: -33.95 + currency: GBP + type: Unknown + status: Paid + paymentProvider: bigpaypay + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-06-24T13:57:01Z' + modifiedDate: '2023-04-11T10:33:52Z' + pageNumber: 1 + pageSize: 2 + totalResults: 20 + _links: + current: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-payments + next: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-payments?page=2&pageSize=2 + Clover: + value: + results: + - id: 01J7HV88GT6B8 + amount: 1000 + currency: USD + paymentMethodRef: + id: BR5M17TG091SP + name: Credit Card + type: Card + status: Paid + paymentProvider: clover + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-05-24T10:35:08Z' + modifiedDate: '2023-01-09T11:01:02Z' + sourceModifiedDate: '2021-05-24T10:35:08Z' + - id: 0A8ZMPG40Q9AM + amount: 1000 + currency: USD + paymentMethodRef: + id: BR5M17TG091SP + name: Credit Card + type: Card + status: Paid + paymentProvider: clover + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-05-24T10:35:31Z' + modifiedDate: '2023-01-09T11:01:02Z' + sourceModifiedDate: '2021-05-24T10:35:31Z' + pageNumber: 1 + pageSize: 2 + totalResults: 77 + _links: + current: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-payments + next: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-payments?page=2&pageSize=2 + Lightspeed K Trial: + value: + results: + - id: '1_A62084.1_2023-01-05T03:34:50.296Z' + amount: 0 + currency: AUD + paymentMethodRef: + id: '0' + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2023-01-05T03:34:50Z' + modifiedDate: '2023-03-02T09:50:43Z' + - id: 'R61465.1_1_A61465.1_2022-12-09T02:27:46.273Z' + amount: 5 + currency: AUD + paymentMethodRef: + id: '647208621834714' + name: LSPay - Mary + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-12-09T02:27:46Z' + modifiedDate: '2023-03-02T09:50:43Z' + pageNumber: 1 + pageSize: 2 + totalResults: 26 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-payments + next: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-payments?page=2&pageSize=2 + Mollie: + value: + results: + - id: re_Azhe8TzfUK + amount: -20 + currency: EUR + type: OnlineCard + status: Paid + paymentProvider: mollie + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-03-17T16:15:23Z' + - id: re_NPKEJhQveu + amount: -60 + currency: EUR + type: OnlineCard + status: Paid + paymentProvider: mollie + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-01-17T16:00:05' + modifiedDate: '2022-03-17T16:15:23Z' + pageNumber: 1 + pageSize: 2 + totalResults: 16 + _links: + current: + href: /companies/65fe5864-16d7-41f4-8823-87ae1cf3a283/connections/1dbbf0ab-a27a-45b0-982a-ae0d8985affc/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/65fe5864-16d7-41f4-8823-87ae1cf3a283/connections/1dbbf0ab-a27a-45b0-982a-ae0d8985affc/data/commerce-payments + next: + href: /companies/65fe5864-16d7-41f4-8823-87ae1cf3a283/connections/1dbbf0ab-a27a-45b0-982a-ae0d8985affc/data/commerce-payments?page=2&pageSize=2 + PrestaShop: + value: + results: + - id: '1' + amount: 20.9 + currency: USD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-09-08T01:52:55' + modifiedDate: '2022-01-26T15:09:42Z' + - id: '2' + amount: 20.9 + currency: USD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-09-08T01:53:28' + modifiedDate: '2022-01-26T15:09:42Z' + pageNumber: 1 + pageSize: 2 + totalResults: 5 + _links: + current: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-payments + next: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-payments?page=2&pageSize=2 + Shopify: + value: + results: + - id: '4630233579678' + amount: 600 + currency: GBP + type: OnlineCard + status: Failed + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:17:49Z' + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2021-03-19T13:17:49Z' + - id: '4630234497182' + amount: 600 + currency: GBP + type: OnlineCard + status: Paid + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:18:29Z' + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2021-03-19T13:18:29Z' + pageNumber: 1 + pageSize: 2 + totalResults: 46 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-payments + next: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-payments?page=2&pageSize=2 + SumUp: + value: + results: + - id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + amount: 200 + currency: GBP + type: OnlineCard + status: Cancelled + paymentProvider: sumup + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-30T12:20:40Z' + modifiedDate: '2022-03-17T16:13:46Z' + - id: 46d36a64-ea48-4e37-9340-3548cbf3ca2f + amount: 15 + currency: GBP + type: Cash + status: Paid + paymentProvider: sumup + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-26T21:09:59Z' + modifiedDate: '2022-03-17T16:13:46Z' + pageNumber: 1 + pageSize: 2 + totalResults: 6 + _links: + current: + href: /companies/d9e78460-7ee5-4a34-a3f4-9652a5946b1f/connections/60959ebe-8491-4368-bf0a-f715c3ce2e53/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/d9e78460-7ee5-4a34-a3f4-9652a5946b1f/connections/60959ebe-8491-4368-bf0a-f715c3ce2e53/data/commerce-payments + next: + href: /companies/d9e78460-7ee5-4a34-a3f4-9652a5946b1f/connections/60959ebe-8491-4368-bf0a-f715c3ce2e53/data/commerce-payments?page=2&pageSize=2 + WooCommerce: + value: + results: + - id: '33' + amount: 0 + currency: GBP + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-11T09:07:00Z' + modifiedDate: '2021-07-13T16:19:00Z' + - id: '35' + amount: 30 + currency: GBP + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-11T09:08:56Z' + modifiedDate: '2021-07-13T16:19:00Z' + pageNumber: 1 + pageSize: 2 + totalResults: 5 + _links: + current: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-payments + next: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-payments?page=2&pageSize=2 + Zettle: + value: + results: + - id: 09b94cfc-2d98-11eb-8021-0e1b9dcbeca1 + amount: 25 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:28:04Z' + modifiedDate: '2021-10-27T15:22:37Z' + - id: 226580d6-2d98-11eb-a35c-fed5e63de507 + amount: 58.5 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:28:47Z' + modifiedDate: '2021-10-27T15:22:37Z' + pageNumber: 1 + pageSize: 2 + totalResults: 8 + _links: + current: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-payments?page=1&pageSize=2 + self: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-payments + next: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-payments?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List payments* endpoint returns a list of [payments](https://docs.codat.io/lending-api#/schemas/Payment) for a given company's connection.\n\n[Payments](https://docs.codat.io/lending-api#/schemas/Payment) contain details of all payments made by customers to the company.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + '/companies/{companyId}/connections/{connectionId}/data/commerce-payments/{paymentId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/paymentId' + get: + summary: Get payment + tags: + - Sales + operationId: get-commerce-payment + x-speakeasy-group: sales.payments + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommercePayment' + examples: + BigCommerce: + value: + id: 103_1_1_refund + amount: -64 + currency: GBP + type: Unknown + status: Paid + paymentProvider: bigpaypay + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-06-15T17:13:13Z' + modifiedDate: '2023-04-11T10:33:52Z' + Clover: + value: + id: 01J7HV88GT6B8 + amount: 1000 + currency: USD + paymentMethodRef: + id: BR5M17TG091SP + name: Credit Card + type: Card + status: Paid + paymentProvider: clover + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-05-24T10:35:08Z' + modifiedDate: '2023-01-09T11:01:02Z' + sourceModifiedDate: '2021-05-24T10:35:08Z' + Lightspeed K Trial: + value: + id: '1_A62084.1_2023-01-05T03:34:50.296Z' + amount: 0 + currency: AUD + paymentMethodRef: + id: '0' + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2023-01-05T03:34:50Z' + modifiedDate: '2023-03-02T09:50:43Z' + Mollie: + value: + id: re_Azhe8TzfUK + amount: -20 + currency: EUR + type: OnlineCard + status: Paid + paymentProvider: mollie + dueDate: '0001-01-01T00:00:00' + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-03-17T16:15:23Z' + PrestaShop: + value: + id: '1' + amount: 20.9 + currency: USD + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-09-08T01:52:55' + modifiedDate: '2022-01-26T15:09:42Z' + Shopify: + value: + id: '4630233579678' + amount: 600 + currency: GBP + type: OnlineCard + status: Failed + paymentProvider: Shopify Payments + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-19T13:17:49Z' + modifiedDate: '2023-02-10T15:18:24Z' + sourceModifiedDate: '2021-03-19T13:17:49Z' + SumUp: + value: + id: 07efcdd0-7f61-4d82-957f-52e8f0bd3f89 + amount: 200 + currency: GBP + type: OnlineCard + status: Cancelled + paymentProvider: sumup + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-30T12:20:40Z' + modifiedDate: '2022-03-17T16:13:46Z' + WooCommerce: + value: + id: '33' + amount: 0 + currency: GBP + type: Unknown + status: Paid + dueDate: '0001-01-01T00:00:00' + createdDate: '2021-03-11T09:07:00Z' + modifiedDate: '2021-07-13T16:19:00Z' + Zettle: + value: + id: 09b94cfc-2d98-11eb-8021-0e1b9dcbeca1 + amount: 25 + currency: GBP + type: Paypal + status: Unknown + dueDate: '0001-01-01T00:00:00' + createdDate: '2020-11-23T14:28:04Z' + modifiedDate: '2021-10-27T15:22:37Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get payment* endpoint returns a single payment for a given paymentId. + + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) contain details of all payments made by customers to the company. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-productCategories': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List product categories + tags: + - Sales + operationId: list-commerce-product-categories + x-speakeasy-group: sales.product-categories + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceProductCategories' + examples: + Lightspeed K Trial: + value: + results: + - id: '647208621834281' + name: Alcoholic beverages + ancestorRefs: [] + hasChildren: false + modifiedDate: '2023-03-02T09:49:11Z' + - id: '647208621834282' + name: NA beverages + ancestorRefs: [] + hasChildren: false + modifiedDate: '2023-03-02T09:49:11Z' + pageNumber: 1 + pageSize: 2 + totalResults: 8 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-productCategories?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-productCategories + next: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-productCategories?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + description: "The *List product categories* endpoint returns a list of [product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) for a given company's connection.\n\n[Product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. \"Furniture\"), or sometimes by tax profile.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + '/companies/{companyId}/connections/{connectionId}/data/commerce-productCategories/{productId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/productId' + get: + summary: Get product category + tags: + - Sales + operationId: get-commerce-product-category + x-speakeasy-group: sales.product-categories + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceProductCategory' + examples: + Lightspeed K Trial: + value: + id: '647208621834281' + name: Alcoholic beverages + ancestorRefs: [] + hasChildren: false + modifiedDate: '2023-03-02T09:49:11Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get product* endpoint returns a single product for a given productId. + + [Product categories](https://docs.codat.io/lending-api#/schemas/ProductCategory) are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-products': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List products + tags: + - Sales + operationId: list-commerce-products + x-speakeasy-group: sales.products + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceProducts' + examples: + Amazon Seller Central: + value: + results: + - id: Chromecast + categorization: DEVICE + name: Chromecast + description: Cast from your phone to your TV with this all new chromecast. + productCategoryRefs: [] + isGiftCard: false + variants: + - id: packaging_asin_gating + name: Chromecast in a cardboard box + quantity: 0 + isTaxEnabled: false + sku: packaging_asin_gating + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 50 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-07T12:30:01Z' + createdDate: '2021-02-07T12:30:01Z' + modifiedDate: '2023-01-09T09:12:11Z' + sourceModifiedDate: '2022-08-17T09:07:07Z' + status: Published + - id: vb554a-bl1915 + categorization: COAT + name: Waterproof Jacket + description: 'Wind and rainproof, keeping you dry all year round.' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: 'ARRIS,SB6141' + name: Waterproof Jacket (Black) + quantity: 0 + isTaxEnabled: false + sku: 'ARRIS,SB6141' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-07T12:30:01Z' + - id: RTN66U-N9000 + name: Waterproof Jacket (Blue) + quantity: 0 + isTaxEnabled: false + sku: RTN66U-N9000 + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-07T12:30:01Z' + - id: TLWR841N + name: Waterproof Jacket (Red) + quantity: 0 + isTaxEnabled: false + sku: TLWR841N + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-07T12:30:01Z' + createdDate: '2021-02-07T12:30:01Z' + modifiedDate: '2023-01-09T09:12:11Z' + sourceModifiedDate: '2022-08-17T09:07:07Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-products + next: + href: /companies/6a59da96-e6d2-4c5c-ace7-65ba8be6a472/connections/58be1638-2c74-4ad4-8ff3-8c5b98b5f0fe/data/commerce-products?page=2&pageSize=2 + BigCommerce: + value: + results: + - id: '103' + categorization: 'Shop All, Utility' + name: '[Sample] Canvas Laundry Cart' + description: 'The last laundry cart you''ll ever buy. This industrial non-collapsable cart is constructed with a steel framed body using heavyweight canvas capped with a soft leather rim sitting on four smooth rolling casters. Keeps the grubby garments off the floor and almost makes laundry enjoyable. Can also be used as the ideal storage solution: many people find it ideal for children''s toys or a load of chopped firewood. Load it up and wheel it away. Natural Heavyweight Canvas with Vegetable Tanned Leather Rim Measure�' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '71' + name: '[Sample] Canvas Laundry Cart' + quantity: 0 + isTaxEnabled: false + sku: CLC + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2015-07-03T18:48:07Z' + modifiedDate: '2023-04-11T10:33:49Z' + sourceModifiedDate: '2022-06-16T07:59:46Z' + status: Published + - id: '104' + categorization: 'Shop All, Utility' + name: '[Sample] Utility Caddy' + description: 'This powder coated steel utility caddy ensures your cleaning essentials are stowed away in one spot ready for your household chores. Brushes, cloths, liquid soaps can all easily be stashed away. Also ideal to be used as a garden caddy to easily grab from the shed for a days work. Works well as a mop bucket too. The wood carrying handle ensures a comfortable grip when toting it from room to room. Measures 19 h x 36 w x 20 dia cm/7.5 h x 14.1 w x 7.8 dia in' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '72' + name: '[Sample] Utility Caddy' + quantity: 0 + isTaxEnabled: false + sku: OFSUC + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 45.95 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2015-07-03T18:49:26Z' + modifiedDate: '2023-04-11T10:33:49Z' + sourceModifiedDate: '2015-07-03T20:45:54Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 18 + _links: + current: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-products + next: + href: /companies/d1ebcf6d-f7f9-4841-8a06-fec12c492a48/connections/7c0a21e8-938a-40a4-b0f7-5ab5d46804b0/data/commerce-products?page=2&pageSize=2 + Clover: + value: + results: + - id: DJANHKK2AVEYY + name: Coffee + description: Coffee + productCategoryRefs: [] + isGiftCard: false + variants: + - id: DJANHKK2AVEYY + name: Coffee + quantity: 0 + isTaxEnabled: true + sku: '12222' + barcode: '1234' + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 3 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '2021-05-24T15:50:55Z' + status: Published + - id: NMZHKK6FKF6ZJ + name: Laptop + description: Cool Laptop + productCategoryRefs: [] + isGiftCard: false + variants: + - id: NMZHKK6FKF6ZJ + name: Laptop + quantity: 0 + isTaxEnabled: true + sku: '111' + barcode: '123' + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 1000 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '2021-05-24T08:19:14Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-products + next: + href: /companies/aae80eb3-1f56-41ca-a171-a59f9ee03b26/connections/4a5b633b-cd86-4715-a22b-62be98c4bcc5/data/commerce-products?page=2&pageSize=2 + Lightspeed K Trial: + value: + results: + - id: '647208621834539' + categorization: Alcoholic beverages + name: Alcoholic beverages + description: Alcoholic beverages + productCategoryRefs: + - id: '647208621834281' + name: Alcoholic beverages + isGiftCard: false + variants: [] + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-03-02T09:50:32Z' + status: Published + - id: '647208621834542' + categorization: NA beverages + name: NA beverages + description: NA beverages + productCategoryRefs: + - id: '647208621834282' + name: NA beverages + isGiftCard: false + variants: [] + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-03-02T09:50:32Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 39 + _links: + current: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-products + next: + href: /companies/36e3213b-02f6-4264-96ce-6dd53ea69e57/connections/278ba962-466a-452b-92b0-4bdee3a23463/data/commerce-products?page=2&pageSize=2 + PrestaShop: + value: + results: + - id: '1' + categorization: Home - Clothes - Men + name: Hummingbird printed t-shirt + description: 'Symbol of lightness and delicacy, the hummingbird evokes curiosity and joy. Studio Design'' PolyFaune collection features classic products with colorful patterns, inspired by the traditional japanese origamis. To wear with a chino or jeans. The sublimation textile printing process provides an exceptional color rendering and a color, guaranteed overtime.' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '8' + name: 'Hummingbird printed t-shirt (Size = XL, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '4' + name: 'Hummingbird printed t-shirt (Size = M, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '5' + name: 'Hummingbird printed t-shirt (Size = L, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '3' + name: 'Hummingbird printed t-shirt (Size = M, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '6' + name: 'Hummingbird printed t-shirt (Size = L, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '1' + name: 'Hummingbird printed t-shirt (Size = S, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '2' + name: 'Hummingbird printed t-shirt (Size = S, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '7' + name: 'Hummingbird printed t-shirt (Size = XL, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-09-02T06:00:49' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T06:00:49' + status: Published + - id: '10' + categorization: Home - Accessories - Home Accessories + name: Brown bear cushion + description: 'The brown bear cushion will add a graphic and colorful touch to your sofa, armchair or bed. Create a modern and zen atmosphere that inspires relaxation. Cover 100% cotton, machine washable at 60� / Filling 100% hypoallergenic polyester.' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '24' + name: Brown bear cushion (Color = White) + quantity: 0 + isTaxEnabled: true + sku: demo_16 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 18.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '25' + name: Brown bear cushion (Color = Black) + quantity: 0 + isTaxEnabled: true + sku: demo_16 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 18.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-09-02T06:00:49' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T06:00:49' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 22 + _links: + current: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-products + next: + href: /companies/2bf78e61-58ca-421a-a430-5dfa59cf15b0/connections/30774c1f-fdcd-491e-9e60-47e316b3ab9b/data/commerce-products?page=2&pageSize=2 + Shopify: + value: + results: + - id: '6595494117534' + categorization: Asus + name: Monitor + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '39444526694558' + name: Monitor + quantity: 0 + isTaxEnabled: true + sku: '' + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 150 + inventory: + totalQuantity: 91 + locations: [] + shippingRequired: true + createdDate: '2021-03-19T10:13:22Z' + createdDate: '2021-03-19T10:13:22Z' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2022-08-01T13:05:22Z' + status: Published + - id: '6595497066654' + categorization: Logitech + name: Mouse + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '39444533706910' + name: Mouse + quantity: 0 + isTaxEnabled: false + sku: '' + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 25 + inventory: + totalQuantity: 71 + locations: [] + shippingRequired: true + createdDate: '2021-03-19T10:14:01Z' + createdDate: '2021-03-19T10:14:01Z' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2022-08-01T13:05:22Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-products + next: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-products?page=2&pageSize=2 + Square: + value: + results: + - id: AX54KZQ3UAVCVPUMNEGFEU35 + categorization: Hardware + name: Monitor + productCategoryRefs: [] + isGiftCard: false + variants: + - id: A5BUT6SYUNYRSQ2R7GZ6UKN6 + name: Regular + quantity: 0 + isTaxEnabled: true + vatPercentage: 10 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-18T15:47:31Z' + createdDate: '2021-02-18T15:47:31Z' + modifiedDate: '2021-06-17T14:23:02Z' + sourceModifiedDate: '2021-02-18T15:47:31Z' + status: Unknown + - id: FYRIQNFTFRGQNQZGZG66MJWI + categorization: Furniture + name: Desk + productCategoryRefs: [] + isGiftCard: false + variants: + - id: VMKSQEABA3WIYGXNAV63JOTZ + name: Regular + quantity: 0 + isTaxEnabled: true + vatPercentage: 10 + prices: + - currency: GBP + unitPrice: 70 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-18T15:47:45Z' + createdDate: '2021-02-18T15:47:45Z' + modifiedDate: '2021-06-17T14:23:02Z' + sourceModifiedDate: '2021-02-18T15:47:45Z' + status: Unknown + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/25debd39-e024-41a1-a86c-4fd47f29c853/connections/d5071fdf-a769-48f3-b39e-e588d515bb83/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/25debd39-e024-41a1-a86c-4fd47f29c853/connections/d5071fdf-a769-48f3-b39e-e588d515bb83/data/commerce-products + next: + href: /companies/25debd39-e024-41a1-a86c-4fd47f29c853/connections/d5071fdf-a769-48f3-b39e-e588d515bb83/data/commerce-products?page=2&pageSize=2 + Stripe Test: + value: + results: + - id: prod_IaSbzLnxOHmC0i + name: Blue T Shirt + description: Nice cozy cotton t shirt + productCategoryRefs: [] + isGiftCard: false + variants: + - id: price_1ICJVEA8m8S1Gh7OIOCDOG8j + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 15 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-01-22T06:52:16Z' + - id: price_1ICJQgA8m8S1Gh7OfErQdx5R + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: USD + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-01-22T06:47:34Z' + - id: price_1HzHiCA8m8S1Gh7OXZVa6r3F + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 15 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2020-12-17T08:19:48Z' + createdDate: '2020-12-17T08:17:48Z' + modifiedDate: '2022-09-30T11:18:27Z' + sourceModifiedDate: '2021-01-22T06:52:17Z' + status: Published + - id: prod_IQ6G1MDsvUb87Y + name: Laptop + productCategoryRefs: [] + isGiftCard: false + variants: + - id: price_1HpG3tA8m8S1Gh7Oa6bGLvVD + name: Laptop - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 100 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2020-11-19T16:32:45Z' + createdDate: '2020-11-19T16:32:45Z' + modifiedDate: '2022-09-30T11:18:27Z' + sourceModifiedDate: '2022-05-12T23:31:33Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 4 + _links: + current: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-products + next: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-products?page=2&pageSize=2 + WooCommerce: + value: + results: + - id: '27' + categorization: Hardware + name: Monitor + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '27' + name: Monitor + quantity: 0 + isTaxEnabled: true + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 150 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-03-11T08:55:22' + createdDate: '2021-03-11T08:55:22' + modifiedDate: '2021-07-13T16:19:00Z' + sourceModifiedDate: '2021-03-11T09:03:15' + status: Published + - id: '28' + categorization: Hardware + name: Keyboard + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '28' + name: Keyboard + quantity: 0 + isTaxEnabled: true + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-03-11T09:02:58' + createdDate: '2021-03-11T09:02:58' + modifiedDate: '2021-07-13T16:19:00Z' + sourceModifiedDate: '2021-03-11T09:02:58' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-products + next: + href: /companies/010c6f53-8fc8-40ab-9ed5-41191cf9c6b5/connections/7545ca2e-5f58-4f98-8af2-3b2c38bb8074/data/commerce-products?page=2&pageSize=2 + Zettle: + value: + results: + - id: 9d21fd90-a34a-11eb-b574-ad6abe469b61 + categorization: Clothing + name: T-Shirt + productCategoryRefs: [] + isGiftCard: false + variants: + - id: bb9bcf30-a34a-11eb-b574-ad6abe469b61 + name: Medium + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: b919df40-a34a-11eb-b574-ad6abe469b61 + name: Large + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: bcb5cab0-a34a-11eb-b574-ad6abe469b61 + name: Small + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-04-22T09:12:09Z' + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2021-08-04T14:32:20Z' + status: Published + - id: e02c2930-a34a-11eb-b9db-8f5efc0924aa + categorization: Clothing + name: Hoodie + productCategoryRefs: [] + isGiftCard: false + variants: + - id: fa180e40-a34a-11eb-b9db-8f5efc0924aa + name: Medium + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: fc412fd0-a34a-11eb-b9db-8f5efc0924aa + name: Extra Large + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: f8a03b50-a34a-11eb-b9db-8f5efc0924aa + name: Small + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: fac1bbc0-a34a-11eb-b9db-8f5efc0924aa + name: Large + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-04-22T09:13:26Z' + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2021-08-04T14:31:58Z' + status: Published + pageNumber: 1 + pageSize: 2 + totalResults: 2 + _links: + current: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-products?page=1&pageSize=2 + self: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-products + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + description: "The *List products* endpoint returns a list of [products](https://docs.codat.io/lending-api#/schemas/Product) for a given company's connection.\n\n[Products](https://docs.codat.io/lending-api#/schemas/Product) are items in the company's inventory that are available for sale.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + '/companies/{companyId}/connections/{connectionId}/data/commerce-products/{productId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/productId' + get: + summary: Get product + tags: + - Sales + operationId: get-commerce-product + x-speakeasy-group: sales.products + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceProduct' + examples: + Amazon Seller Central: + value: + id: Chromecast + categorization: DEVICE + name: Chromecast + description: Cast from your phone to your TV with this all new chromecast. + productCategoryRefs: [] + isGiftCard: false + variants: + - id: packaging_asin_gating + name: Chromecast in a cardboard box + quantity: 0 + isTaxEnabled: false + sku: packaging_asin_gating + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 50 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-07T12:30:01Z' + createdDate: '2021-02-07T12:30:01Z' + modifiedDate: '2023-01-09T09:12:11Z' + sourceModifiedDate: '2022-08-17T09:07:07Z' + status: Published + BigCommerce: + value: + id: '103' + categorization: 'Shop All, Utility' + name: '[Sample] Canvas Laundry Cart' + description: 'The last laundry cart you''ll ever buy. This industrial non-collapsable cart is constructed with a steel framed body using heavyweight canvas capped with a soft leather rim sitting on four smooth rolling casters. Keeps the grubby garments off the floor and almost makes laundry enjoyable. Can also be used as the ideal storage solution: many people find it ideal for children''s toys or a load of chopped firewood. Load it up and wheel it away. Natural Heavyweight Canvas with Vegetable Tanned Leather Rim Measure�' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '71' + name: '[Sample] Canvas Laundry Cart' + quantity: 0 + isTaxEnabled: false + sku: CLC + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2015-07-03T18:48:07Z' + modifiedDate: '2023-04-11T10:33:49Z' + sourceModifiedDate: '2022-06-16T07:59:46Z' + status: Published + Clover: + value: + id: DJANHKK2AVEYY + name: Coffee + description: Coffee + productCategoryRefs: [] + isGiftCard: false + variants: + - id: DJANHKK2AVEYY + name: Coffee + quantity: 0 + isTaxEnabled: true + sku: '12222' + barcode: '1234' + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 3 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-01-09T11:01:03Z' + sourceModifiedDate: '2021-05-24T15:50:55Z' + status: Published + Lightspeed K Trial: + value: + id: '647208621834539' + categorization: Alcoholic beverages + name: Alcoholic beverages + description: Alcoholic beverages + productCategoryRefs: + - id: '647208621834281' + name: Alcoholic beverages + isGiftCard: false + variants: [] + createdDate: '0001-01-01T00:00:00' + modifiedDate: '2023-03-02T09:50:32Z' + status: Published + PrestaShop: + value: + id: '1' + categorization: Home - Clothes - Men + name: Hummingbird printed t-shirt + description: 'Symbol of lightness and delicacy, the hummingbird evokes curiosity and joy. Studio Design'' PolyFaune collection features classic products with colorful patterns, inspired by the traditional japanese origamis. To wear with a chino or jeans. The sublimation textile printing process provides an exceptional color rendering and a color, guaranteed overtime.' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '8' + name: 'Hummingbird printed t-shirt (Size = XL, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '4' + name: 'Hummingbird printed t-shirt (Size = M, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '5' + name: 'Hummingbird printed t-shirt (Size = L, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '3' + name: 'Hummingbird printed t-shirt (Size = M, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '6' + name: 'Hummingbird printed t-shirt (Size = L, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '1' + name: 'Hummingbird printed t-shirt (Size = S, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '2' + name: 'Hummingbird printed t-shirt (Size = S, Color = Black)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + - id: '7' + name: 'Hummingbird printed t-shirt (Size = XL, Color = White)' + quantity: 0 + isTaxEnabled: true + sku: demo_1 + vatPercentage: 6 + prices: + - currency: USD + unitPrice: 23.9 + inventory: + totalQuantity: 300 + locations: [] + shippingRequired: true + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-09-02T06:00:49' + modifiedDate: '2022-01-26T15:09:42Z' + sourceModifiedDate: '2021-09-02T06:00:49' + status: Published + Shopify: + value: + id: '6595494117534' + categorization: Asus + name: Monitor + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '39444526694558' + name: Monitor + quantity: 0 + isTaxEnabled: true + sku: '' + barcode: '' + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 150 + inventory: + totalQuantity: 91 + locations: [] + shippingRequired: true + createdDate: '2021-03-19T10:13:22Z' + createdDate: '2021-03-19T10:13:22Z' + modifiedDate: '2023-02-10T15:18:25Z' + sourceModifiedDate: '2022-08-01T13:05:22Z' + status: Published + Square: + value: + id: AX54KZQ3UAVCVPUMNEGFEU35 + categorization: Hardware + name: Monitor + productCategoryRefs: [] + isGiftCard: false + variants: + - id: A5BUT6SYUNYRSQ2R7GZ6UKN6 + name: Regular + quantity: 0 + isTaxEnabled: true + vatPercentage: 10 + prices: + - currency: GBP + unitPrice: 200 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '2021-02-18T15:47:31Z' + createdDate: '2021-02-18T15:47:31Z' + modifiedDate: '2021-06-17T14:23:02Z' + sourceModifiedDate: '2021-02-18T15:47:31Z' + status: Unknown + Stripe Test: + value: + id: prod_IaSbzLnxOHmC0i + name: Blue T Shirt + description: Nice cozy cotton t shirt + productCategoryRefs: [] + isGiftCard: false + variants: + - id: price_1ICJVEA8m8S1Gh7OIOCDOG8j + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 15 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-01-22T06:52:16Z' + - id: price_1ICJQgA8m8S1Gh7OfErQdx5R + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: USD + unitPrice: 30 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-01-22T06:47:34Z' + - id: price_1HzHiCA8m8S1Gh7OXZVa6r3F + name: Blue T Shirt - Standard Price + quantity: 0 + isTaxEnabled: false + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 15 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2020-12-17T08:19:48Z' + createdDate: '2020-12-17T08:17:48Z' + modifiedDate: '2022-09-30T11:18:27Z' + sourceModifiedDate: '2021-01-22T06:52:17Z' + status: Published + WooCommerce: + value: + id: '27' + categorization: Hardware + name: Monitor + description: '' + productCategoryRefs: [] + isGiftCard: false + variants: + - id: '27' + name: Monitor + quantity: 0 + isTaxEnabled: true + vatPercentage: 0 + prices: + - currency: GBP + unitPrice: 150 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: true + createdDate: '2021-03-11T08:55:22' + createdDate: '2021-03-11T08:55:22' + modifiedDate: '2021-07-13T16:19:00Z' + sourceModifiedDate: '2021-03-11T09:03:15' + status: Published + Zettle: + value: + id: 9d21fd90-a34a-11eb-b574-ad6abe469b61 + categorization: Clothing + name: T-Shirt + productCategoryRefs: [] + isGiftCard: false + variants: + - id: bb9bcf30-a34a-11eb-b574-ad6abe469b61 + name: Medium + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: b919df40-a34a-11eb-b574-ad6abe469b61 + name: Large + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + - id: bcb5cab0-a34a-11eb-b574-ad6abe469b61 + name: Small + quantity: 0 + isTaxEnabled: true + vatPercentage: 20 + prices: + - currency: GBP + unitPrice: 10 + inventory: + totalQuantity: 0 + locations: [] + shippingRequired: false + createdDate: '0001-01-01T00:00:00' + createdDate: '2021-04-22T09:12:09Z' + modifiedDate: '2021-10-27T15:22:37Z' + sourceModifiedDate: '2021-08-04T14:32:20Z' + status: Published + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get product* endpoint returns a single product for a given productId. + + [Products](https://docs.codat.io/lending-api#/schemas/Product) are items in the company's inventory that are available for sale. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/connections/{connectionId}/data/commerce-transactions': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: List transactions + tags: + - Sales + operationId: list-commerce-transactions + x-speakeasy-group: sales.transactions + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceTransactions' + examples: + Mollie: + value: + results: + - id: re_Azhe8TzfUK + totalAmount: -20 + currency: EUR + type: Refund + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-03-17T15:47:28Z' + - id: re_NPKEJhQveu + totalAmount: -60 + currency: EUR + type: Refund + createdDate: '2022-01-17T16:00:05' + modifiedDate: '2022-03-17T15:47:28Z' + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-transactions + next: + href: /companies/a68cb447-182d-4bbe-be1a-f526d11d69d5/connections/dfbf847b-cde8-4b00-b2f9-af51dec0d337/data/commerce-transactions?page=2&pageSize=2 + Mollie Test: + value: + results: + - id: re_Azhe8TzfUK + totalAmount: -20 + currency: EUR + type: Refund + subType: PaymentRefund + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-08-17T11:33:19Z' + - id: re_NPKEJhQveu + totalAmount: -60 + currency: EUR + type: Refund + subType: PaymentRefund + createdDate: '2022-01-17T16:00:05' + modifiedDate: '2022-08-17T11:33:19Z' + pageNumber: 1 + pageSize: 2 + totalResults: 7 + _links: + current: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-transactions + next: + href: /companies/b978f9fe-8d63-4cfc-b2c2-b61b72e22785/connections/d564f8fd-0766-4ab8-a427-7c893f9b9ff6/data/commerce-transactions?page=2&pageSize=2 + Shopify: + value: + results: + - id: ShopifyPayment-1633176289438 + totalAmount: 175 + currency: GBP + type: Payment + subType: charge + transactionSourceRef: + id: '3684116791454' + type: Order + createdDate: '2021-03-19T13:16:26' + modifiedDate: '2023-02-10T15:18:23Z' + sourceModifiedDate: '2021-03-19T13:16:26' + - id: 'ShopifyPayment-1633176289438:Fee' + totalAmount: -4.05 + currency: GBP + type: PaymentFee + subType: charge + transactionSourceRef: + id: '3684116791454' + type: Order + createdDate: '2021-03-19T13:16:26' + modifiedDate: '2023-02-10T15:18:23Z' + sourceModifiedDate: '2021-03-19T13:16:26' + pageNumber: 1 + pageSize: 2 + totalResults: 64 + _links: + current: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-transactions + next: + href: /companies/0bc1cc44-c6d2-4537-9591-b1ad6b5e3c94/connections/d38fa6d3-d712-4cf6-9d9d-f03bacd87595/data/commerce-transactions?page=2&pageSize=2 + Stripe Test: + value: + results: + - id: txn_1HpGQUA8m8S1Gh7OR21pB0Yj + totalAmount: 50 + currency: GBP + type: Payment + subType: charge + transactionSourceRef: + id: ch_1HpGQUA8m8S1Gh7Ot4WDTus5 + type: Payment + createdDate: '2020-11-19T16:56:06Z' + modifiedDate: '2022-09-30T11:18:28Z' + - id: 'txn_1HpGQUA8m8S1Gh7OR21pB0Yj:Stripe processing fees' + totalAmount: -0.9 + currency: GBP + type: PaymentFee + subType: stripe_fee + transactionSourceRef: + id: ch_1HpGQUA8m8S1Gh7Ot4WDTus5 + type: Payment + createdDate: '2020-11-19T16:56:06Z' + modifiedDate: '2022-09-30T11:18:28Z' + pageNumber: 1 + pageSize: 2 + totalResults: 70 + _links: + current: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-transactions + next: + href: /companies/8206e78e-e340-411e-b315-473c4ab73b48/connections/43e58373-0a1d-44a0-97f0-9fa9993a14fa/data/commerce-transactions?page=2&pageSize=2 + SumUp: + value: + results: + - id: 46d36a64-ea48-4e37-9340-3548cbf3ca2f + totalAmount: 15 + currency: GBP + type: Payment + subType: PAYMENT + createdDate: '2021-03-26T21:09:59Z' + modifiedDate: '2022-09-14T10:58:03Z' + - id: 471914a4-a82f-4fc4-b39b-9986fd706d26 + totalAmount: 215 + currency: GBP + type: Payment + subType: PAYMENT + createdDate: '2021-03-30T12:22:14Z' + modifiedDate: '2022-09-14T10:58:03Z' + pageNumber: 1 + pageSize: 2 + totalResults: 3 + _links: + current: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-transactions + next: + href: /companies/e170dbe2-be50-474f-b449-82add37108de/connections/1e631dd5-a30b-4bad-ad5c-315c9743535b/data/commerce-transactions?page=2&pageSize=2 + Zettle: + value: + results: + - id: 'PAYMENT:09b94cfc-2d98-11eb-8021-0e1b9dcbeca1' + totalAmount: 25 + currency: GBP + type: Payment + transactionSourceRef: + id: 09b94cfc-2d98-11eb-8021-0e1b9dcbeca1 + type: Unknown + createdDate: '2020-11-23T14:27:38Z' + modifiedDate: '2021-10-27T15:23:04Z' + sourceModifiedDate: '2020-11-25T23:10:01Z' + - id: 'PAYMENT:226580d6-2d98-11eb-a35c-fed5e63de507' + totalAmount: 58.5 + currency: GBP + type: Payment + transactionSourceRef: + id: 226580d6-2d98-11eb-a35c-fed5e63de507 + type: Unknown + createdDate: '2020-11-23T14:28:20Z' + modifiedDate: '2021-10-27T15:23:04Z' + sourceModifiedDate: '2020-11-25T23:10:02Z' + pageNumber: 1 + pageSize: 2 + totalResults: 16 + _links: + current: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-transactions?page=1&pageSize=2 + self: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-transactions + next: + href: /companies/9d448ad0-4508-47fc-bd3b-6950493151f1/connections/c7baa8da-3302-464b-8aa1-edcd4c900902/data/commerce-transactions?page=2&pageSize=2 + '400': + $ref: '#/components/responses/Malformed-Query' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *List transactions* endpoint returns a list of [transactions](https://docs.codat.io/lending-api#/schemas/Transaction) for a given company's connection.\n\n[Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) detail all financial affairs recorded in the commerce or point of sale system.\n\nBefore using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).\n " + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + '/companies/{companyId}/connections/{connectionId}/data/commerce-transactions/{transactionId}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - name: transactionId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a transaction. + get: + summary: Get transaction + tags: + - Sales + operationId: get-commerce-transaction + x-speakeasy-group: sales.transactions + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CommerceTransaction' + examples: + Mollie: + value: + id: re_Azhe8TzfUK + totalAmount: -20 + currency: EUR + type: Refund + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-03-17T15:47:28Z' + Mollie Test: + value: + id: re_Azhe8TzfUK + totalAmount: -20 + currency: EUR + type: Refund + subType: PaymentRefund + createdDate: '2022-01-17T16:00:46' + modifiedDate: '2022-08-17T11:33:19Z' + Shopify: + value: + id: ShopifyPayment-1633176289438 + totalAmount: 175 + currency: GBP + type: Payment + subType: charge + transactionSourceRef: + id: '3684116791454' + type: Order + createdDate: '2021-03-19T13:16:26' + modifiedDate: '2023-02-10T15:18:23Z' + sourceModifiedDate: '2021-03-19T13:16:26' + Stripe Test: + value: + id: txn_1HpGQUA8m8S1Gh7OR21pB0Yj + totalAmount: 50 + currency: GBP + type: Payment + subType: charge + transactionSourceRef: + id: ch_1HpGQUA8m8S1Gh7Ot4WDTus5 + type: Payment + createdDate: '2020-11-19T16:56:06Z' + modifiedDate: '2022-09-30T11:18:28Z' + SumUp: + value: + id: 46d36a64-ea48-4e37-9340-3548cbf3ca2f + totalAmount: 15 + currency: GBP + type: Payment + subType: PAYMENT + createdDate: '2021-03-26T21:09:59Z' + modifiedDate: '2022-09-14T10:58:03Z' + Zettle: + value: + id: 'PAYMENT:09b94cfc-2d98-11eb-8021-0e1b9dcbeca1' + totalAmount: 25 + currency: GBP + type: Payment + transactionSourceRef: + id: 09b94cfc-2d98-11eb-8021-0e1b9dcbeca1 + type: Unknown + createdDate: '2020-11-23T14:27:38Z' + modifiedDate: '2021-10-27T15:23:04Z' + sourceModifiedDate: '2020-11-25T23:10:01Z' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '409': + $ref: '#/components/responses/Conflict' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: | + The *Get transaction* endpoint returns a single transaction for a given transactionId. + + [Transactions](https://docs.codat.io/lending-api#/schemas/Transaction) detail all financial affairs recorded in the commerce or point of sale system. + + Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + '/companies/{companyId}/files': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - File upload + summary: List all files uploaded by a company + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Files' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "\uFEFF\x54\x68\x65\x20\x2A\x4C\x69\x73\x74\x20\x66\x69\x6C\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\x61\x6C\x6C\x20\x66\x69\x6C\x65\x73\x20\x75\x70\x6C\x6F\x61\x64\x65\x64\x20\x74\x6F\x20\x43\x6F\x64\x61\x74\x20\x62\x79\x20\x74\x68\x65\x20\x53\x4D\x42\x2E\x20" + operationId: list-files + x-speakeasy-name-override: list-uploaded + '/companies/{companyId}/files/download': + parameters: + - $ref: '#/components/parameters/companyId' + get: + tags: + - File upload + summary: Download all files for a company + parameters: + - name: date + in: query + schema: + $ref: '#/components/schemas/DateTime' + description: Only download files uploaded on this date. + responses: + '200': + description: Success + content: + application/octet-stream: + x-speakeasy-usage-example: true + schema: + title: Data + type: string + format: binary + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: The *Download files* endpoint downloads all files that have been uploaded by to SMB to Codat. A `date` may be specified to download any files uploaded on the date provided. + operationId: download-files + x-speakeasy-name-override: download + '/companies/{companyId}/connections/{connectionId}/files': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - File upload + summary: Upload files for a company + responses: + '200': + description: Success + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/FileUpload' + description: |- + The *Upload files* endpoint uploads multiple files provided by the SMB to Codat. This may include personal identity documents, pitch decks, contracts, or files with accounting and banking data. + + Uploaded files must meet the following requirements: + + - Up to 20 files can be uploaded at a time. + - PDF, XLS, XLSX, XLSB, CSV, DOC, DOCX, PPT, PPTX, JPEG, JPG, and PNG files can be uploaded. + - Each file can be up to 10MB in size. + operationId: upload-files + x-speakeasy-name-override: upload + '/companies/{companyId}/connections/{connectionId}/options/bankAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create/update bank account model + tags: + - Loan writeback + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + Dynamics 365 Business Central: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + validation: + warnings: [] + information: + - field: AccountName + details: 'Needs to be of the format ''{No.}-{Name}''' + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: false + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: Bank Account Posting Group with Nominal Account must exist + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: [] + information: + - field: SortCode + details: Must have a length between 0 and 20 characters + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: false + overdraftLimit: + type: Number + displayName: Overdraft Limit + description: The pre-arranged overdraft limit of the account + required: false + validation: + warnings: [] + information: + - field: OverdraftLimit + details: Default value is 0 + required: true + Exact (Netherlands): + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: true + validation: + warnings: + - field: AccountNumber + details: Should not exceed the maximum length of 14 characters if the specified currency is GBP. + information: [] + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: + - field: SortCode + details: Must be 6 characters long if the specified currency is GBP. + - field: SortCode + details: Must be provided if the specified currency is GBP. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: false + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + required: true + Exact (UK): + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: true + validation: + warnings: + - field: AccountNumber + details: Should not exceed the maximum length of 14 characters if the specified currency is GBP. + information: [] + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: + - field: SortCode + details: Must be 6 characters long if the specified currency is GBP. + - field: SortCode + details: Must be provided if the specified currency is GBP. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: false + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + required: true + FreeAgent: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: + - field: SortCode + details: Must have a length between 0 and 8 characters + information: [] + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: false + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: false + currency: + type: String + displayName: Currency + description: The currency of the bank account + options: + - value: AED + type: String + displayName: AED + required: false + - value: AMD + type: String + displayName: AMD + required: false + - value: AOA + type: String + displayName: AOA + required: false + - value: ARS + type: String + displayName: ARS + required: false + - value: AUD + type: String + displayName: AUD + required: false + - value: AWG + type: String + displayName: AWG + required: false + - value: AZN + type: String + displayName: AZN + required: false + - value: BBD + type: String + displayName: BBD + required: false + - value: BDT + type: String + displayName: BDT + required: false + - value: BGN + type: String + displayName: BGN + required: false + - value: BRL + type: String + displayName: BRL + required: false + - value: BWP + type: String + displayName: BWP + required: false + - value: CAD + type: String + displayName: CAD + required: false + - value: CHF + type: String + displayName: CHF + required: false + - value: CLP + type: String + displayName: CLP + required: false + - value: CNY + type: String + displayName: CNY + required: false + - value: COP + type: String + displayName: COP + required: false + - value: CRC + type: String + displayName: CRC + required: false + - value: CUC + type: String + displayName: CUC + required: false + - value: CUP + type: String + displayName: CUP + required: false + - value: CZK + type: String + displayName: CZK + required: false + - value: DKK + type: String + displayName: DKK + required: false + - value: DOP + type: String + displayName: DOP + required: false + - value: EGP + type: String + displayName: EGP + required: false + - value: EUR + type: String + displayName: EUR + required: false + - value: FJD + type: String + displayName: FJD + required: false + - value: GBP + type: String + displayName: GBP + required: false + - value: GEL + type: String + displayName: GEL + required: false + - value: GHS + type: String + displayName: GHS + required: false + - value: GTQ + type: String + displayName: GTQ + required: false + - value: GYD + type: String + displayName: GYD + required: false + - value: HKD + type: String + displayName: HKD + required: false + - value: HNL + type: String + displayName: HNL + required: false + - value: HRK + type: String + displayName: HRK + required: false + - value: HUF + type: String + displayName: HUF + required: false + - value: IDR + type: String + displayName: IDR + required: false + - value: ILS + type: String + displayName: ILS + required: false + - value: INR + type: String + displayName: INR + required: false + - value: ISK + type: String + displayName: ISK + required: false + - value: JMD + type: String + displayName: JMD + required: false + - value: JPY + type: String + displayName: JPY + required: false + - value: KES + type: String + displayName: KES + required: false + - value: KRW + type: String + displayName: KRW + required: false + - value: KWD + type: String + displayName: KWD + required: false + - value: KYD + type: String + displayName: KYD + required: false + - value: KZT + type: String + displayName: KZT + required: false + - value: LAK + type: String + displayName: LAK + required: false + - value: LBP + type: String + displayName: LBP + required: false + - value: LKR + type: String + displayName: LKR + required: false + - value: LTL + type: String + displayName: LTL + required: false + - value: LVL + type: String + displayName: LVL + required: false + - value: MAD + type: String + displayName: MAD + required: false + - value: MDL + type: String + displayName: MDL + required: false + - value: MGA + type: String + displayName: MGA + required: false + - value: MUR + type: String + displayName: MUR + required: false + - value: MVR + type: String + displayName: MVR + required: false + - value: MWK + type: String + displayName: MWK + required: false + - value: MXN + type: String + displayName: MXN + required: false + - value: MYR + type: String + displayName: MYR + required: false + - value: MZN + type: String + displayName: MZN + required: false + - value: NAD + type: String + displayName: NAD + required: false + - value: NGN + type: String + displayName: NGN + required: false + - value: NOK + type: String + displayName: NOK + required: false + - value: NPR + type: String + displayName: NPR + required: false + - value: NZD + type: String + displayName: NZD + required: false + - value: OMR + type: String + displayName: OMR + required: false + - value: PEN + type: String + displayName: PEN + required: false + - value: PHP + type: String + displayName: PHP + required: false + - value: PKR + type: String + displayName: PKR + required: false + - value: PLN + type: String + displayName: PLN + required: false + - value: QAR + type: String + displayName: QAR + required: false + - value: RON + type: String + displayName: RON + required: false + - value: RSD + type: String + displayName: RSD + required: false + - value: RUB + type: String + displayName: RUB + required: false + - value: RWF + type: String + displayName: RWF + required: false + - value: SAR + type: String + displayName: SAR + required: false + - value: SCR + type: String + displayName: SCR + required: false + - value: SEK + type: String + displayName: SEK + required: false + - value: SGD + type: String + displayName: SGD + required: false + - value: THB + type: String + displayName: THB + required: false + - value: TND + type: String + displayName: TND + required: false + - value: TRY + type: String + displayName: TRY + required: false + - value: TTD + type: String + displayName: TTD + required: false + - value: TWD + type: String + displayName: TWD + required: false + - value: TZS + type: String + displayName: TZS + required: false + - value: UAH + type: String + displayName: UAH + required: false + - value: UGX + type: String + displayName: UGX + required: false + - value: USD + type: String + displayName: USD + required: false + - value: UYU + type: String + displayName: UYU + required: false + - value: VEF + type: String + displayName: VEF + required: false + - value: VND + type: String + displayName: VND + required: false + - value: VUV + type: String + displayName: VUV + required: false + - value: XAF + type: String + displayName: XAF + required: false + - value: XCD + type: String + displayName: XCD + required: false + - value: XOF + type: String + displayName: XOF + required: false + - value: ZAR + type: String + displayName: ZAR + required: false + - value: ZMK + type: String + displayName: ZMK + required: false + required: true + balance: + type: Number + displayName: Balance + description: The balance of the bank account + required: false + validation: + warnings: [] + information: + - field: Balance + details: 'The opening balance, in the account currency' + institution: + type: String + displayName: Institution + description: The institution of the bank account + required: false + required: true + KashFlow: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Account Name + description: Name of the bank account as it appears in Kashflow. + required: true + balance: + type: Number + displayName: Balance + description: 'The opening balance, in the account currency.' + required: false + currency: + type: String + displayName: Currency + description: The currency of the bank account. + required: true + required: true + QuickBooks Desktop: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: Max length of 7 characters. + information: [] + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + validation: + warnings: + - field: AccountName + details: Max length of 31 characters. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: false + validation: + warnings: + - field: Currency + details: 'The currency must match the base currency of the QuickBooks Desktop company unless the FullyQualifiedCategory is ''Asset.AccountsReceivable'',''Liability.AccountsPayable'' or ''Liability.CreditCard''' + - field: Currency + details: Must be a three letter ISO code that matches an existing active currency in the QuickBooks Desktop company + - field: Currency + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + information: + - field: Currency + details: 'If not set, will default to the base currency of the QuickBooks Desktop company' + balance: + type: Number + displayName: Balance + description: The balance of the bank account + required: false + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Account Name + description: Name of account as it appears in the chart of accounts or general ledger. + required: true + accountNumber: + type: String + displayName: Account Number + description: User-defined account number to help the user in identifying the account within the chart-of-accounts and in deciding what should be posted to the account. + required: true + currency: + type: String + displayName: Currency + description: Currency of the bank account. + required: true + required: true + Sage Business Cloud Accounting: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + validation: + warnings: [] + information: + - field: AccountName + details: Must be provided. + - field: AccountName + details: Should not be longer than 50 characters. + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: true + validation: + warnings: [] + information: + - field: Currency + details: Must be provided. + - field: Currency + details: Must match the company's base currency. + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: false + validation: + warnings: [] + information: + - field: SortCode + details: Should be a 6 digit number. + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: false + validation: + warnings: [] + information: + - field: AccountNumber + details: Should not be longer than 25 characters. + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: false + validation: + warnings: [] + information: + - field: IBan + details: Should be in the international bank account number format. + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: Should be a number between 1 and 99999999. + required: true + Sandbox: + value: + type: Object + displayName: Bank Account + description: An account that bank transactions may be recorded against + properties: + accountName: + type: String + displayName: Name + description: The name of the bank account in the originating system + required: true + accountType: + type: String + displayName: Account Type + description: The type of account + required: true + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + sortCode: + type: String + displayName: Sort Code + description: The sort code for the bank account + required: true + accountNumber: + type: String + displayName: Account Number + description: The account number for the bank account + required: true + iBan: + type: String + displayName: IBAN + description: The international bank account number of the account. Often used when making or receiving international payments + required: true + currency: + type: String + displayName: Currency + description: The currency of the bank account + required: true + balance: + type: Number + displayName: Balance + description: The balance of the bank account + required: true + availableBalance: + type: Number + displayName: Available Balance + description: The available balance of the bank account + required: true + overdraftLimit: + type: Number + displayName: Overdraft Limit + description: The pre-arranged overdraft limit of the account + required: true + institution: + type: String + displayName: Institution + description: The institution of the bank account + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-update-bankAccounts-model + x-speakeasy-group: loan-writeback.bank-accounts + 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/lending-api#/schemas/BankAccount) for a given company and integration.\r\n\r\n[Bank accounts](https://docs.codat.io/lending-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': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + summary: Create bank account + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingBankAccount' + examples: {} + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateBankAccountResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: "The *Create bank account* endpoint creates a new [bank account](https://docs.codat.io/lending-api#/schemas/BankAccount) for a given company's connection.\r\n\r\n[Bank accounts](https://docs.codat.io/lending-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/lending-api#/operations/get-create-update-bankAccounts-model)." + operationId: create-bank-account + x-speakeasy-group: loan-writeback.bank-accounts + '/companies/{companyId}/connections/{connectionId}/options/chartOfAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create account model + tags: + - Loan writeback + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + Exact (Netherlands): + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: [] + information: + - field: NominalCode + details: Must be provided. + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: [] + information: + - field: Name + details: Must be provided. + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Assets.Cash + type: String + displayName: Asset.Assets.Cash + required: false + - value: Asset.Assets.Bank + type: String + displayName: Asset.Assets.Bank + required: false + - value: Asset.Assets.PaymentServices + type: String + displayName: Asset.Assets.PaymentServices + required: false + - value: Asset.Assets.AccountsReceivable + type: String + displayName: Asset.Assets.AccountsReceivable + required: false + - value: Liability.EquityAndLiabilities.AccountsPayable + type: String + displayName: Liability.EquityAndLiabilities.AccountsPayable + required: false + - value: Asset.Assets.VAT + type: String + displayName: Asset.Assets.VAT + required: false + - value: Liability.EquityAndLiabilities.EmployeesPayable + type: String + displayName: Liability.EquityAndLiabilities.EmployeesPayable + required: false + - value: Asset.Assets.PrepaidExpenses + type: String + displayName: Asset.Assets.PrepaidExpenses + required: false + - value: Liability.EquityAndLiabilities.AccruedExpenses + type: String + displayName: Liability.EquityAndLiabilities.AccruedExpenses + required: false + - value: Liability.EquityAndLiabilities.IncomeTaxesPayable + type: String + displayName: Liability.EquityAndLiabilities.IncomeTaxesPayable + required: false + - value: Asset.Assets.FixedAssets + type: String + displayName: Asset.Assets.FixedAssets + required: false + - value: Asset.Assets.OtherAssets + type: String + displayName: Asset.Assets.OtherAssets + required: false + - value: Asset.Assets.AccumulatedDeprecation + type: String + displayName: Asset.Assets.AccumulatedDeprecation + required: false + - value: Asset.Assets.Inventory + type: String + displayName: Asset.Assets.Inventory + required: false + - value: Equity.EquityAndLiabilities.CapitalStock + type: String + displayName: Equity.EquityAndLiabilities.CapitalStock + required: false + - value: Equity.EquityAndLiabilities.RetainedEarnings + type: String + displayName: Equity.EquityAndLiabilities.RetainedEarnings + required: false + - value: Liability.EquityAndLiabilities.LongTermDebt + type: String + displayName: Liability.EquityAndLiabilities.LongTermDebt + required: false + - value: Liability.EquityAndLiabilities.CurrentPortionOfDebt + type: String + displayName: Liability.EquityAndLiabilities.CurrentPortionOfDebt + required: false + - value: Unknown.EquityAndLiabilities.Intercompany + type: String + displayName: Unknown.EquityAndLiabilities.Intercompany + required: false + - value: Unknown.General.General + type: String + displayName: Unknown.General.General + required: false + - value: Income.NetIncome.Revenue + type: String + displayName: Income.NetIncome.Revenue + required: false + - value: Expense.NetIncome.CostOfGoods + type: String + displayName: Expense.NetIncome.CostOfGoods + required: false + - value: Expense.NetIncome.OtherCosts + type: String + displayName: Expense.NetIncome.OtherCosts + required: false + - value: Expense.NetIncome.SalesGeneralAdministrativeExpenses + type: String + displayName: Expense.NetIncome.SalesGeneralAdministrativeExpenses + required: false + - value: Expense.NetIncome.DeprecationCosts + type: String + displayName: Expense.NetIncome.DeprecationCosts + required: false + - value: Expense.NetIncome.ResearchAndDevelopment + type: String + displayName: Expense.NetIncome.ResearchAndDevelopment + required: false + - value: Expense.NetIncome.EmployeeCosts + type: String + displayName: Expense.NetIncome.EmployeeCosts + required: false + - value: Expense.NetIncome.EmploymentCosts + type: String + displayName: Expense.NetIncome.EmploymentCosts + required: false + - value: Expense.ExceptionalIncome.ExceptionalCosts + type: String + displayName: Expense.ExceptionalIncome.ExceptionalCosts + required: false + - value: Income.ExceptionalIncome.ExceptionalIncome + type: String + displayName: Income.ExceptionalIncome.ExceptionalIncome + required: false + - value: Expense.ExceptionalIncome.IncomeTaxes + type: String + displayName: Expense.ExceptionalIncome.IncomeTaxes + required: false + - value: Income.ExceptionalIncome.InterestIncome + type: String + displayName: Income.ExceptionalIncome.InterestIncome + required: false + required: true + validation: + warnings: [] + information: + - field: FullyQualifiedCategory + details: Must be provided. + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Pending + type: String + displayName: Pending + required: false + - value: Unknown + type: String + displayName: Unknown + required: false + required: true + validation: + warnings: [] + information: + - field: Status + details: Must be provided. + required: true + Exact (UK): + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: [] + information: + - field: NominalCode + details: Must be provided. + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: [] + information: + - field: Name + details: Must be provided. + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Assets.Cash + type: String + displayName: Asset.Assets.Cash + required: false + - value: Asset.Assets.Bank + type: String + displayName: Asset.Assets.Bank + required: false + - value: Asset.Assets.PaymentServices + type: String + displayName: Asset.Assets.PaymentServices + required: false + - value: Asset.Assets.AccountsReceivable + type: String + displayName: Asset.Assets.AccountsReceivable + required: false + - value: Liability.EquityAndLiabilities.AccountsPayable + type: String + displayName: Liability.EquityAndLiabilities.AccountsPayable + required: false + - value: Asset.Assets.VAT + type: String + displayName: Asset.Assets.VAT + required: false + - value: Liability.EquityAndLiabilities.EmployeesPayable + type: String + displayName: Liability.EquityAndLiabilities.EmployeesPayable + required: false + - value: Asset.Assets.PrepaidExpenses + type: String + displayName: Asset.Assets.PrepaidExpenses + required: false + - value: Liability.EquityAndLiabilities.AccruedExpenses + type: String + displayName: Liability.EquityAndLiabilities.AccruedExpenses + required: false + - value: Liability.EquityAndLiabilities.IncomeTaxesPayable + type: String + displayName: Liability.EquityAndLiabilities.IncomeTaxesPayable + required: false + - value: Asset.Assets.FixedAssets + type: String + displayName: Asset.Assets.FixedAssets + required: false + - value: Asset.Assets.OtherAssets + type: String + displayName: Asset.Assets.OtherAssets + required: false + - value: Asset.Assets.AccumulatedDeprecation + type: String + displayName: Asset.Assets.AccumulatedDeprecation + required: false + - value: Asset.Assets.Inventory + type: String + displayName: Asset.Assets.Inventory + required: false + - value: Equity.EquityAndLiabilities.CapitalStock + type: String + displayName: Equity.EquityAndLiabilities.CapitalStock + required: false + - value: Equity.EquityAndLiabilities.RetainedEarnings + type: String + displayName: Equity.EquityAndLiabilities.RetainedEarnings + required: false + - value: Liability.EquityAndLiabilities.LongTermDebt + type: String + displayName: Liability.EquityAndLiabilities.LongTermDebt + required: false + - value: Liability.EquityAndLiabilities.CurrentPortionOfDebt + type: String + displayName: Liability.EquityAndLiabilities.CurrentPortionOfDebt + required: false + - value: Unknown.EquityAndLiabilities.Intercompany + type: String + displayName: Unknown.EquityAndLiabilities.Intercompany + required: false + - value: Unknown.General.General + type: String + displayName: Unknown.General.General + required: false + - value: Income.NetIncome.Revenue + type: String + displayName: Income.NetIncome.Revenue + required: false + - value: Expense.NetIncome.CostOfGoods + type: String + displayName: Expense.NetIncome.CostOfGoods + required: false + - value: Expense.NetIncome.OtherCosts + type: String + displayName: Expense.NetIncome.OtherCosts + required: false + - value: Expense.NetIncome.SalesGeneralAdministrativeExpenses + type: String + displayName: Expense.NetIncome.SalesGeneralAdministrativeExpenses + required: false + - value: Expense.NetIncome.DeprecationCosts + type: String + displayName: Expense.NetIncome.DeprecationCosts + required: false + - value: Expense.NetIncome.ResearchAndDevelopment + type: String + displayName: Expense.NetIncome.ResearchAndDevelopment + required: false + - value: Expense.NetIncome.EmployeeCosts + type: String + displayName: Expense.NetIncome.EmployeeCosts + required: false + - value: Expense.NetIncome.EmploymentCosts + type: String + displayName: Expense.NetIncome.EmploymentCosts + required: false + - value: Expense.ExceptionalIncome.ExceptionalCosts + type: String + displayName: Expense.ExceptionalIncome.ExceptionalCosts + required: false + - value: Income.ExceptionalIncome.ExceptionalIncome + type: String + displayName: Income.ExceptionalIncome.ExceptionalIncome + required: false + - value: Expense.ExceptionalIncome.IncomeTaxes + type: String + displayName: Expense.ExceptionalIncome.IncomeTaxes + required: false + - value: Income.ExceptionalIncome.InterestIncome + type: String + displayName: Income.ExceptionalIncome.InterestIncome + required: false + required: true + validation: + warnings: [] + information: + - field: FullyQualifiedCategory + details: Must be provided. + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Pending + type: String + displayName: Pending + required: false + - value: Unknown + type: String + displayName: Unknown + required: false + required: true + validation: + warnings: [] + information: + - field: Status + details: Must be provided. + required: true + MYOB AccountRight and Essentials: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: 'If alphanumeric is supported, must be between 1 and 10 characters. Otherwise format is x-xxxx' + information: [] + name: + type: String + displayName: Name + description: Name of the account + required: false + validation: + warnings: + - field: Name + details: Must have a length between 1 and 60 characters + information: [] + description: + type: String + displayName: Description + description: Description of the account + required: false + validation: + warnings: + - field: Description + details: Must have a length between 1 and 255 characters + information: [] + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Bank + type: String + displayName: Bank + required: false + - value: Asset.AccountReceivable + type: String + displayName: Accounts Receivable + required: false + - value: Asset.OtherCurrentAsset + type: String + displayName: Other Current Asset + required: false + - value: Asset.FixedAsset + type: String + displayName: Fixed Asset + required: false + - value: Asset.OtherAsset + type: String + displayName: Other Asset + required: false + - value: Asset.CashAndBank + type: String + displayName: Cash + required: false + - value: Asset.Property Plant and Equipment + type: String + displayName: Equipment Machinery + required: false + - value: Liability.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.OtherCurrentLiability + type: String + displayName: Other Current Liability + required: false + - value: Liability.LongTermLiability + type: String + displayName: Long Term Liability + required: false + - value: Liability.OtherLiability + type: String + displayName: Other Liability + required: false + - value: Equity + type: String + displayName: Equity + required: false + - value: Equity.Equity + type: String + displayName: Retained Earnings + required: false + - value: Equity.Equity.RetainedEarnings + type: String + displayName: Retained Earnings + required: false + - value: Equity.Owner's Equity + type: String + displayName: Retained Earnings + required: false + - value: Income + type: String + displayName: Income + required: false + - value: OtherIncome + type: String + displayName: Other Income + required: false + - value: Expense + type: String + displayName: Expense + required: false + - value: Expense.Expense + type: String + displayName: Sales Marketing + required: false + - value: Expense.Expense.Insurance + type: String + displayName: General Administrative + required: false + - value: Expense.Overhead + type: String + displayName: General Administrative + required: false + - value: Expense.Expense.RepairMaintenance + type: String + displayName: Repairs Maintenance + required: false + - value: OtherExpense + type: String + displayName: Other Expense + required: false + - value: CostOfSales + type: String + displayName: Cost of Sales + required: false + - value: Cost Of Goods Sold.Cost of Sales + type: String + displayName: Other + required: false + required: true + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + required: true + QuickBooks Desktop: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: Max length of 7 characters. + information: [] + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: + - field: Name + details: Max length of 31 characters. + information: [] + description: + type: String + displayName: Description + description: Description of the account + required: false + validation: + warnings: + - field: Description + details: Max length of 200 characters. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the account + required: false + validation: + warnings: + - field: Currency + details: 'The currency must match the base currency of the QuickBooks Desktop company unless the FullyQualifiedCategory is ''Asset.AccountsReceivable'',''Liability.AccountsPayable'' or ''Liability.CreditCard''' + - field: Currency + details: Must be a three letter ISO code that matches an existing active currency in the QuickBooks Desktop company + - field: Currency + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + information: + - field: Currency + details: 'If not set, will default to the base currency of the QuickBooks Desktop company' + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.AccountsReceivable + type: String + displayName: Account Receivable + required: false + - value: Asset.FixedAsset + type: String + displayName: Fixed Asset + required: false + - value: Asset.OtherCurrentAsset + type: String + displayName: Other Current Asset + required: false + - value: Asset.OtherAsset + type: String + displayName: Other Asset + required: false + - value: Income.Income + type: String + displayName: Income + required: false + - value: Income.OtherIncome + type: String + displayName: Other Income + required: false + - value: Liability.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.LongTermLiability + type: String + displayName: Long Term Liability + required: false + - value: Liability.OtherCurrentLiability + type: String + displayName: Other Current Liability + required: false + - value: Liability.CostOfGoodsSold + type: String + displayName: Cost Of Goods Sold + required: false + - value: Equity.Equity + type: String + displayName: Equity + required: false + - value: Expense.Expense + type: String + displayName: Expense + required: false + - value: Expense.OtherExpense + type: String + displayName: Other Expense + required: false + required: true + currentBalance: + type: Number + displayName: Current Balance + description: The current balance in the account + required: false + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: If included must have a length between 1 and 7 characters + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: + - field: Name + details: Must have a length between 1 and 100 characters + information: [] + currency: + type: String + displayName: Currency + description: The currency of the account + required: false + validation: + warnings: [] + information: + - field: Currency + details: When not specified company base currency will be used + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Bank.CashOnHand + type: String + displayName: Cash On Hand + required: false + - value: Asset.Bank.Checking + type: String + displayName: Checking + required: false + - value: Asset.Bank.MoneyMarket + type: String + displayName: Money Market + required: false + - value: Asset.Bank.RentsHeldInTrust + type: String + displayName: Rents Held In Trust + required: false + - value: Asset.Bank.Savings + type: String + displayName: Savings + required: false + - value: Asset.Bank.TrustAccounts + type: String + displayName: Trust Accounts + required: false + - value: Asset.Bank.CashAndCashEquivalents + type: String + displayName: Cash And Cash Equivalents + required: false + - value: Asset.Bank.OtherEarmarkedBankAccounts + type: String + displayName: Other Earmarked Bank Accounts + required: false + - value: Asset.Other Current Asset.AllowanceForBadDebts + type: String + displayName: Allowance For Bad Debts + required: false + - value: Asset.Other Current Asset.DevelopmentCosts + type: String + displayName: Development Costs + required: false + - value: Asset.Other Current Asset.EmployeeCashAdvances + type: String + displayName: Employee Cash Advances + required: false + - value: Asset.Other Current Asset.OtherCurrentAssets + type: String + displayName: Other Current Assets + required: false + - value: Asset.Other Current Asset.Inventory + type: String + displayName: Inventory + required: false + - value: Asset.Other Current Asset.Investment_MortgageRealEstateLoans + type: String + displayName: Investment Mortgage Real Estate Loans + required: false + - value: Asset.Other Current Asset.Investment_Other + type: String + displayName: Investment Other + required: false + - value: Asset.Other Current Asset.Investment_TaxExemptSecurities + type: String + displayName: Investment Tax Exempt Securities + required: false + - value: Asset.Other Current Asset.Investment_USGovernmentObligations + type: String + displayName: Investment US Government Obligations + required: false + - value: Asset.Other Current Asset.LoansToOfficers + type: String + displayName: Loans To Officers + required: false + - value: Asset.Other Current Asset.LoansToOthers + type: String + displayName: Loans To Others + required: false + - value: Asset.Other Current Asset.LoansToStockholders + type: String + displayName: Loans To Stockholders + required: false + - value: Asset.Other Current Asset.PrepaidExpenses + type: String + displayName: Prepaid Expenses + required: false + - value: Asset.Other Current Asset.Retainage + type: String + displayName: Retainage + required: false + - value: Asset.Other Current Asset.UndepositedFunds + type: String + displayName: Undeposited Funds + required: false + - value: Asset.Other Current Asset.AssetsAvailableForSale + type: String + displayName: Assets Available For Sale + required: false + - value: Asset.Other Current Asset.BalWithGovtAuthorities + type: String + displayName: Balance With Govt Authorities + required: false + - value: Asset.Other Current Asset.CalledUpShareCapitalNotPaid + type: String + displayName: Called Up Share Capital Not Paid + required: false + - value: Asset.Other Current Asset.ExpenditureAuthorisationsAndLettersOfCredit + type: String + displayName: Expenditure Authorisations And Letters Of Credit + required: false + - value: Asset.Other Current Asset.GlobalTaxDeferred + type: String + displayName: Global Tax Deferred + required: false + - value: Asset.Other Current Asset.GlobalTaxRefund + type: String + displayName: Global Tax Refund + required: false + - value: Asset.Other Current Asset.InternalTransfers + type: String + displayName: Internal Transfers + required: false + - value: Asset.Other Current Asset.OtherConsumables + type: String + displayName: Other Consumables + required: false + - value: Asset.Other Current Asset.ProvisionsCurrentAssets + type: String + displayName: Provisions Current Assets + required: false + - value: Asset.Other Current Asset.ShortTermInvestmentsInRelatedParties + type: String + displayName: Short Term Investments In Related Parties + required: false + - value: Asset.Other Current Asset.ShortTermLoansAndAdvancesToRelatedParties + type: String + displayName: Short Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Current Asset.TradeAndOtherReceivables + type: String + displayName: Trade And Other Receivables + required: false + - value: Asset.Fixed Asset.AccumulatedDepletion + type: String + displayName: Accumulated Depletion + required: false + - value: Asset.Fixed Asset.AccumulatedDepreciation + type: String + displayName: Accumulated Depreciation + required: false + - value: Asset.Fixed Asset.DepletableAssets + type: String + displayName: Depletable Assets + required: false + - value: Asset.Fixed Asset.FixedAssetComputers + type: String + displayName: Fixed Asset Computers + required: false + - value: Asset.Fixed Asset.FixedAssetCopiers + type: String + displayName: Fixed Asset Copiers + required: false + - value: Asset.Fixed Asset.FixedAssetFurniture + type: String + displayName: Fixed Asset Furniture + required: false + - value: Asset.Fixed Asset.FixedAssetPhone + type: String + displayName: Fixed Asset Phone + required: false + - value: Asset.Fixed Asset.FixedAssetPhotoVideo + type: String + displayName: Fixed Asset Photo Video + required: false + - value: Asset.Fixed Asset.FixedAssetSoftware + type: String + displayName: Fixed Asset Software + required: false + - value: Asset.Fixed Asset.FixedAssetOtherToolsEquipment + type: String + displayName: Fixed Asset Other Tools Equipment + required: false + - value: Asset.Fixed Asset.FurnitureAndFixtures + type: String + displayName: Furniture And Fixtures + required: false + - value: Asset.Fixed Asset.Land + type: String + displayName: Land + required: false + - value: Asset.Fixed Asset.LeaseholdImprovements + type: String + displayName: Leasehold Improvements + required: false + - value: Asset.Fixed Asset.OtherFixedAssets + type: String + displayName: Other Fixed Assets + required: false + - value: Asset.Fixed Asset.AccumulatedAmortization + type: String + displayName: Accumulated Amortization + required: false + - value: Asset.Fixed Asset.Buildings + type: String + displayName: Buildings + required: false + - value: Asset.Fixed Asset.IntangibleAssets + type: String + displayName: Intangible Assets + required: false + - value: Asset.Fixed Asset.MachineryAndEquipment + type: String + displayName: Machinery And Equipment + required: false + - value: Asset.Fixed Asset.Vehicles + type: String + displayName: Vehicles + required: false + - value: Asset.Fixed Asset.AssetsInCourseOfConstruction + type: String + displayName: Assets In Course Of Construction + required: false + - value: Asset.Fixed Asset.CapitalWip + type: String + displayName: Capital Wip + required: false + - value: Asset.Fixed Asset.CumulativeDepreciationOnIntangibleAssets + type: String + displayName: Cumulative Depreciation On Intangible Assets + required: false + - value: Asset.Fixed Asset.IntangibleAssetsUnderDevelopment + type: String + displayName: Intangible Assets Under Development + required: false + - value: Asset.Fixed Asset.LandAsset + type: String + displayName: Land Asset + required: false + - value: Asset.Fixed Asset.NonCurrentAssets + type: String + displayName: Non Current Assets + required: false + - value: Asset.Fixed Asset.ParticipatingInterests + type: String + displayName: Participating Interests + required: false + - value: Asset.Fixed Asset.ProvisionsFixedAssets + type: String + displayName: Provisions Fixed Assets + required: false + - value: Asset.Other Asset.LeaseBuyout + type: String + displayName: Lease Buyout + required: false + - value: Asset.Other Asset.OtherLongTermAssets + type: String + displayName: Other Long Term Assets + required: false + - value: Asset.Other Asset.SecurityDeposits + type: String + displayName: Security Deposits + required: false + - value: Asset.Other Asset.AccumulatedAmortizationOfOtherAssets + type: String + displayName: Accumulated Amortization Of Other Assets + required: false + - value: Asset.Other Asset.Goodwill + type: String + displayName: Goodwill + required: false + - value: Asset.Other Asset.Licenses + type: String + displayName: Licenses + required: false + - value: Asset.Other Asset.OrganizationalCosts + type: String + displayName: Organizational Costs + required: false + - value: Asset.Other Asset.AssetsHeldForSale + type: String + displayName: Assets Held For Sale + required: false + - value: Asset.Other Asset.AvailableForSaleFinancialAssets + type: String + displayName: Available For Sale Financial Assets + required: false + - value: Asset.Other Asset.DeferredTax + type: String + displayName: Deferred Tax + required: false + - value: Asset.Other Asset.Investments + type: String + displayName: Investments + required: false + - value: Asset.Other Asset.LongTermInvestments + type: String + displayName: Long Term Investments + required: false + - value: Asset.Other Asset.LongTermLoansAndAdvancesToRelatedParties + type: String + displayName: Long Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Asset.OtherIntangibleAssets + type: String + displayName: Other Intangible Assets + required: false + - value: Asset.Other Asset.OtherLongTermInvestments + type: String + displayName: Other Long Term Investments + required: false + - value: Asset.Other Asset.OtherLongTermLoansAndAdvances + type: String + displayName: Other Long Term Loans And Advances + required: false + - value: Asset.Other Asset.PrepaymentsAndAccruedIncome + type: String + displayName: Prepayments And Accrued Income + required: false + - value: Asset.Other Asset.ProvisionsNonCurrentAssets + type: String + displayName: Provisions Non-Current Assets + required: false + - value: Asset.Accounts Receivable.AccountsReceivable + type: String + displayName: Accounts Receivable + required: false + - value: Expense.Expense.AdvertisingPromotional + type: String + displayName: Advertising/Promotional + required: false + - value: Expense.Expense.BadDebts + type: String + displayName: Bad Debts + required: false + - value: Expense.Expense.BankCharges + type: String + displayName: Bank Charges + required: false + - value: Expense.Expense.CharitableContributions + type: String + displayName: Charitable Contributions + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.Entertainment + type: String + displayName: Entertainment + required: false + - value: Expense.Expense.EntertainmentMeals + type: String + displayName: Entertainment Meals + required: false + - value: Expense.Expense.EquipmentRental + type: String + displayName: Equipment Rental + required: false + - value: Expense.Expense.FinanceCosts + type: String + displayName: Finance Costs + required: false + - value: Expense.Expense.GlobalTaxExpense + type: String + displayName: Global Tax Expense + required: false + - value: Expense.Expense.Insurance + type: String + displayName: Insurance + required: false + - value: Expense.Expense.InterestPaid + type: String + displayName: Interest Paid + required: false + - value: Expense.Expense.LegalProfessionalFees + type: String + displayName: Legal And Professional Fees + required: false + - value: Expense.Expense.OfficeExpenses + type: String + displayName: Office Expenses + required: false + - value: Expense.Expense.OfficeGeneralAdministrativeExpenses + type: String + displayName: Office/General Administrative Expenses + required: false + - value: Expense.Expense.OtherBusinessExpenses + type: String + displayName: Other Business Expenses + required: false + - value: Expense.Expense.OtherMiscellaneousServiceCost + type: String + displayName: Other Miscellaneous Service Cost + required: false + - value: Expense.Expense.PromotionalMeals + type: String + displayName: Promotional Meals + required: false + - value: Expense.Expense.RentOrLeaseOfBuildings + type: String + displayName: Rent Or Lease Of Buildings + required: false + - value: Expense.Expense.RepairMaintenance + type: String + displayName: Repair And Maintenance + required: false + - value: Expense.Expense.ShippingFreightDelivery + type: String + displayName: 'Shipping, Freight And Delivery' + required: false + - value: Expense.Expense.SuppliesMaterials + type: String + displayName: Supplies And Materials + required: false + - value: Expense.Expense.Travel + type: String + displayName: Travel + required: false + - value: Expense.Expense.TravelMeals + type: String + displayName: Travel Meals + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.Auto + type: String + displayName: Auto + required: false + - value: Expense.Expense.CostOfLabor + type: String + displayName: Cost Of Labor + required: false + - value: Expense.Expense.DuesSubscriptions + type: String + displayName: Dues And Subscriptions + required: false + - value: Expense.Expense.PayrollExpenses + type: String + displayName: Payroll Expenses + required: false + - value: Expense.Expense.TaxesPaid + type: String + displayName: Taxes Paid + required: false + - value: Expense.Expense.UnappliedCashBillPaymentExpense + type: String + displayName: Unapplied Cash Bill Payment Expense + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.AmortizationExpense + type: String + displayName: Amortization Expense + required: false + - value: Expense.Expense.AppropriationsToDepreciation + type: String + displayName: Appropriations To Depreciation + required: false + - value: Expense.Expense.BorrowingCost + type: String + displayName: Borrowing Cost + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.DistributionCosts + type: String + displayName: Distribution Costs + required: false + - value: Expense.Expense.ExternalServices + type: String + displayName: External Services + required: false + - value: Expense.Expense.ExtraordinaryCharges + type: String + displayName: Extraordinary Charges + required: false + - value: Expense.Expense.IncomeTaxExpense + type: String + displayName: Income Tax Expense + required: false + - value: Expense.Expense.LossOnDiscontinuedOperationsNetOfTax + type: String + displayName: Loss On Discontinued Operations Net Of Tax + required: false + - value: Expense.Expense.ManagementCompensation + type: String + displayName: Management Compensation + required: false + - value: Expense.Expense.OtherCurrentOperatingCharges + type: String + displayName: Other Current Operating Charges + required: false + - value: Expense.Expense.OtherExternalServices + type: String + displayName: Other External Services + required: false + - value: Expense.Expense.OtherRentalCosts + type: String + displayName: Other Rental Costs + required: false + - value: Expense.Expense.OtherSellingExpenses + type: String + displayName: Other Selling Expenses + required: false + - value: Expense.Expense.ProjectStudiesSurveysAssessments + type: String + displayName: Project Studies Surveys Assessments + required: false + - value: Expense.Expense.PurchasesRebates + type: String + displayName: Purchases Rebates + required: false + - value: Expense.Expense.ShippingAndDeliveryExpense + type: String + displayName: Shipping And Delivery Expense + required: false + - value: Expense.Expense.StaffCosts + type: String + displayName: Staff Costs + required: false + - value: Expense.Expense.Sundry + type: String + displayName: Sundry + required: false + - value: Expense.Expense.TravelExpensesGeneralAndAdminExpenses + type: String + displayName: Travel Expenses General And Admin Expenses + required: false + - value: Expense.Expense.TravelExpensesSellingExpense + type: String + displayName: Travel Expenses Selling Expense + required: false + - value: Expense.Other Expense.Depreciation + type: String + displayName: Depreciation + required: false + - value: Expense.Other Expense.ExchangeGainOrLoss + type: String + displayName: Exchange Gain Or Loss + required: false + - value: Expense.Other Expense.OtherMiscellaneousExpense + type: String + displayName: Other Miscellaneous Expense + required: false + - value: Expense.Other Expense.PenaltiesSettlements + type: String + displayName: Penalties And Settlements + required: false + - value: Expense.Other Expense.Amortization + type: String + displayName: Amortization + required: false + - value: Expense.Other Expense.GasAndFuel + type: String + displayName: Gas And Fuel + required: false + - value: Expense.Other Expense.HomeOffice + type: String + displayName: Home Office + required: false + - value: Expense.Other Expense.HomeOwnerRentalInsurance + type: String + displayName: Home Owner Rental Insurance + required: false + - value: Expense.Other Expense.OtherHomeOfficeExpenses + type: String + displayName: Other Home Office Expenses + required: false + - value: Expense.Other Expense.MortgageInterest + type: String + displayName: Mortgage Interest + required: false + - value: Expense.Other Expense.RentAndLease + type: String + displayName: Rent And Lease + required: false + - value: Expense.Other Expense.RepairsAndMaintenance + type: String + displayName: Repairs And Maintenance + required: false + - value: Expense.Other Expense.ParkingAndTolls + type: String + displayName: Parking And Tolls + required: false + - value: Expense.Other Expense.Vehicle + type: String + displayName: Vehicle + required: false + - value: Expense.Other Expense.VehicleInsurance + type: String + displayName: Vehicle Insurance + required: false + - value: Expense.Other Expense.VehicleLease + type: String + displayName: Vehicle Lease + required: false + - value: Expense.Other Expense.VehicleLoanInterest + type: String + displayName: Vehicle Loan Interest + required: false + - value: Expense.Other Expense.VehicleLoan + type: String + displayName: Vehicle Loan + required: false + - value: Expense.Other Expense.VehicleRegistration + type: String + displayName: Vehicle Registration + required: false + - value: Expense.Other Expense.VehicleRepairs + type: String + displayName: Vehicle Repairs + required: false + - value: Expense.Other Expense.OtherVehicleExpenses + type: String + displayName: Other Vehicle Expenses + required: false + - value: Expense.Other Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Other Expense.WashAndRoadServices + type: String + displayName: Wash And Road Services + required: false + - value: Expense.Other Expense.DeferredTaxExpense + type: String + displayName: Deferred Tax Expense + required: false + - value: Expense.Other Expense.Depletion + type: String + displayName: Depletion + required: false + - value: Expense.Other Expense.ExceptionalItems + type: String + displayName: Exceptional Items + required: false + - value: Expense.Other Expense.ExtraordinaryItems + type: String + displayName: Extraordinary Items + required: false + - value: Expense.Other Expense.IncomeTaxOtherExpense + type: String + displayName: Income Tax Other Expense + required: false + - value: Expense.Other Expense.MatCredit + type: String + displayName: Mat Credit + required: false + - value: Expense.Other Expense.PriorPeriodItems + type: String + displayName: Prior Period Items + required: false + - value: Expense.Other Expense.TaxRoundoffGainOrLoss + type: String + displayName: Tax Roundoff Gain Or Loss + required: false + - value: Expense.Cost of Goods Sold.EquipmentRentalCos + type: String + displayName: Equipment Rental - COS + required: false + - value: Expense.Cost of Goods Sold.OtherCostsOfServiceCos + type: String + displayName: Other Costs Of Sales - COS + required: false + - value: Expense.Cost of Goods Sold.ShippingFreightDeliveryCos + type: String + displayName: 'Shipping, Freight And Delivery - COS' + required: false + - value: Expense.Cost of Goods Sold.SuppliesMaterialsCogs + type: String + displayName: Supplies And Materials - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfLaborCos + type: String + displayName: Cost Of Labor - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfSales + type: String + displayName: Cost Of Sales + required: false + - value: Expense.Cost of Goods Sold.FreightAndDeliveryCost + type: String + displayName: Freight And Delivery Cost + required: false + - value: Income.Income.NonProfitIncome + type: String + displayName: Non Profit Income + required: false + - value: Income.Income.OtherPrimaryIncome + type: String + displayName: Other Primary Income + required: false + - value: Income.Income.SalesOfProductIncome + type: String + displayName: Sales Of ProductIncome + required: false + - value: Income.Income.ServiceFeeIncome + type: String + displayName: Service Fee Income + required: false + - value: Income.Income.DiscountsRefundsGiven + type: String + displayName: Discounts Refunds Given + required: false + - value: Income.Income.UnappliedCashPaymentIncome + type: String + displayName: Unapplied Cash Payment Income + required: false + - value: Income.Income.CashReceiptIncome + type: String + displayName: Cash Receipt Income + required: false + - value: Income.Income.OperatingGrants + type: String + displayName: Operating Grants + required: false + - value: Income.Income.OtherCurrentOperatingIncome + type: String + displayName: Other Current Operating Income + required: false + - value: Income.Income.OwnWorkCapitalized + type: String + displayName: Own Work Capitalized + required: false + - value: Income.Income.RevenueGeneral + type: String + displayName: Revenue General + required: false + - value: Income.Income.SalesRetail + type: String + displayName: Sales Retail + required: false + - value: Income.Income.SalesWholesale + type: String + displayName: Sales Wholesale + required: false + - value: Income.Income.SavingsByTaxScheme + type: String + displayName: Savings By Tax Scheme + required: false + - value: Income.Other Income.DividendIncome + type: String + displayName: Dividend Income + required: false + - value: Income.Other Income.InterestEarned + type: String + displayName: Interest Earned + required: false + - value: Income.Other Income.OtherInvestmentIncome + type: String + displayName: Other Investment Income + required: false + - value: Income.Other Income.OtherMiscellaneousIncome + type: String + displayName: Other Miscellaneous Income + required: false + - value: Income.Other Income.TaxExemptInterest + type: String + displayName: Tax Exempt Interest + required: false + - value: Income.Other Income.GainLossOnSaleOfFixedAssets + type: String + displayName: Gain Loss On Sale Of Fixed Assets + required: false + - value: Income.Other Income.GainLossOnSaleOfInvestments + type: String + displayName: Gain Loss On Sale Of Investments + required: false + - value: Income.Other Income.LossOnDisposalOfAssets + type: String + displayName: Loss On Disposal Of Assets + required: false + - value: Income.Other Income.OtherOperatingIncome + type: String + displayName: Other Operating Income + required: false + - value: Income.Other Income.UnrealisedLossOnSecuritiesNetOfTax + type: String + displayName: Unrealised Loss On Securities Net Of Tax + required: false + - value: Liability.Accounts Payable.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.Accounts Payable.OutstandingDuesMicroSmallEnterprise + type: String + displayName: Outstanding Dues Micro Small Enterprise + required: false + - value: Liability.Accounts Payable.OutstandingDuesOtherThanMicroSmallEnterprise + type: String + displayName: Outstanding Dues Other Than Micro Small Enterprise + required: false + - value: Liability.Credit Card.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.Long Term Liability.NotesPayable + type: String + displayName: Notes Payable + required: false + - value: Liability.Long Term Liability.OtherLongTermLiabilities + type: String + displayName: Other Long Term Liabilities + required: false + - value: Liability.Long Term Liability.ShareholderNotesPayable + type: String + displayName: Shareholder Notes Payable + required: false + - value: Liability.Long Term Liability.AccrualsAndDeferredIncome + type: String + displayName: Accruals And Deferred Income + required: false + - value: Liability.Long Term Liability.AccruedLongLermLiabilities + type: String + displayName: Accrued Long Lerm Liabilities + required: false + - value: Liability.Long Term Liability.AccruedVacationPayable + type: String + displayName: Accrued Vacation Payable + required: false + - value: Liability.Long Term Liability.BankLoans + type: String + displayName: Bank Loans + required: false + - value: Liability.Long Term Liability.DebtsRelatedToParticipatingInterests + type: String + displayName: Debts Related To Participating Interests + required: false + - value: Liability.Long Term Liability.DeferredTaxLiabilities + type: String + displayName: Deferred Tax Liabilities + required: false + - value: Liability.Long Term Liability.GovernmentAndOtherPublicAuthorities + type: String + displayName: Government And Other Public Authorities + required: false + - value: Liability.Long Term Liability.GroupAndAssociates + type: String + displayName: Group And Associates + required: false + - value: Liability.Long Term Liability.LiabilitiesRelatedToAssetsHeldForSale + type: String + displayName: Liabilities Related To Assets Held For Sale + required: false + - value: Liability.Long Term Liability.LongTermBorrowings + type: String + displayName: Long Term Borrowings + required: false + - value: Liability.Long Term Liability.LongTermDebit + type: String + displayName: Long Term Debit + required: false + - value: Liability.Long Term Liability.LongTermEmployeeBenefitObligations + type: String + displayName: Long Term Employee Benefit Obligations + required: false + - value: Liability.Long Term Liability.ObligationsUnderFinanceLeases + type: String + displayName: Obligations Under Finance Leases + required: false + - value: Liability.Long Term Liability.OtherLongTermProvisions + type: String + displayName: Other Long Term Provisions + required: false + - value: Liability.Long Term Liability.ProvisionForLiabilities + type: String + displayName: Provision For Liabilities + required: false + - value: Liability.Long Term Liability.ProvisionsNonCurrentLiabilities + type: String + displayName: Provisions Non Current Liabilities + required: false + - value: Liability.Long Term Liability.StaffAndRelatedLongTermLiabilityAccounts + type: String + displayName: Staff And Related Long Term Liability Accounts + required: false + - value: Liability.Other Current Liability.DirectDepositPayable + type: String + displayName: Direct Deposit Payable + required: false + - value: Liability.Other Current Liability.LineOfCredit + type: String + displayName: Line Of Credit + required: false + - value: Liability.Other Current Liability.LoanPayable + type: String + displayName: Loan Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxPayable + type: String + displayName: Global Tax Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxSuspense + type: String + displayName: Global Tax Suspense + required: false + - value: Liability.Other Current Liability.OtherCurrentLiabilities + type: String + displayName: Other Current Liabilities + required: false + - value: Liability.Other Current Liability.PayrollClearing + type: String + displayName: Payroll Clearing + required: false + - value: Liability.Other Current Liability.PayrollTaxPayable + type: String + displayName: Payroll Tax Payable + required: false + - value: Liability.Other Current Liability.PrepaidExpensesPayable + type: String + displayName: Prepaid Expenses Payable + required: false + - value: Liability.Other Current Liability.RentsInTrustLiability + type: String + displayName: Rents In Trust Liability + required: false + - value: Liability.Other Current Liability.TrustAccountsLiabilities + type: String + displayName: Trust Accounts Liabilities + required: false + - value: Liability.Other Current Liability.FederalIncomeTaxPayable + type: String + displayName: Federal Income Tax Payable + required: false + - value: Liability.Other Current Liability.InsurancePayable + type: String + displayName: Insurance Payable + required: false + - value: Liability.Other Current Liability.SalesTaxPayable + type: String + displayName: Sales Tax Payable + required: false + - value: Liability.Other Current Liability.StateLocalIncomeTaxPayable + type: String + displayName: State Local Income Tax Payable + required: false + - value: Liability.Other Current Liability.AccruedLiabilities + type: String + displayName: Accrued Liabilities + required: false + - value: Liability.Other Current Liability.CurrentLiabilities + type: String + displayName: Current Liabilities + required: false + - value: Liability.Other Current Liability.CurrentPortionEmployeeBenefitsObligations + type: String + displayName: Current Portion EmployeeBenefits Obligations + required: false + - value: Liability.Other Current Liability.CurrentPortionOfObligationsUnderFinanceLeases + type: String + displayName: Current Portion Of Obligations Under Finance Leases + required: false + - value: Liability.Other Current Liability.CurrentTaxLiability + type: String + displayName: Current Tax Liability + required: false + - value: Liability.Other Current Liability.DividendsPayable + type: String + displayName: Dividends Payable + required: false + - value: Liability.Other Current Liability.DutiesAndTaxes + type: String + displayName: Duties And Taxes + required: false + - value: Liability.Other Current Liability.InterestPayables + type: String + displayName: Interest Payables + required: false + - value: Liability.Other Current Liability.ProvisionForWarrantyObligations + type: String + displayName: Provision For Warranty Obligations + required: false + - value: Liability.Other Current Liability.ProvisionsCurrentLiabilities + type: String + displayName: Provisions Current Liabilities + required: false + - value: Liability.Other Current Liability.ShortTermBorrowings + type: String + displayName: Short Term Borrowings + required: false + - value: Liability.Other Current Liability.SocialSecurityAgencies + type: String + displayName: Social Security Agencies + required: false + - value: Liability.Other Current Liability.StaffAndRelatedLiabilityAccounts + type: String + displayName: Staff And Related Liability Accounts + required: false + - value: Liability.Other Current Liability.SundryDebtorsAndCreditors + type: String + displayName: Sundry Debtors And Creditors + required: false + - value: Liability.Other Current Liability.TradeAndOtherPayables + type: String + displayName: Trade And Other Payables + required: false + - value: Equity.Equity.OpeningBalanceEquity + type: String + displayName: Opening Balance Equity + required: false + - value: Equity.Equity.PartnersEquity + type: String + displayName: Partners Equity + required: false + - value: Equity.Equity.RetainedEarnings + type: String + displayName: Retained Earnings + required: false + - value: Equity.Equity.AccumulatedAdjustment + type: String + displayName: Accumulated Adjustment + required: false + - value: Equity.Equity.OwnersEquity + type: String + displayName: Owners Equity + required: false + - value: Equity.Equity.PaidInCapitalOrSurplus + type: String + displayName: Paid In Capital Or Surplus + required: false + - value: Equity.Equity.PartnerContributions + type: String + displayName: Partner Contributions + required: false + - value: Equity.Equity.PartnerDistributions + type: String + displayName: Partner Distributions + required: false + - value: Equity.Equity.PreferredStock + type: String + displayName: Preferred Stock + required: false + - value: Equity.Equity.CommonStock + type: String + displayName: Common Stock + required: false + - value: Equity.Equity.TreasuryStock + type: String + displayName: Treasury Stock + required: false + - value: Equity.Equity.EstimatedTaxes + type: String + displayName: Estimated Taxes + required: false + - value: Equity.Equity.Healthcare + type: String + displayName: Healthcare + required: false + - value: Equity.Equity.PersonalIncome + type: String + displayName: Personal Income + required: false + - value: Equity.Equity.PersonalExpense + type: String + displayName: Personal Expense + required: false + - value: Equity.Equity.AccumulatedOtherComprehensiveIncome + type: String + displayName: Accumulated Other Comprehensive Income + required: false + - value: Equity.Equity.CalledUpShareCapital + type: String + displayName: Called Up Share Capital + required: false + - value: Equity.Equity.CapitalReserves + type: String + displayName: Capital Reserves + required: false + - value: Equity.Equity.DividendDisbursed + type: String + displayName: Dividend Disbursed + required: false + - value: Equity.Equity.EquityInEarningsOfSubsiduaries + type: String + displayName: Equity In Earnings Of Subsiduaries + required: false + - value: Equity.Equity.InvestmentGrants + type: String + displayName: Investment Grants + required: false + - value: Equity.Equity.MoneyReceivedAgainstShareWarrants + type: String + displayName: Money Received Against Share Warrants + required: false + - value: Equity.Equity.OtherFreeReserves + type: String + displayName: Other Free Reserves + required: false + - value: Equity.Equity.ShareApplicationMoneyPendingAllotment + type: String + displayName: Share Application Money Pending Allotment + required: false + - value: Equity.Equity.ShareCapital + type: String + displayName: Share Capital + required: false + - value: Equity.Equity.Funds + type: String + displayName: Funds + required: false + required: true + required: true + QuickBooks Online: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: false + validation: + warnings: [] + information: + - field: NominalCode + details: If included must have a length between 1 and 7 characters + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: + - field: Name + details: Must have a length between 1 and 100 characters + information: [] + currency: + type: String + displayName: Currency + description: The currency of the account + required: false + validation: + warnings: [] + information: + - field: Currency + details: When not specified company base currency will be used + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: Asset.Bank.CashOnHand + type: String + displayName: Cash On Hand + required: false + - value: Asset.Bank.Checking + type: String + displayName: Checking + required: false + - value: Asset.Bank.MoneyMarket + type: String + displayName: Money Market + required: false + - value: Asset.Bank.RentsHeldInTrust + type: String + displayName: Rents Held In Trust + required: false + - value: Asset.Bank.Savings + type: String + displayName: Savings + required: false + - value: Asset.Bank.TrustAccounts + type: String + displayName: Trust Accounts + required: false + - value: Asset.Bank.CashAndCashEquivalents + type: String + displayName: Cash And Cash Equivalents + required: false + - value: Asset.Bank.OtherEarmarkedBankAccounts + type: String + displayName: Other Earmarked Bank Accounts + required: false + - value: Asset.Other Current Asset.AllowanceForBadDebts + type: String + displayName: Allowance For Bad Debts + required: false + - value: Asset.Other Current Asset.DevelopmentCosts + type: String + displayName: Development Costs + required: false + - value: Asset.Other Current Asset.EmployeeCashAdvances + type: String + displayName: Employee Cash Advances + required: false + - value: Asset.Other Current Asset.OtherCurrentAssets + type: String + displayName: Other Current Assets + required: false + - value: Asset.Other Current Asset.Inventory + type: String + displayName: Inventory + required: false + - value: Asset.Other Current Asset.Investment_MortgageRealEstateLoans + type: String + displayName: Investment Mortgage Real Estate Loans + required: false + - value: Asset.Other Current Asset.Investment_Other + type: String + displayName: Investment Other + required: false + - value: Asset.Other Current Asset.Investment_TaxExemptSecurities + type: String + displayName: Investment Tax Exempt Securities + required: false + - value: Asset.Other Current Asset.Investment_USGovernmentObligations + type: String + displayName: Investment US Government Obligations + required: false + - value: Asset.Other Current Asset.LoansToOfficers + type: String + displayName: Loans To Officers + required: false + - value: Asset.Other Current Asset.LoansToOthers + type: String + displayName: Loans To Others + required: false + - value: Asset.Other Current Asset.LoansToStockholders + type: String + displayName: Loans To Stockholders + required: false + - value: Asset.Other Current Asset.PrepaidExpenses + type: String + displayName: Prepaid Expenses + required: false + - value: Asset.Other Current Asset.Retainage + type: String + displayName: Retainage + required: false + - value: Asset.Other Current Asset.UndepositedFunds + type: String + displayName: Undeposited Funds + required: false + - value: Asset.Other Current Asset.AssetsAvailableForSale + type: String + displayName: Assets Available For Sale + required: false + - value: Asset.Other Current Asset.BalWithGovtAuthorities + type: String + displayName: Balance With Govt Authorities + required: false + - value: Asset.Other Current Asset.CalledUpShareCapitalNotPaid + type: String + displayName: Called Up Share Capital Not Paid + required: false + - value: Asset.Other Current Asset.ExpenditureAuthorisationsAndLettersOfCredit + type: String + displayName: Expenditure Authorisations And Letters Of Credit + required: false + - value: Asset.Other Current Asset.GlobalTaxDeferred + type: String + displayName: Global Tax Deferred + required: false + - value: Asset.Other Current Asset.GlobalTaxRefund + type: String + displayName: Global Tax Refund + required: false + - value: Asset.Other Current Asset.InternalTransfers + type: String + displayName: Internal Transfers + required: false + - value: Asset.Other Current Asset.OtherConsumables + type: String + displayName: Other Consumables + required: false + - value: Asset.Other Current Asset.ProvisionsCurrentAssets + type: String + displayName: Provisions Current Assets + required: false + - value: Asset.Other Current Asset.ShortTermInvestmentsInRelatedParties + type: String + displayName: Short Term Investments In Related Parties + required: false + - value: Asset.Other Current Asset.ShortTermLoansAndAdvancesToRelatedParties + type: String + displayName: Short Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Current Asset.TradeAndOtherReceivables + type: String + displayName: Trade And Other Receivables + required: false + - value: Asset.Fixed Asset.AccumulatedDepletion + type: String + displayName: Accumulated Depletion + required: false + - value: Asset.Fixed Asset.AccumulatedDepreciation + type: String + displayName: Accumulated Depreciation + required: false + - value: Asset.Fixed Asset.DepletableAssets + type: String + displayName: Depletable Assets + required: false + - value: Asset.Fixed Asset.FixedAssetComputers + type: String + displayName: Fixed Asset Computers + required: false + - value: Asset.Fixed Asset.FixedAssetCopiers + type: String + displayName: Fixed Asset Copiers + required: false + - value: Asset.Fixed Asset.FixedAssetFurniture + type: String + displayName: Fixed Asset Furniture + required: false + - value: Asset.Fixed Asset.FixedAssetPhone + type: String + displayName: Fixed Asset Phone + required: false + - value: Asset.Fixed Asset.FixedAssetPhotoVideo + type: String + displayName: Fixed Asset Photo Video + required: false + - value: Asset.Fixed Asset.FixedAssetSoftware + type: String + displayName: Fixed Asset Software + required: false + - value: Asset.Fixed Asset.FixedAssetOtherToolsEquipment + type: String + displayName: Fixed Asset Other Tools Equipment + required: false + - value: Asset.Fixed Asset.FurnitureAndFixtures + type: String + displayName: Furniture And Fixtures + required: false + - value: Asset.Fixed Asset.Land + type: String + displayName: Land + required: false + - value: Asset.Fixed Asset.LeaseholdImprovements + type: String + displayName: Leasehold Improvements + required: false + - value: Asset.Fixed Asset.OtherFixedAssets + type: String + displayName: Other Fixed Assets + required: false + - value: Asset.Fixed Asset.AccumulatedAmortization + type: String + displayName: Accumulated Amortization + required: false + - value: Asset.Fixed Asset.Buildings + type: String + displayName: Buildings + required: false + - value: Asset.Fixed Asset.IntangibleAssets + type: String + displayName: Intangible Assets + required: false + - value: Asset.Fixed Asset.MachineryAndEquipment + type: String + displayName: Machinery And Equipment + required: false + - value: Asset.Fixed Asset.Vehicles + type: String + displayName: Vehicles + required: false + - value: Asset.Fixed Asset.AssetsInCourseOfConstruction + type: String + displayName: Assets In Course Of Construction + required: false + - value: Asset.Fixed Asset.CapitalWip + type: String + displayName: Capital Wip + required: false + - value: Asset.Fixed Asset.CumulativeDepreciationOnIntangibleAssets + type: String + displayName: Cumulative Depreciation On Intangible Assets + required: false + - value: Asset.Fixed Asset.IntangibleAssetsUnderDevelopment + type: String + displayName: Intangible Assets Under Development + required: false + - value: Asset.Fixed Asset.LandAsset + type: String + displayName: Land Asset + required: false + - value: Asset.Fixed Asset.NonCurrentAssets + type: String + displayName: Non Current Assets + required: false + - value: Asset.Fixed Asset.ParticipatingInterests + type: String + displayName: Participating Interests + required: false + - value: Asset.Fixed Asset.ProvisionsFixedAssets + type: String + displayName: Provisions Fixed Assets + required: false + - value: Asset.Other Asset.LeaseBuyout + type: String + displayName: Lease Buyout + required: false + - value: Asset.Other Asset.OtherLongTermAssets + type: String + displayName: Other Long Term Assets + required: false + - value: Asset.Other Asset.SecurityDeposits + type: String + displayName: Security Deposits + required: false + - value: Asset.Other Asset.AccumulatedAmortizationOfOtherAssets + type: String + displayName: Accumulated Amortization Of Other Assets + required: false + - value: Asset.Other Asset.Goodwill + type: String + displayName: Goodwill + required: false + - value: Asset.Other Asset.Licenses + type: String + displayName: Licenses + required: false + - value: Asset.Other Asset.OrganizationalCosts + type: String + displayName: Organizational Costs + required: false + - value: Asset.Other Asset.AssetsHeldForSale + type: String + displayName: Assets Held For Sale + required: false + - value: Asset.Other Asset.AvailableForSaleFinancialAssets + type: String + displayName: Available For Sale Financial Assets + required: false + - value: Asset.Other Asset.DeferredTax + type: String + displayName: Deferred Tax + required: false + - value: Asset.Other Asset.Investments + type: String + displayName: Investments + required: false + - value: Asset.Other Asset.LongTermInvestments + type: String + displayName: Long Term Investments + required: false + - value: Asset.Other Asset.LongTermLoansAndAdvancesToRelatedParties + type: String + displayName: Long Term Loans And Advances To Related Parties + required: false + - value: Asset.Other Asset.OtherIntangibleAssets + type: String + displayName: Other Intangible Assets + required: false + - value: Asset.Other Asset.OtherLongTermInvestments + type: String + displayName: Other Long Term Investments + required: false + - value: Asset.Other Asset.OtherLongTermLoansAndAdvances + type: String + displayName: Other Long Term Loans And Advances + required: false + - value: Asset.Other Asset.PrepaymentsAndAccruedIncome + type: String + displayName: Prepayments And Accrued Income + required: false + - value: Asset.Other Asset.ProvisionsNonCurrentAssets + type: String + displayName: Provisions Non-Current Assets + required: false + - value: Asset.Accounts Receivable.AccountsReceivable + type: String + displayName: Accounts Receivable + required: false + - value: Expense.Expense.AdvertisingPromotional + type: String + displayName: Advertising/Promotional + required: false + - value: Expense.Expense.BadDebts + type: String + displayName: Bad Debts + required: false + - value: Expense.Expense.BankCharges + type: String + displayName: Bank Charges + required: false + - value: Expense.Expense.CharitableContributions + type: String + displayName: Charitable Contributions + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.Entertainment + type: String + displayName: Entertainment + required: false + - value: Expense.Expense.EntertainmentMeals + type: String + displayName: Entertainment Meals + required: false + - value: Expense.Expense.EquipmentRental + type: String + displayName: Equipment Rental + required: false + - value: Expense.Expense.FinanceCosts + type: String + displayName: Finance Costs + required: false + - value: Expense.Expense.GlobalTaxExpense + type: String + displayName: Global Tax Expense + required: false + - value: Expense.Expense.Insurance + type: String + displayName: Insurance + required: false + - value: Expense.Expense.InterestPaid + type: String + displayName: Interest Paid + required: false + - value: Expense.Expense.LegalProfessionalFees + type: String + displayName: Legal And Professional Fees + required: false + - value: Expense.Expense.OfficeExpenses + type: String + displayName: Office Expenses + required: false + - value: Expense.Expense.OfficeGeneralAdministrativeExpenses + type: String + displayName: Office/General Administrative Expenses + required: false + - value: Expense.Expense.OtherBusinessExpenses + type: String + displayName: Other Business Expenses + required: false + - value: Expense.Expense.OtherMiscellaneousServiceCost + type: String + displayName: Other Miscellaneous Service Cost + required: false + - value: Expense.Expense.PromotionalMeals + type: String + displayName: Promotional Meals + required: false + - value: Expense.Expense.RentOrLeaseOfBuildings + type: String + displayName: Rent Or Lease Of Buildings + required: false + - value: Expense.Expense.RepairMaintenance + type: String + displayName: Repair And Maintenance + required: false + - value: Expense.Expense.ShippingFreightDelivery + type: String + displayName: 'Shipping, Freight And Delivery' + required: false + - value: Expense.Expense.SuppliesMaterials + type: String + displayName: Supplies And Materials + required: false + - value: Expense.Expense.Travel + type: String + displayName: Travel + required: false + - value: Expense.Expense.TravelMeals + type: String + displayName: Travel Meals + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.Auto + type: String + displayName: Auto + required: false + - value: Expense.Expense.CostOfLabor + type: String + displayName: Cost Of Labor + required: false + - value: Expense.Expense.DuesSubscriptions + type: String + displayName: Dues And Subscriptions + required: false + - value: Expense.Expense.PayrollExpenses + type: String + displayName: Payroll Expenses + required: false + - value: Expense.Expense.TaxesPaid + type: String + displayName: Taxes Paid + required: false + - value: Expense.Expense.UnappliedCashBillPaymentExpense + type: String + displayName: Unapplied Cash Bill Payment Expense + required: false + - value: Expense.Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Expense.AmortizationExpense + type: String + displayName: Amortization Expense + required: false + - value: Expense.Expense.AppropriationsToDepreciation + type: String + displayName: Appropriations To Depreciation + required: false + - value: Expense.Expense.BorrowingCost + type: String + displayName: Borrowing Cost + required: false + - value: Expense.Expense.CommissionsAndFees + type: String + displayName: Commissions And Fees + required: false + - value: Expense.Expense.DistributionCosts + type: String + displayName: Distribution Costs + required: false + - value: Expense.Expense.ExternalServices + type: String + displayName: External Services + required: false + - value: Expense.Expense.ExtraordinaryCharges + type: String + displayName: Extraordinary Charges + required: false + - value: Expense.Expense.IncomeTaxExpense + type: String + displayName: Income Tax Expense + required: false + - value: Expense.Expense.LossOnDiscontinuedOperationsNetOfTax + type: String + displayName: Loss On Discontinued Operations Net Of Tax + required: false + - value: Expense.Expense.ManagementCompensation + type: String + displayName: Management Compensation + required: false + - value: Expense.Expense.OtherCurrentOperatingCharges + type: String + displayName: Other Current Operating Charges + required: false + - value: Expense.Expense.OtherExternalServices + type: String + displayName: Other External Services + required: false + - value: Expense.Expense.OtherRentalCosts + type: String + displayName: Other Rental Costs + required: false + - value: Expense.Expense.OtherSellingExpenses + type: String + displayName: Other Selling Expenses + required: false + - value: Expense.Expense.ProjectStudiesSurveysAssessments + type: String + displayName: Project Studies Surveys Assessments + required: false + - value: Expense.Expense.PurchasesRebates + type: String + displayName: Purchases Rebates + required: false + - value: Expense.Expense.ShippingAndDeliveryExpense + type: String + displayName: Shipping And Delivery Expense + required: false + - value: Expense.Expense.StaffCosts + type: String + displayName: Staff Costs + required: false + - value: Expense.Expense.Sundry + type: String + displayName: Sundry + required: false + - value: Expense.Expense.TravelExpensesGeneralAndAdminExpenses + type: String + displayName: Travel Expenses General And Admin Expenses + required: false + - value: Expense.Expense.TravelExpensesSellingExpense + type: String + displayName: Travel Expenses Selling Expense + required: false + - value: Expense.Other Expense.Depreciation + type: String + displayName: Depreciation + required: false + - value: Expense.Other Expense.ExchangeGainOrLoss + type: String + displayName: Exchange Gain Or Loss + required: false + - value: Expense.Other Expense.OtherMiscellaneousExpense + type: String + displayName: Other Miscellaneous Expense + required: false + - value: Expense.Other Expense.PenaltiesSettlements + type: String + displayName: Penalties And Settlements + required: false + - value: Expense.Other Expense.Amortization + type: String + displayName: Amortization + required: false + - value: Expense.Other Expense.GasAndFuel + type: String + displayName: Gas And Fuel + required: false + - value: Expense.Other Expense.HomeOffice + type: String + displayName: Home Office + required: false + - value: Expense.Other Expense.HomeOwnerRentalInsurance + type: String + displayName: Home Owner Rental Insurance + required: false + - value: Expense.Other Expense.OtherHomeOfficeExpenses + type: String + displayName: Other Home Office Expenses + required: false + - value: Expense.Other Expense.MortgageInterest + type: String + displayName: Mortgage Interest + required: false + - value: Expense.Other Expense.RentAndLease + type: String + displayName: Rent And Lease + required: false + - value: Expense.Other Expense.RepairsAndMaintenance + type: String + displayName: Repairs And Maintenance + required: false + - value: Expense.Other Expense.ParkingAndTolls + type: String + displayName: Parking And Tolls + required: false + - value: Expense.Other Expense.Vehicle + type: String + displayName: Vehicle + required: false + - value: Expense.Other Expense.VehicleInsurance + type: String + displayName: Vehicle Insurance + required: false + - value: Expense.Other Expense.VehicleLease + type: String + displayName: Vehicle Lease + required: false + - value: Expense.Other Expense.VehicleLoanInterest + type: String + displayName: Vehicle Loan Interest + required: false + - value: Expense.Other Expense.VehicleLoan + type: String + displayName: Vehicle Loan + required: false + - value: Expense.Other Expense.VehicleRegistration + type: String + displayName: Vehicle Registration + required: false + - value: Expense.Other Expense.VehicleRepairs + type: String + displayName: Vehicle Repairs + required: false + - value: Expense.Other Expense.OtherVehicleExpenses + type: String + displayName: Other Vehicle Expenses + required: false + - value: Expense.Other Expense.Utilities + type: String + displayName: Utilities + required: false + - value: Expense.Other Expense.WashAndRoadServices + type: String + displayName: Wash And Road Services + required: false + - value: Expense.Other Expense.DeferredTaxExpense + type: String + displayName: Deferred Tax Expense + required: false + - value: Expense.Other Expense.Depletion + type: String + displayName: Depletion + required: false + - value: Expense.Other Expense.ExceptionalItems + type: String + displayName: Exceptional Items + required: false + - value: Expense.Other Expense.ExtraordinaryItems + type: String + displayName: Extraordinary Items + required: false + - value: Expense.Other Expense.IncomeTaxOtherExpense + type: String + displayName: Income Tax Other Expense + required: false + - value: Expense.Other Expense.MatCredit + type: String + displayName: Mat Credit + required: false + - value: Expense.Other Expense.PriorPeriodItems + type: String + displayName: Prior Period Items + required: false + - value: Expense.Other Expense.TaxRoundoffGainOrLoss + type: String + displayName: Tax Roundoff Gain Or Loss + required: false + - value: Expense.Cost of Goods Sold.EquipmentRentalCos + type: String + displayName: Equipment Rental - COS + required: false + - value: Expense.Cost of Goods Sold.OtherCostsOfServiceCos + type: String + displayName: Other Costs Of Sales - COS + required: false + - value: Expense.Cost of Goods Sold.ShippingFreightDeliveryCos + type: String + displayName: 'Shipping, Freight And Delivery - COS' + required: false + - value: Expense.Cost of Goods Sold.SuppliesMaterialsCogs + type: String + displayName: Supplies And Materials - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfLaborCos + type: String + displayName: Cost Of Labor - COS + required: false + - value: Expense.Cost of Goods Sold.CostOfSales + type: String + displayName: Cost Of Sales + required: false + - value: Expense.Cost of Goods Sold.FreightAndDeliveryCost + type: String + displayName: Freight And Delivery Cost + required: false + - value: Income.Income.NonProfitIncome + type: String + displayName: Non Profit Income + required: false + - value: Income.Income.OtherPrimaryIncome + type: String + displayName: Other Primary Income + required: false + - value: Income.Income.SalesOfProductIncome + type: String + displayName: Sales Of ProductIncome + required: false + - value: Income.Income.ServiceFeeIncome + type: String + displayName: Service Fee Income + required: false + - value: Income.Income.DiscountsRefundsGiven + type: String + displayName: Discounts Refunds Given + required: false + - value: Income.Income.UnappliedCashPaymentIncome + type: String + displayName: Unapplied Cash Payment Income + required: false + - value: Income.Income.CashReceiptIncome + type: String + displayName: Cash Receipt Income + required: false + - value: Income.Income.OperatingGrants + type: String + displayName: Operating Grants + required: false + - value: Income.Income.OtherCurrentOperatingIncome + type: String + displayName: Other Current Operating Income + required: false + - value: Income.Income.OwnWorkCapitalized + type: String + displayName: Own Work Capitalized + required: false + - value: Income.Income.RevenueGeneral + type: String + displayName: Revenue General + required: false + - value: Income.Income.SalesRetail + type: String + displayName: Sales Retail + required: false + - value: Income.Income.SalesWholesale + type: String + displayName: Sales Wholesale + required: false + - value: Income.Income.SavingsByTaxScheme + type: String + displayName: Savings By Tax Scheme + required: false + - value: Income.Other Income.DividendIncome + type: String + displayName: Dividend Income + required: false + - value: Income.Other Income.InterestEarned + type: String + displayName: Interest Earned + required: false + - value: Income.Other Income.OtherInvestmentIncome + type: String + displayName: Other Investment Income + required: false + - value: Income.Other Income.OtherMiscellaneousIncome + type: String + displayName: Other Miscellaneous Income + required: false + - value: Income.Other Income.TaxExemptInterest + type: String + displayName: Tax Exempt Interest + required: false + - value: Income.Other Income.GainLossOnSaleOfFixedAssets + type: String + displayName: Gain Loss On Sale Of Fixed Assets + required: false + - value: Income.Other Income.GainLossOnSaleOfInvestments + type: String + displayName: Gain Loss On Sale Of Investments + required: false + - value: Income.Other Income.LossOnDisposalOfAssets + type: String + displayName: Loss On Disposal Of Assets + required: false + - value: Income.Other Income.OtherOperatingIncome + type: String + displayName: Other Operating Income + required: false + - value: Income.Other Income.UnrealisedLossOnSecuritiesNetOfTax + type: String + displayName: Unrealised Loss On Securities Net Of Tax + required: false + - value: Liability.Accounts Payable.AccountsPayable + type: String + displayName: Accounts Payable + required: false + - value: Liability.Accounts Payable.OutstandingDuesMicroSmallEnterprise + type: String + displayName: Outstanding Dues Micro Small Enterprise + required: false + - value: Liability.Accounts Payable.OutstandingDuesOtherThanMicroSmallEnterprise + type: String + displayName: Outstanding Dues Other Than Micro Small Enterprise + required: false + - value: Liability.Credit Card.CreditCard + type: String + displayName: Credit Card + required: false + - value: Liability.Long Term Liability.NotesPayable + type: String + displayName: Notes Payable + required: false + - value: Liability.Long Term Liability.OtherLongTermLiabilities + type: String + displayName: Other Long Term Liabilities + required: false + - value: Liability.Long Term Liability.ShareholderNotesPayable + type: String + displayName: Shareholder Notes Payable + required: false + - value: Liability.Long Term Liability.AccrualsAndDeferredIncome + type: String + displayName: Accruals And Deferred Income + required: false + - value: Liability.Long Term Liability.AccruedLongLermLiabilities + type: String + displayName: Accrued Long Lerm Liabilities + required: false + - value: Liability.Long Term Liability.AccruedVacationPayable + type: String + displayName: Accrued Vacation Payable + required: false + - value: Liability.Long Term Liability.BankLoans + type: String + displayName: Bank Loans + required: false + - value: Liability.Long Term Liability.DebtsRelatedToParticipatingInterests + type: String + displayName: Debts Related To Participating Interests + required: false + - value: Liability.Long Term Liability.DeferredTaxLiabilities + type: String + displayName: Deferred Tax Liabilities + required: false + - value: Liability.Long Term Liability.GovernmentAndOtherPublicAuthorities + type: String + displayName: Government And Other Public Authorities + required: false + - value: Liability.Long Term Liability.GroupAndAssociates + type: String + displayName: Group And Associates + required: false + - value: Liability.Long Term Liability.LiabilitiesRelatedToAssetsHeldForSale + type: String + displayName: Liabilities Related To Assets Held For Sale + required: false + - value: Liability.Long Term Liability.LongTermBorrowings + type: String + displayName: Long Term Borrowings + required: false + - value: Liability.Long Term Liability.LongTermDebit + type: String + displayName: Long Term Debit + required: false + - value: Liability.Long Term Liability.LongTermEmployeeBenefitObligations + type: String + displayName: Long Term Employee Benefit Obligations + required: false + - value: Liability.Long Term Liability.ObligationsUnderFinanceLeases + type: String + displayName: Obligations Under Finance Leases + required: false + - value: Liability.Long Term Liability.OtherLongTermProvisions + type: String + displayName: Other Long Term Provisions + required: false + - value: Liability.Long Term Liability.ProvisionForLiabilities + type: String + displayName: Provision For Liabilities + required: false + - value: Liability.Long Term Liability.ProvisionsNonCurrentLiabilities + type: String + displayName: Provisions Non Current Liabilities + required: false + - value: Liability.Long Term Liability.StaffAndRelatedLongTermLiabilityAccounts + type: String + displayName: Staff And Related Long Term Liability Accounts + required: false + - value: Liability.Other Current Liability.DirectDepositPayable + type: String + displayName: Direct Deposit Payable + required: false + - value: Liability.Other Current Liability.LineOfCredit + type: String + displayName: Line Of Credit + required: false + - value: Liability.Other Current Liability.LoanPayable + type: String + displayName: Loan Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxPayable + type: String + displayName: Global Tax Payable + required: false + - value: Liability.Other Current Liability.GlobalTaxSuspense + type: String + displayName: Global Tax Suspense + required: false + - value: Liability.Other Current Liability.OtherCurrentLiabilities + type: String + displayName: Other Current Liabilities + required: false + - value: Liability.Other Current Liability.PayrollClearing + type: String + displayName: Payroll Clearing + required: false + - value: Liability.Other Current Liability.PayrollTaxPayable + type: String + displayName: Payroll Tax Payable + required: false + - value: Liability.Other Current Liability.PrepaidExpensesPayable + type: String + displayName: Prepaid Expenses Payable + required: false + - value: Liability.Other Current Liability.RentsInTrustLiability + type: String + displayName: Rents In Trust Liability + required: false + - value: Liability.Other Current Liability.TrustAccountsLiabilities + type: String + displayName: Trust Accounts Liabilities + required: false + - value: Liability.Other Current Liability.FederalIncomeTaxPayable + type: String + displayName: Federal Income Tax Payable + required: false + - value: Liability.Other Current Liability.InsurancePayable + type: String + displayName: Insurance Payable + required: false + - value: Liability.Other Current Liability.SalesTaxPayable + type: String + displayName: Sales Tax Payable + required: false + - value: Liability.Other Current Liability.StateLocalIncomeTaxPayable + type: String + displayName: State Local Income Tax Payable + required: false + - value: Liability.Other Current Liability.AccruedLiabilities + type: String + displayName: Accrued Liabilities + required: false + - value: Liability.Other Current Liability.CurrentLiabilities + type: String + displayName: Current Liabilities + required: false + - value: Liability.Other Current Liability.CurrentPortionEmployeeBenefitsObligations + type: String + displayName: Current Portion EmployeeBenefits Obligations + required: false + - value: Liability.Other Current Liability.CurrentPortionOfObligationsUnderFinanceLeases + type: String + displayName: Current Portion Of Obligations Under Finance Leases + required: false + - value: Liability.Other Current Liability.CurrentTaxLiability + type: String + displayName: Current Tax Liability + required: false + - value: Liability.Other Current Liability.DividendsPayable + type: String + displayName: Dividends Payable + required: false + - value: Liability.Other Current Liability.DutiesAndTaxes + type: String + displayName: Duties And Taxes + required: false + - value: Liability.Other Current Liability.InterestPayables + type: String + displayName: Interest Payables + required: false + - value: Liability.Other Current Liability.ProvisionForWarrantyObligations + type: String + displayName: Provision For Warranty Obligations + required: false + - value: Liability.Other Current Liability.ProvisionsCurrentLiabilities + type: String + displayName: Provisions Current Liabilities + required: false + - value: Liability.Other Current Liability.ShortTermBorrowings + type: String + displayName: Short Term Borrowings + required: false + - value: Liability.Other Current Liability.SocialSecurityAgencies + type: String + displayName: Social Security Agencies + required: false + - value: Liability.Other Current Liability.StaffAndRelatedLiabilityAccounts + type: String + displayName: Staff And Related Liability Accounts + required: false + - value: Liability.Other Current Liability.SundryDebtorsAndCreditors + type: String + displayName: Sundry Debtors And Creditors + required: false + - value: Liability.Other Current Liability.TradeAndOtherPayables + type: String + displayName: Trade And Other Payables + required: false + - value: Equity.Equity.OpeningBalanceEquity + type: String + displayName: Opening Balance Equity + required: false + - value: Equity.Equity.PartnersEquity + type: String + displayName: Partners Equity + required: false + - value: Equity.Equity.RetainedEarnings + type: String + displayName: Retained Earnings + required: false + - value: Equity.Equity.AccumulatedAdjustment + type: String + displayName: Accumulated Adjustment + required: false + - value: Equity.Equity.OwnersEquity + type: String + displayName: Owners Equity + required: false + - value: Equity.Equity.PaidInCapitalOrSurplus + type: String + displayName: Paid In Capital Or Surplus + required: false + - value: Equity.Equity.PartnerContributions + type: String + displayName: Partner Contributions + required: false + - value: Equity.Equity.PartnerDistributions + type: String + displayName: Partner Distributions + required: false + - value: Equity.Equity.PreferredStock + type: String + displayName: Preferred Stock + required: false + - value: Equity.Equity.CommonStock + type: String + displayName: Common Stock + required: false + - value: Equity.Equity.TreasuryStock + type: String + displayName: Treasury Stock + required: false + - value: Equity.Equity.EstimatedTaxes + type: String + displayName: Estimated Taxes + required: false + - value: Equity.Equity.Healthcare + type: String + displayName: Healthcare + required: false + - value: Equity.Equity.PersonalIncome + type: String + displayName: Personal Income + required: false + - value: Equity.Equity.PersonalExpense + type: String + displayName: Personal Expense + required: false + - value: Equity.Equity.AccumulatedOtherComprehensiveIncome + type: String + displayName: Accumulated Other Comprehensive Income + required: false + - value: Equity.Equity.CalledUpShareCapital + type: String + displayName: Called Up Share Capital + required: false + - value: Equity.Equity.CapitalReserves + type: String + displayName: Capital Reserves + required: false + - value: Equity.Equity.DividendDisbursed + type: String + displayName: Dividend Disbursed + required: false + - value: Equity.Equity.EquityInEarningsOfSubsiduaries + type: String + displayName: Equity In Earnings Of Subsiduaries + required: false + - value: Equity.Equity.InvestmentGrants + type: String + displayName: Investment Grants + required: false + - value: Equity.Equity.MoneyReceivedAgainstShareWarrants + type: String + displayName: Money Received Against Share Warrants + required: false + - value: Equity.Equity.OtherFreeReserves + type: String + displayName: Other Free Reserves + required: false + - value: Equity.Equity.ShareApplicationMoneyPendingAllotment + type: String + displayName: Share Application Money Pending Allotment + required: false + - value: Equity.Equity.ShareCapital + type: String + displayName: Share Capital + required: false + - value: Equity.Equity.Funds + type: String + displayName: Funds + required: false + required: true + required: true + Sage Business Cloud Accounting: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + name: + type: String + displayName: Name + description: Name of the account + required: true + validation: + warnings: [] + information: + - field: Name + details: Should not be longer than 200 characters. + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: [] + information: + - field: NominalCode + details: Should be a number between 1 and 99999999. + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + options: + - value: SALES + type: String + displayName: Sales + required: false + - value: OTHER_INCOME + type: String + displayName: Other Income + required: false + - value: DIRECT_EXPENSES + type: String + displayName: Direct Expenses + required: false + - value: OVERHEADS + type: String + displayName: Overheads + required: false + - value: DEPRECIATION + type: String + displayName: Depreciation + required: false + - value: CURRENT_ASSETS + type: String + displayName: Current Assets + required: false + - value: FIXED_ASSETS + type: String + displayName: Fixed Assets + required: false + - value: FUTURE_ASSETS + type: String + displayName: Future Assets + required: false + - value: BANK + type: String + displayName: Bank + required: false + - value: CURRENT_LIABILITY + type: String + displayName: Current Liability + required: false + - value: FUTURE_LIABILITY + type: String + displayName: Future Liability + required: false + - value: EQUITY + type: String + displayName: Equity + required: false + - value: LINE_OF_CREDIT + type: String + displayName: Credit Card / Loan + required: false + required: true + required: true + Sage Intacct: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + validation: + warnings: + - field: NominalCode + details: Must be unique within the entity. + - field: NominalCode + details: 'Must be at most 24 characters in length, although restrictions may vary between entities.' + information: [] + name: + type: String + displayName: Name + description: Name of the account + required: true + status: + type: String + displayName: Account Status + description: The status of the account + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + type: + type: String + displayName: Account Type + description: 'The type, or base category, of the account' + options: + - value: Asset + type: String + displayName: Asset + required: false + - value: Equity + type: String + displayName: Equity + required: false + - value: Expense + type: String + displayName: Expense + required: false + - value: Income + type: String + displayName: Income + required: false + - value: Liability + type: String + displayName: Liability + required: false + required: true + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + required: true + validation: + warnings: [] + information: + - field: FullyQualifiedCategory + details: 'Any category that is part of the hierarchy of one of: ''Assets'', ''Equity'', ''Liabilities'', ''Total Expenses'' and ''Total Income'' is permitted.' + required: true + Sandbox: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: The external reference given to each nominal account for a business + required: true + name: + type: String + displayName: Name + description: Name of the account + required: true + description: + type: String + displayName: Description + description: Description of the account + required: true + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: The full category of the account e.g. Liability.Current or Income.Revenue + required: true + fullyQualifiedName: + type: String + displayName: Fully Qualified Name + description: The full name of the account e.g. Liability.Current.VAT or Income.Revenue.Sales + required: true + currency: + type: String + displayName: Currency + description: The currency of the account + required: true + currentBalance: + type: Number + displayName: Current Balance + description: The current balance in the account + required: true + type: + type: String + displayName: Account Type + description: 'The type, or base category, of the account' + required: true + status: + type: String + displayName: Account Status + description: The status of the account + required: true + isBankAccount: + type: Boolean + displayName: Is Bank Account? + description: Confirms whether the nominal account represents a bank account or not + required: true + validDatatypeLinks: + type: Array + displayName: Valid Datatype Links + description: Describes which fields on other data types are valid links to this account in the originating system + properties: + property: + type: String + displayName: Property + description: The field on the source data type that other data types can link to + required: true + links: + type: Array + displayName: Links + description: 'A collection of absolute names of fields from other data types, e.g. Invoice.LineItems.AccountRef.Id' + required: true + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + Xero: + value: + type: Object + displayName: Nominal Account + description: Nominal Accounts are the categories a business uses to record transactions + properties: + nominalCode: + type: String + displayName: Nominal Code + description: Identifier for the nominal account. + required: true + validation: + warnings: + - field: NominalCode + details: Max length of 10 characters. + information: [] + name: + type: String + displayName: Name + description: Name of account as it appears in the chart of accounts or general ledger. + required: true + validation: + warnings: [] + information: + - field: Name + details: Payments are enabled to this account if the name ends in .PaymentsEnabled. + description: + type: String + displayName: Description + description: Description for the nominal account. + required: false + fullyQualifiedCategory: + type: String + displayName: Fully Qualified Category + description: Account type and category for nominal account. + options: + - value: Asset.Current + type: String + displayName: Current Asset + required: false + - value: Asset.Fixed + type: String + displayName: Fixed Asset + required: false + - value: Asset.Inventory + type: String + displayName: Inventory + required: false + - value: Asset.NonCurrent + type: String + displayName: Non-current Asset + required: false + - value: Asset.Prepayment + type: String + displayName: Prepayment + required: false + - value: Expense.DirectCosts + type: String + displayName: Direct Costs + required: false + - value: Expense.Expense + type: String + displayName: Expense + required: false + - value: Expense.Overhead + type: String + displayName: Overhead + required: false + - value: Expense.Superannuation + type: String + displayName: Superannuation + required: false + - value: Expense.Wages + type: String + displayName: Wages + required: false + - value: Income.Sales + type: String + displayName: Sales + required: false + - value: Income.Revenue + type: String + displayName: Revenue + required: false + - value: Income.Other + type: String + displayName: Other Income + required: false + - value: Liability.Current + type: String + displayName: Current Liability + required: false + - value: Liability.Depreciation + type: String + displayName: Depreciation + required: false + - value: Liability.Liability + type: String + displayName: Liability + required: false + - value: Liability.NonCurrent + type: String + displayName: Non Current Liability + required: false + - value: Liability.PayAsYouGo + type: String + displayName: Pay As You Go Liability + required: false + - value: Liability.Superannuation + type: String + displayName: Superannuation Liability + required: false + - value: Liability.WagesPayable + type: String + displayName: Wages Payable Liability + required: false + - value: Equity.Equity + type: String + displayName: Equity + required: false + required: true + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-chartOfAccounts-model + x-speakeasy-group: loan-writeback.accounts + description: |- + The *Get create account model* endpoint returns the expected data for the request payload when creating an [account](https://docs.codat.io/lending-api#/schemas/Account) for a given company and integration. + + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions. + + **Integration-specific behavior** + + See the *response examples* for integration-specific indicative models. + '/companies/{companyId}/connections/{connectionId}/push/accounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + summary: Create account + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingAccount/definitions/accountPrototype' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateAccountResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Create account* endpoint creates a new [account](https://docs.codat.io/lending-api#/schemas/Account) for a given company's connection. + + [Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create account model](https://docs.codat.io/lending-api#/operations/get-create-chartOfAccounts-model). + operationId: create-account + x-speakeasy-group: loan-writeback.accounts + '/companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + summary: Create source account + 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. + + > ### 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 + requestBody: + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/SourceAccountV2/definitions/sourceAccountV2Prototype' + - $ref: '#/components/schemas/SourceAccount/definitions/sourceAccountPrototype' + 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: + value: + id: acc-002 + accountName: account-081 + sortCode: '123456' + accountType: Credit + accountNumber: '12345670' + currency: GBP + balance: 99.99 + modifiedDate: '2023-01-09T14:14:14.1057478Z' + responses: + '200': + description: Success + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/SourceAccountV2' + - $ref: '#/components/schemas/SourceAccount' + 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' + x-speakeasy-group: loan-writeback.source-accounts + '/companies/{companyId}/connections/{connectionId}/bankFeedAccounts/mapping': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Loan writeback + summary: List bank feed account mappings + 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 + x-speakeasy-group: loan-writeback.source-accounts + x-speakeasy-name-override: list-mappings + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankFeedMapping/definitions/bankFeedMappings' + examples: + Example: + 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 + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + post: + tags: + - Loan writeback + 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 + x-speakeasy-group: loan-writeback.source-accounts + x-speakeasy-name-override: create-mapping + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BankFeedBankAccountMapping' + examples: + Example: + value: + sourceAccountId: acc-002 + targetAccountId: account-081 + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankFeedBankAccountMappingResponse' + 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}/options/suppliers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create/update supplier model + tags: + - Loan writeback + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + Exact (Netherlands): + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + validation: + warnings: + - field: RegistrationNumber + details: 'Only for Exact Netherlands, if provided, must be exactly 20 characters in length' + information: [] + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: false + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: + - field: Addresses.Country + details: Must be a 2-letter country code + information: [] + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + required: false + validation: + warnings: [] + information: + - field: Addresses + details: 'Only the first address provided will be considered, all other entries will be not be recorded' + required: true + Exact (UK): + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + validation: + warnings: + - field: RegistrationNumber + details: 'Only for Exact Netherlands, if provided, must be exactly 20 characters in length' + information: [] + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: false + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: + - field: Addresses.Country + details: Must be a 2-letter country code + information: [] + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + required: false + validation: + warnings: [] + information: + - field: Addresses + details: 'Only the first address provided will be considered, all other entries will be not be recorded' + required: true + FreeAgent: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: true + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + country: + type: String + displayName: Country + description: The country for the address + required: false + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + required: false + validation: + warnings: [] + information: + - field: Addresses + details: Only one address may be specified + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: false + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + required: true + MYOB AccountRight and Essentials: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + validation: + warnings: + - field: SupplierName + details: Must not have the part after the first name longer than 30 characters. + - field: SupplierName + details: Must not have its first part (i.e. the first name) longer than 20 characters. + information: + - field: SupplierName + details: Must be provided and must contain a First and Last name separated by a ' '(space). + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + validation: + warnings: [] + information: + - field: EmailAddress + details: Must not be longer than 255 characters. + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + validation: + warnings: [] + information: + - field: Phone + details: Must not be longer than 21 characters. + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + validation: + warnings: [] + information: + - field: TaxNumber + details: Must not be longer than 19 characters. + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + validation: + warnings: [] + information: + - field: RegistrationNumber + details: Must not be longer than 14 characters. + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + required: false + - value: Unknown + type: String + required: false + required: true + validation: + warnings: [] + information: + - field: Status + details: Must be provided. + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + validation: + warnings: [] + information: + - field: Addresses.Line1 + details: Must not be longer than 127 characters. + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + validation: + warnings: [] + information: + - field: Addresses.Line2 + details: Must not be longer than 127 characters. + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + validation: + warnings: [] + information: + - field: Addresses.City + details: Must not be longer than 255 characters. + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + validation: + warnings: [] + information: + - field: Addresses.Region + details: Must not be longer than 255 characters. + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + validation: + warnings: [] + information: + - field: Addresses.PostalCode + details: Must not be longer than 11 characters. + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: [] + information: + - field: Addresses.Country + details: Must not be longer than 255 characters. + required: true + validation: + warnings: + - field: Addresses + details: Must only have 5 address entries at most. + information: + - field: Addresses + details: Must be provided. + required: true + Oracle NetSuite: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + type: + type: String + displayName: Address Type + description: The type of the address + options: + - value: Billing + type: String + displayName: Billing + required: false + - value: Delivery + type: String + displayName: Delivery + required: false + - value: Unknown + type: String + displayName: Unknown + required: false + required: true + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + country: + type: String + displayName: Country + description: The country for the address + required: true + validation: + warnings: + - field: Addresses.Country + details: Must be a two letter Country ISO code + information: [] + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + required: false + validation: + warnings: + - field: Addresses + details: Only one each of Billing and Delivery addresses can be provided + information: + - field: Addresses + details: Multiple addresses of Unknown type may be provided + required: true + QuickBooks Desktop: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + validation: + warnings: + - field: SupplierName + details: Max length of 41 characters. + information: [] + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: false + validation: + warnings: + - field: ContactName + details: Max length of 25 characters for first and last names + information: [] + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + validation: + warnings: + - field: TaxNumber + details: Max length of 30 characters. + information: [] + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + validation: + warnings: + - field: DefaultCurrency + details: 'Must be a three letter ISO code that matches an existing, active currency in the QuickBooks Desktop company' + - field: DefaultCurrency + details: Can only be set if Multicurrency is enabled within the QuickBooks Desktop company + information: + - field: DefaultCurrency + details: 'If not set, will default to the base currency of the QuickBooks Desktop company' + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + validation: + warnings: + - field: Addresses.Line1 + details: Max length of 41 characters. + information: [] + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + validation: + warnings: + - field: Addresses.Line2 + details: Max length of 41 characters. + information: [] + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + validation: + warnings: + - field: Addresses.City + details: Max length of 31 characters. + information: [] + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + validation: + warnings: + - field: Addresses.Region + details: Max length of 21 characters. + information: [] + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: + - field: Addresses.Country + details: Max length of 31 characters. + information: [] + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + validation: + warnings: + - field: Addresses.PostalCode + details: Max length of 13 characters. + information: [] + type: + type: String + displayName: Address Type + description: The type of the address + options: + - value: Billing + type: String + displayName: Billing Address + required: false + - value: Delivery + type: String + displayName: Delivery Address + required: false + required: true + validation: + warnings: [] + information: + - field: Addresses.Type + details: Only 1 address each of type(s) Billing/Delivery may be specified. + required: false + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + validation: + warnings: + - field: Phone + details: 'Country, area, and number are space separated' + information: [] + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + validation: + warnings: + - field: Addresses.Line1 + details: Max length of 500 characters. + information: [] + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + validation: + warnings: + - field: Addresses.Line2 + details: Max length of 500 characters. + information: [] + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + validation: + warnings: + - field: Addresses.City + details: Max length of 255 characters. + information: [] + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + validation: + warnings: + - field: Addresses.Region + details: Max length of 255 characters. + information: [] + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: + - field: Addresses.Country + details: Max length of 50 characters. + information: [] + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + validation: + warnings: + - field: Addresses.PostalCode + details: Only English alphabet characters are permitted. + - field: Addresses.PostalCode + details: Max length of 50 characters. + information: [] + type: + type: String + displayName: Address Type + description: The type of the address + options: + - value: Billing + type: String + displayName: Billing Address + required: false + required: true + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + required: true + QuickBooks Online: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + validation: + warnings: + - field: Phone + details: 'Country, area, and number are space separated' + information: [] + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + validation: + warnings: + - field: Addresses.Line1 + details: Max length of 500 characters. + information: [] + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + validation: + warnings: + - field: Addresses.Line2 + details: Max length of 500 characters. + information: [] + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + validation: + warnings: + - field: Addresses.City + details: Max length of 255 characters. + information: [] + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + validation: + warnings: + - field: Addresses.Region + details: Max length of 255 characters. + information: [] + country: + type: String + displayName: Country + description: The country for the address + required: false + validation: + warnings: + - field: Addresses.Country + details: Max length of 50 characters. + information: [] + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + validation: + warnings: + - field: Addresses.PostalCode + details: Only English alphabet characters are permitted. + - field: Addresses.PostalCode + details: Max length of 50 characters. + information: [] + type: + type: String + displayName: Address Type + description: The type of the address + options: + - value: Billing + type: String + displayName: Billing Address + required: false + required: true + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: false + required: true + Sage 50 (UK): + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + id: + type: String + displayName: Id + description: ID of the supplier. + required: true + validation: + warnings: + - field: id + details: 'The supplier ID must be unique, contain no spaces and have a maximum of 8 characters.' + information: + - field: id + details: 'The supplier ID must be all Uppercase, if it is not, it will be converted to Uppercase before pushing.' + supplierName: + type: String + displayName: Name + description: Name of the supplier. + required: true + validation: + warnings: + - field: supplierName + details: The supplier name can have a maximum of 60 characters + information: [] + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier. + required: false + validation: + warnings: + - field: contactName + details: The contact name can have a maximum of 30 characters + information: [] + emailAddress: + type: String + displayName: Email Address + description: The email address that the supplier may be contacted on. + required: false + phone: + type: String + displayName: Telephone + description: The telephone number that the supplier may be contacted on. + required: false + defaultCurrency: + type: String + displayName: Default Currency + description: 'If not provided, the currency will default to the company''s base currency.' + required: false + status: + type: String + displayName: Status + description: The status of the supplier. + options: + - value: Active + type: String + displayName: Active Status + required: false + required: false + addresses: + type: Array + displayName: Addresses + description: Contact addresses for the supplier. + properties: + line1: + type: String + displayName: Line 1 + description: Line 1 of the supplier address. + required: true + line2: + type: String + displayName: Line 2 + description: Line 2 of the supplier address. + required: false + city: + type: String + displayName: City + description: The city of the supplier address. + required: false + region: + type: String + displayName: Region + description: The region of the supplier address. + required: false + postalCode: + type: String + displayName: Postal code + description: Post or Zip code for the address. + required: false + type: + type: String + displayName: Type + description: The type of address as it related to the supplier. + options: + - value: Unknown + type: String + displayName: Unknown Address + required: false + required: false + validation: + warnings: [] + information: + - field: addresses.type + details: 'If Address type is not specified, it will default to type ''''Unknown''''' + required: false + validation: + warnings: + - field: addresses + details: Only one address can be included in the Addresses array. + information: [] + taxNumber: + type: String + displayName: Tax Number + description: Legal company registration identifier. + required: false + required: true + validation: + warnings: [] + information: + - details: 'Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company.' + Sage Business Cloud Accounting: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: false + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: true + validation: + warnings: + - field: Addresses.Line1 + details: 'If you''re adding an address for this Supplier, you must also include the first line' + information: [] + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + country: + type: String + displayName: Country + description: The country for the address + options: + - value: Afghanistan (AF) + type: String + displayName: Afghanistan (AF) + required: false + - value: Albania (AL) + type: String + displayName: Albania (AL) + required: false + - value: Algeria (DZ) + type: String + displayName: Algeria (DZ) + required: false + - value: Andorra (AD) + type: String + displayName: Andorra (AD) + required: false + - value: Angola (AO) + type: String + displayName: Angola (AO) + required: false + - value: Argentina (AR) + type: String + displayName: Argentina (AR) + required: false + - value: Armenia (AM) + type: String + displayName: Armenia (AM) + required: false + - value: Aruba (AW) + type: String + displayName: Aruba (AW) + required: false + - value: Australia (AU) + type: String + displayName: Australia (AU) + required: false + - value: Austria (AT) + type: String + displayName: Austria (AT) + required: false + - value: Azerbaijan (AZ) + type: String + displayName: Azerbaijan (AZ) + required: false + - value: Bahamas (BS) + type: String + displayName: Bahamas (BS) + required: false + - value: Bahrain (BH) + type: String + displayName: Bahrain (BH) + required: false + - value: Bangladesh (BD) + type: String + displayName: Bangladesh (BD) + required: false + - value: Barbados (BB) + type: String + displayName: Barbados (BB) + required: false + - value: Belarus (BY) + type: String + displayName: Belarus (BY) + required: false + - value: Belgium (BE) + type: String + displayName: Belgium (BE) + required: false + - value: Belize (BZ) + type: String + displayName: Belize (BZ) + required: false + - value: Benin (BJ) + type: String + displayName: Benin (BJ) + required: false + - value: Bermuda (BM) + type: String + displayName: Bermuda (BM) + required: false + - value: Bhutan (BT) + type: String + displayName: Bhutan (BT) + required: false + - value: Bolivia (BO) + type: String + displayName: Bolivia (BO) + required: false + - value: Bosnia and Herzegovina (BA) + type: String + displayName: Bosnia and Herzegovina (BA) + required: false + - value: Botswana (BW) + type: String + displayName: Botswana (BW) + required: false + - value: Brazil (BR) + type: String + displayName: Brazil (BR) + required: false + - value: British Virgin Islands (VG) + type: String + displayName: British Virgin Islands (VG) + required: false + - value: Brunei Darussalam (BN) + type: String + displayName: Brunei Darussalam (BN) + required: false + - value: Bulgaria (BG) + type: String + displayName: Bulgaria (BG) + required: false + - value: Burkina Faso (BF) + type: String + displayName: Burkina Faso (BF) + required: false + - value: Burundi (BI) + type: String + displayName: Burundi (BI) + required: false + - value: Cambodia (KH) + type: String + displayName: Cambodia (KH) + required: false + - value: Cameroon (CM) + type: String + displayName: Cameroon (CM) + required: false + - value: Canada (CA) + type: String + displayName: Canada (CA) + required: false + - value: Cape Verde (CV) + type: String + displayName: Cape Verde (CV) + required: false + - value: Cayman Islands (KY) + type: String + displayName: Cayman Islands (KY) + required: false + - value: Central African Republic (CF) + type: String + displayName: Central African Republic (CF) + required: false + - value: Chad (TD) + type: String + displayName: Chad (TD) + required: false + - value: Chile (CL) + type: String + displayName: Chile (CL) + required: false + - value: China (CN) + type: String + displayName: China (CN) + required: false + - value: Colombia (CO) + type: String + displayName: Colombia (CO) + required: false + - value: Comoros (KM) + type: String + displayName: Comoros (KM) + required: false + - value: Congo (CG) + type: String + displayName: Congo (CG) + required: false + - value: Costa Rica (CR) + type: String + displayName: Costa Rica (CR) + required: false + - value: Croatia (HR) + type: String + displayName: Croatia (HR) + required: false + - value: Cuba (CU) + type: String + displayName: Cuba (CU) + required: false + - value: Cura�ao (CW) + type: String + displayName: Cura�ao (CW) + required: false + - value: Cyprus (CY) + type: String + displayName: Cyprus (CY) + required: false + - value: Czech Republic (CZ) + type: String + displayName: Czech Republic (CZ) + required: false + - value: Democratic Republic of the Congo (CD) + type: String + displayName: Democratic Republic of the Congo (CD) + required: false + - value: Denmark (DK) + type: String + displayName: Denmark (DK) + required: false + - value: Djibouti (DJ) + type: String + displayName: Djibouti (DJ) + required: false + - value: Dominica (DM) + type: String + displayName: Dominica (DM) + required: false + - value: Dominican Republic (DO) + type: String + displayName: Dominican Republic (DO) + required: false + - value: East Timor (TP) + type: String + displayName: East Timor (TP) + required: false + - value: Ecuador (EC) + type: String + displayName: Ecuador (EC) + required: false + - value: Egypt (EG) + type: String + displayName: Egypt (EG) + required: false + - value: El Salvador (SV) + type: String + displayName: El Salvador (SV) + required: false + - value: Equatorial Guinea (GQ) + type: String + displayName: Equatorial Guinea (GQ) + required: false + - value: Eritrea (ER) + type: String + displayName: Eritrea (ER) + required: false + - value: Estonia (EE) + type: String + displayName: Estonia (EE) + required: false + - value: Ethiopia (ET) + type: String + displayName: Ethiopia (ET) + required: false + - value: Falkland Islands (Malvinas) (FK) + type: String + displayName: Falkland Islands (Malvinas) (FK) + required: false + - value: Federated States of Micronesia (FM) + type: String + displayName: Federated States of Micronesia (FM) + required: false + - value: Fiji (FJ) + type: String + displayName: Fiji (FJ) + required: false + - value: Finland (FI) + type: String + displayName: Finland (FI) + required: false + - value: France (FR) + type: String + displayName: France (FR) + required: false + - value: French Polynesia (PF) + type: String + displayName: French Polynesia (PF) + required: false + - value: Gabon (GA) + type: String + displayName: Gabon (GA) + required: false + - value: Gambia (GM) + type: String + displayName: Gambia (GM) + required: false + - value: Georgia (GE) + type: String + displayName: Georgia (GE) + required: false + - value: Germany (DE) + type: String + displayName: Germany (DE) + required: false + - value: Ghana (GH) + type: String + displayName: Ghana (GH) + required: false + - value: Gibraltar (GI) + type: String + displayName: Gibraltar (GI) + required: false + - value: Greece (GR) + type: String + displayName: Greece (GR) + required: false + - value: Greenland (GL) + type: String + displayName: Greenland (GL) + required: false + - value: Grenada (GD) + type: String + displayName: Grenada (GD) + required: false + - value: Guadaloupe (GP) + type: String + displayName: Guadaloupe (GP) + required: false + - value: Guam (GU) + type: String + displayName: Guam (GU) + required: false + - value: Guatemala (GT) + type: String + displayName: Guatemala (GT) + required: false + - value: Guernsey (GG) + type: String + displayName: Guernsey (GG) + required: false + - value: Guinea (GN) + type: String + displayName: Guinea (GN) + required: false + - value: Guinea-Bissau (GW) + type: String + displayName: Guinea-Bissau (GW) + required: false + - value: Guyana (GY) + type: String + displayName: Guyana (GY) + required: false + - value: Haiti (HT) + type: String + displayName: Haiti (HT) + required: false + - value: Honduras (HN) + type: String + displayName: Honduras (HN) + required: false + - value: Hong Kong (HK) + type: String + displayName: Hong Kong (HK) + required: false + - value: Hungary (HU) + type: String + displayName: Hungary (HU) + required: false + - value: Iceland (IS) + type: String + displayName: Iceland (IS) + required: false + - value: India (IN) + type: String + displayName: India (IN) + required: false + - value: Indonesia (ID) + type: String + displayName: Indonesia (ID) + required: false + - value: Iran (IR) + type: String + displayName: Iran (IR) + required: false + - value: Iraq (IQ) + type: String + displayName: Iraq (IQ) + required: false + - value: Ireland (IE) + type: String + displayName: Ireland (IE) + required: false + - value: Israel (IL) + type: String + displayName: Israel (IL) + required: false + - value: Italy (IT) + type: String + displayName: Italy (IT) + required: false + - value: Ivory Coast (CI) + type: String + displayName: Ivory Coast (CI) + required: false + - value: Jamaica (JM) + type: String + displayName: Jamaica (JM) + required: false + - value: Japan (JP) + type: String + displayName: Japan (JP) + required: false + - value: Jersey (JE) + type: String + displayName: Jersey (JE) + required: false + - value: Jordan (JO) + type: String + displayName: Jordan (JO) + required: false + - value: Kazakhstan (KZ) + type: String + displayName: Kazakhstan (KZ) + required: false + - value: Kenya (KE) + type: String + displayName: Kenya (KE) + required: false + - value: Kuwait (KW) + type: String + displayName: Kuwait (KW) + required: false + - value: Kyrgyzstan (KG) + type: String + displayName: Kyrgyzstan (KG) + required: false + - value: Laos (LA) + type: String + displayName: Laos (LA) + required: false + - value: Latvia (LV) + type: String + displayName: Latvia (LV) + required: false + - value: Lebanon (LB) + type: String + displayName: Lebanon (LB) + required: false + - value: Lesotho (LS) + type: String + displayName: Lesotho (LS) + required: false + - value: Liberia (LR) + type: String + displayName: Liberia (LR) + required: false + - value: Libya (LY) + type: String + displayName: Libya (LY) + required: false + - value: Liechtenstein (LI) + type: String + displayName: Liechtenstein (LI) + required: false + - value: Lithuania (LT) + type: String + displayName: Lithuania (LT) + required: false + - value: Luxembourg (LU) + type: String + displayName: Luxembourg (LU) + required: false + - value: Macau (MO) + type: String + displayName: Macau (MO) + required: false + - value: Macedonia (MK) + type: String + displayName: Macedonia (MK) + required: false + - value: Madagascar (MG) + type: String + displayName: Madagascar (MG) + required: false + - value: Malawi (MW) + type: String + displayName: Malawi (MW) + required: false + - value: Malaysia (MY) + type: String + displayName: Malaysia (MY) + required: false + - value: Maldives (MV) + type: String + displayName: Maldives (MV) + required: false + - value: Mali (ML) + type: String + displayName: Mali (ML) + required: false + - value: Malta (MT) + type: String + displayName: Malta (MT) + required: false + - value: Mauritania (MR) + type: String + displayName: Mauritania (MR) + required: false + - value: Mauritius (MU) + type: String + displayName: Mauritius (MU) + required: false + - value: Mexico (MX) + type: String + displayName: Mexico (MX) + required: false + - value: Moldova (MD) + type: String + displayName: Moldova (MD) + required: false + - value: Monaco (MC) + type: String + displayName: Monaco (MC) + required: false + - value: Mongolia (MN) + type: String + displayName: Mongolia (MN) + required: false + - value: Montenegro (ME) + type: String + displayName: Montenegro (ME) + required: false + - value: Morocco (MA) + type: String + displayName: Morocco (MA) + required: false + - value: Mozambique (MZ) + type: String + displayName: Mozambique (MZ) + required: false + - value: Myanmar (MM) + type: String + displayName: Myanmar (MM) + required: false + - value: Namibia (NA) + type: String + displayName: Namibia (NA) + required: false + - value: Nepal (NP) + type: String + displayName: Nepal (NP) + required: false + - value: Netherlands (NL) + type: String + displayName: Netherlands (NL) + required: false + - value: Netherlands Antilles (AN) + type: String + displayName: Netherlands Antilles (AN) + required: false + - value: New Caledonia (NC) + type: String + displayName: New Caledonia (NC) + required: false + - value: New Zealand (NZ) + type: String + displayName: New Zealand (NZ) + required: false + - value: Nicaragua (NI) + type: String + displayName: Nicaragua (NI) + required: false + - value: Niger (NE) + type: String + displayName: Niger (NE) + required: false + - value: Nigeria (NG) + type: String + displayName: Nigeria (NG) + required: false + - value: North Korea (KP) + type: String + displayName: North Korea (KP) + required: false + - value: Norway (NO) + type: String + displayName: Norway (NO) + required: false + - value: Oman (OM) + type: String + displayName: Oman (OM) + required: false + - value: Pakistan (PK) + type: String + displayName: Pakistan (PK) + required: false + - value: Panama (PA) + type: String + displayName: Panama (PA) + required: false + - value: Papua New Guinea (PG) + type: String + displayName: Papua New Guinea (PG) + required: false + - value: Paraguay (PY) + type: String + displayName: Paraguay (PY) + required: false + - value: Peru (PE) + type: String + displayName: Peru (PE) + required: false + - value: Philippines (PH) + type: String + displayName: Philippines (PH) + required: false + - value: Poland (PL) + type: String + displayName: Poland (PL) + required: false + - value: Portugal (PT) + type: String + displayName: Portugal (PT) + required: false + - value: Puerto Rico (PR) + type: String + displayName: Puerto Rico (PR) + required: false + - value: Qatar (QA) + type: String + displayName: Qatar (QA) + required: false + - value: Romania (RO) + type: String + displayName: Romania (RO) + required: false + - value: Russia (RU) + type: String + displayName: Russia (RU) + required: false + - value: Rwanda (RW) + type: String + displayName: Rwanda (RW) + required: false + - value: Saint Kitts and Nevis (KN) + type: String + displayName: Saint Kitts and Nevis (KN) + required: false + - value: Saint Pierre and Miquelon (PM) + type: String + displayName: Saint Pierre and Miquelon (PM) + required: false + - value: Samoa (WS) + type: String + displayName: Samoa (WS) + required: false + - value: San Marino (SM) + type: String + displayName: San Marino (SM) + required: false + - value: Sao Tome and Principe (ST) + type: String + displayName: Sao Tome and Principe (ST) + required: false + - value: Saudi Arabia (SA) + type: String + displayName: Saudi Arabia (SA) + required: false + - value: Senegal (SN) + type: String + displayName: Senegal (SN) + required: false + - value: Serbia (RS) + type: String + displayName: Serbia (RS) + required: false + - value: Seychelles (SC) + type: String + displayName: Seychelles (SC) + required: false + - value: Sierra Leone (SL) + type: String + displayName: Sierra Leone (SL) + required: false + - value: Singapore (SG) + type: String + displayName: Singapore (SG) + required: false + - value: Slovakia (SK) + type: String + displayName: Slovakia (SK) + required: false + - value: Slovenia (SI) + type: String + displayName: Slovenia (SI) + required: false + - value: Solomon Islands (SB) + type: String + displayName: Solomon Islands (SB) + required: false + - value: Somalia (SO) + type: String + displayName: Somalia (SO) + required: false + - value: South Africa (ZA) + type: String + displayName: South Africa (ZA) + required: false + - value: South Korea (KR) + type: String + displayName: South Korea (KR) + required: false + - value: Spain (ES) + type: String + displayName: Spain (ES) + required: false + - value: Sri Lanka (LK) + type: String + displayName: Sri Lanka (LK) + required: false + - value: St. Lucia (LC) + type: String + displayName: St. Lucia (LC) + required: false + - value: Sudan (SD) + type: String + displayName: Sudan (SD) + required: false + - value: Surinam (SR) + type: String + displayName: Surinam (SR) + required: false + - value: Swaziland (SZ) + type: String + displayName: Swaziland (SZ) + required: false + - value: Sweden (SE) + type: String + displayName: Sweden (SE) + required: false + - value: Switzerland (CH) + type: String + displayName: Switzerland (CH) + required: false + - value: Syria (SY) + type: String + displayName: Syria (SY) + required: false + - value: Taiwan (TW) + type: String + displayName: Taiwan (TW) + required: false + - value: Tajikistan (TJ) + type: String + displayName: Tajikistan (TJ) + required: false + - value: Tanzania (TZ) + type: String + displayName: Tanzania (TZ) + required: false + - value: Thailand (TH) + type: String + displayName: Thailand (TH) + required: false + - value: Togo (TG) + type: String + displayName: Togo (TG) + required: false + - value: Tonga (TO) + type: String + displayName: Tonga (TO) + required: false + - value: Trinidad and Tobago (TT) + type: String + displayName: Trinidad and Tobago (TT) + required: false + - value: Tunisia (TN) + type: String + displayName: Tunisia (TN) + required: false + - value: Turkey (TR) + type: String + displayName: Turkey (TR) + required: false + - value: Turkmenistan (TM) + type: String + displayName: Turkmenistan (TM) + required: false + - value: Tuvalu (TV) + type: String + displayName: Tuvalu (TV) + required: false + - value: Uganda (UG) + type: String + displayName: Uganda (UG) + required: false + - value: Ukraine (UA) + type: String + displayName: Ukraine (UA) + required: false + - value: United Arab Emirates (AE) + type: String + displayName: United Arab Emirates (AE) + required: false + - value: United Kingdom (GB) + type: String + displayName: United Kingdom (GB) + required: false + - value: United States (US) + type: String + displayName: United States (US) + required: false + - value: Uruguay (UY) + type: String + displayName: Uruguay (UY) + required: false + - value: Uzbekistan (UZ) + type: String + displayName: Uzbekistan (UZ) + required: false + - value: Vanuatu (VU) + type: String + displayName: Vanuatu (VU) + required: false + - value: Venezuela (VE) + type: String + displayName: Venezuela (VE) + required: false + - value: Vietnam (VN) + type: String + displayName: Vietnam (VN) + required: false + - value: Virgin Islands U.S. (VI) + type: String + displayName: Virgin Islands U.S. (VI) + required: false + - value: Western Sahara (EH) + type: String + displayName: Western Sahara (EH) + required: false + - value: Yemen (YE) + type: String + displayName: Yemen (YE) + required: false + - value: Zaire (ZR) + type: String + displayName: Zaire (ZR) + required: false + - value: Zambia (ZM) + type: String + displayName: Zambia (ZM) + required: false + - value: Zimbabwe (ZW) + type: String + displayName: Zimbabwe (ZW) + required: false + required: false + required: false + validation: + warnings: [] + information: + - field: Addresses + details: Can contain a maximum of one address + required: true + Sage Intacct: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + validation: + warnings: + - field: SupplierName + details: Must be between 1 and 100 characters + information: [] + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: true + validation: + warnings: + - field: ContactName + details: Must be between 1 and 200 characters + information: [] + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + options: + - value: Active + type: String + displayName: Active + required: false + - value: Archived + type: String + displayName: Archived + required: false + required: true + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: false + validation: + warnings: + - field: Phone + details: Must be no greater than 30 characters + information: [] + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: false + validation: + warnings: + - field: EmailAddress + details: Must be no greater than 200 characters + information: [] + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: false + validation: + warnings: + - field: TaxNumber + details: Must be no greater than 20 characters + information: [] + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: false + validation: + warnings: + - field: RegistrationNumber + details: Must be no greater than 100 characters + information: [] + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + options: + - value: AUD + type: String + displayName: Australian Dollar + required: false + - value: CAD + type: String + displayName: Canadian Dollar + required: false + - value: GBP + type: String + displayName: Pound Sterling + required: false + - value: USD + type: String + displayName: US Dollar + required: false + - value: ZAR + type: String + displayName: Rand + required: false + required: false + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: false + validation: + warnings: + - field: Addresses.Line1 + details: Must be no greater than 200 characters + information: [] + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: false + validation: + warnings: + - field: Addresses.Line2 + details: Must be no greater than 200 characters + information: [] + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: false + validation: + warnings: + - field: Addresses.City + details: Must be no greater than 80 characters + information: [] + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: false + validation: + warnings: + - field: Addresses.Region + details: Must be no greater than 40 characters + information: [] + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: false + validation: + warnings: + - field: Addresses.PostalCode + details: Must be no greater than 30 characters + information: [] + country: + type: String + displayName: Country + description: The country for the address + options: + - value: United States + type: String + displayName: United States + required: false + - value: Afghanistan + type: String + displayName: Afghanistan + required: false + - value: Aland Islands + type: String + displayName: Aland Islands + required: false + - value: Albania + type: String + displayName: Albania + required: false + - value: Algeria + type: String + displayName: Algeria + required: false + - value: American Samoa + type: String + displayName: American Samoa + required: false + - value: Andorra + type: String + displayName: Andorra + required: false + - value: Angola + type: String + displayName: Angola + required: false + - value: Anguilla + type: String + displayName: Anguilla + required: false + - value: Antarctica + type: String + displayName: Antarctica + required: false + - value: Antigua and Barbuda + type: String + displayName: Antigua and Barbuda + required: false + - value: Argentina + type: String + displayName: Argentina + required: false + - value: Armenia + type: String + displayName: Armenia + required: false + - value: Aruba + type: String + displayName: Aruba + required: false + - value: Australia + type: String + displayName: Australia + required: false + - value: Austria + type: String + displayName: Austria + required: false + - value: Azerbaijan + type: String + displayName: Azerbaijan + required: false + - value: Bahamas + type: String + displayName: Bahamas + required: false + - value: Bahrain + type: String + displayName: Bahrain + required: false + - value: Bangladesh + type: String + displayName: Bangladesh + required: false + - value: Barbados + type: String + displayName: Barbados + required: false + - value: Belarus + type: String + displayName: Belarus + required: false + - value: Belgium + type: String + displayName: Belgium + required: false + - value: Belize + type: String + displayName: Belize + required: false + - value: Benin + type: String + displayName: Benin + required: false + - value: Bermuda + type: String + displayName: Bermuda + required: false + - value: Bhutan + type: String + displayName: Bhutan + required: false + - value: Bolivia + type: String + displayName: Bolivia + required: false + - value: 'Bonaire, Sint Eustatius and Saba' + type: String + displayName: 'Bonaire, Sint Eustatius and Saba' + required: false + - value: Bosnia and Herzegovina + type: String + displayName: Bosnia and Herzegovina + required: false + - value: Botswana + type: String + displayName: Botswana + required: false + - value: Bouvet Island + type: String + displayName: Bouvet Island + required: false + - value: Brazil + type: String + displayName: Brazil + required: false + - value: British Indian Ocean Territory + type: String + displayName: British Indian Ocean Territory + required: false + - value: Brunei Darussalam + type: String + displayName: Brunei Darussalam + required: false + - value: Bulgaria + type: String + displayName: Bulgaria + required: false + - value: Burkina Faso + type: String + displayName: Burkina Faso + required: false + - value: Burundi + type: String + displayName: Burundi + required: false + - value: Cambodia + type: String + displayName: Cambodia + required: false + - value: Cameroon + type: String + displayName: Cameroon + required: false + - value: Canada + type: String + displayName: Canada + required: false + - value: Cape Verde + type: String + displayName: Cape Verde + required: false + - value: Cayman Islands + type: String + displayName: Cayman Islands + required: false + - value: Central African Republic + type: String + displayName: Central African Republic + required: false + - value: Chad + type: String + displayName: Chad + required: false + - value: Chile + type: String + displayName: Chile + required: false + - value: China + type: String + displayName: China + required: false + - value: Christmas Island + type: String + displayName: Christmas Island + required: false + - value: Cocos (Keeling) Islands + type: String + displayName: Cocos (Keeling) Islands + required: false + - value: Colombia + type: String + displayName: Colombia + required: false + - value: Comoros + type: String + displayName: Comoros + required: false + - value: Congo + type: String + displayName: Congo + required: false + - value: 'Congo, Democratic Republic' + type: String + displayName: 'Congo, Democratic Republic' + required: false + - value: Cook Islands + type: String + displayName: Cook Islands + required: false + - value: Costa Rica + type: String + displayName: Costa Rica + required: false + - value: C�te d'Ivoire + type: String + displayName: C�te d'Ivoire + required: false + - value: Croatia + type: String + displayName: Croatia + required: false + - value: Cuba + type: String + displayName: Cuba + required: false + - value: Cura�ao + type: String + displayName: Cura�ao + required: false + - value: Cyprus + type: String + displayName: Cyprus + required: false + - value: Czech Republic + type: String + displayName: Czech Republic + required: false + - value: Denmark + type: String + displayName: Denmark + required: false + - value: Djibouti + type: String + displayName: Djibouti + required: false + - value: Dominica + type: String + displayName: Dominica + required: false + - value: Dominican Republic + type: String + displayName: Dominican Republic + required: false + - value: Ecuador + type: String + displayName: Ecuador + required: false + - value: Egypt + type: String + displayName: Egypt + required: false + - value: El Salvador + type: String + displayName: El Salvador + required: false + - value: Equatorial Guinea + type: String + displayName: Equatorial Guinea + required: false + - value: Eritrea + type: String + displayName: Eritrea + required: false + - value: Estonia + type: String + displayName: Estonia + required: false + - value: Eswatini + type: String + displayName: Eswatini + required: false + - value: Ethiopia + type: String + displayName: Ethiopia + required: false + - value: Falkland Islands (Malvinas + type: String + displayName: Falkland Islands (Malvinas + required: false + - value: Faroe Islands + type: String + displayName: Faroe Islands + required: false + - value: Fiji + type: String + displayName: Fiji + required: false + - value: Finland + type: String + displayName: Finland + required: false + - value: France + type: String + displayName: France + required: false + - value: French Guiana + type: String + displayName: French Guiana + required: false + - value: French Polynesia + type: String + displayName: French Polynesia + required: false + - value: French Southern Territories + type: String + displayName: French Southern Territories + required: false + - value: Gabon + type: String + displayName: Gabon + required: false + - value: Gambia + type: String + displayName: Gambia + required: false + - value: Georgia + type: String + displayName: Georgia + required: false + - value: Germany + type: String + displayName: Germany + required: false + - value: Ghana + type: String + displayName: Ghana + required: false + - value: Gibraltar + type: String + displayName: Gibraltar + required: false + - value: Greece + type: String + displayName: Greece + required: false + - value: Greenland + type: String + displayName: Greenland + required: false + - value: Grenada + type: String + displayName: Grenada + required: false + - value: Guadeloupe + type: String + displayName: Guadeloupe + required: false + - value: Guam + type: String + displayName: Guam + required: false + - value: Guatemala + type: String + displayName: Guatemala + required: false + - value: Guernsey + type: String + displayName: Guernsey + required: false + - value: Guinea + type: String + displayName: Guinea + required: false + - value: Guinea-Bissau + type: String + displayName: Guinea-Bissau + required: false + - value: Guyana + type: String + displayName: Guyana + required: false + - value: Haiti + type: String + displayName: Haiti + required: false + - value: Heard Is. & Mcdonald Islands + type: String + displayName: Heard Is. & Mcdonald Islands + required: false + - value: Honduras + type: String + displayName: Honduras + required: false + - value: Hong Kong + type: String + displayName: Hong Kong + required: false + - value: Hungary + type: String + displayName: Hungary + required: false + - value: Iceland + type: String + displayName: Iceland + required: false + - value: India + type: String + displayName: India + required: false + - value: Indonesia + type: String + displayName: Indonesia + required: false + - value: 'Iran, Islamic Republic of' + type: String + displayName: 'Iran, Islamic Republic of' + required: false + - value: Iraq + type: String + displayName: Iraq + required: false + - value: Ireland + type: String + displayName: Ireland + required: false + - value: Isle of Man + type: String + displayName: Isle of Man + required: false + - value: Israel + type: String + displayName: Israel + required: false + - value: Italy + type: String + displayName: Italy + required: false + - value: Jamaica + type: String + displayName: Jamaica + required: false + - value: Japan + type: String + displayName: Japan + required: false + - value: Jersey + type: String + displayName: Jersey + required: false + - value: Jordan + type: String + displayName: Jordan + required: false + - value: Kazakhstan + type: String + displayName: Kazakhstan + required: false + - value: Kenya + type: String + displayName: Kenya + required: false + - value: Kiribati + type: String + displayName: Kiribati + required: false + - value: 'Korea, Republic of' + type: String + displayName: 'Korea, Republic of' + required: false + - value: 'Korea, Demo. People''s Rep' + type: String + displayName: 'Korea, Demo. People''s Rep' + required: false + - value: Kosovo + type: String + displayName: Kosovo + required: false + - value: Kuwait + type: String + displayName: Kuwait + required: false + - value: Kyrgyzstan + type: String + displayName: Kyrgyzstan + required: false + - value: Lao + type: String + displayName: Lao + required: false + - value: Latvia + type: String + displayName: Latvia + required: false + - value: Lebanon + type: String + displayName: Lebanon + required: false + - value: Lesotho + type: String + displayName: Lesotho + required: false + - value: Liberia + type: String + displayName: Liberia + required: false + - value: Libyan Arab Jamahiriya + type: String + displayName: Libyan Arab Jamahiriya + required: false + - value: Liechtenstein + type: String + displayName: Liechtenstein + required: false + - value: Lithuania + type: String + displayName: Lithuania + required: false + - value: Luxembourg + type: String + displayName: Luxembourg + required: false + - value: Macao + type: String + displayName: Macao + required: false + - value: Macedonia + type: String + displayName: Macedonia + required: false + - value: Madagascar + type: String + displayName: Madagascar + required: false + - value: Malawi + type: String + displayName: Malawi + required: false + - value: Malaysia + type: String + displayName: Malaysia + required: false + - value: Maldives + type: String + displayName: Maldives + required: false + - value: Mali + type: String + displayName: Mali + required: false + - value: Malta + type: String + displayName: Malta + required: false + - value: Marshall Islands + type: String + displayName: Marshall Islands + required: false + - value: Martinique + type: String + displayName: Martinique + required: false + - value: Mauritania + type: String + displayName: Mauritania + required: false + - value: Mauritius + type: String + displayName: Mauritius + required: false + - value: Mayotte + type: String + displayName: Mayotte + required: false + - value: Mexico + type: String + displayName: Mexico + required: false + - value: Micronesia + type: String + displayName: Micronesia + required: false + - value: 'Moldova, Republic of' + type: String + displayName: 'Moldova, Republic of' + required: false + - value: Monaco + type: String + displayName: Monaco + required: false + - value: Mongolia + type: String + displayName: Mongolia + required: false + - value: Montenegro + type: String + displayName: Montenegro + required: false + - value: Montserrat + type: String + displayName: Montserrat + required: false + - value: Morocco + type: String + displayName: Morocco + required: false + - value: Mozambique + type: String + displayName: Mozambique + required: false + - value: Myanmar + type: String + displayName: Myanmar + required: false + - value: Namibia + type: String + displayName: Namibia + required: false + - value: Nauru + type: String + displayName: Nauru + required: false + - value: Nepal + type: String + displayName: Nepal + required: false + - value: Netherlands + type: String + displayName: Netherlands + required: false + - value: Netherlands Antilles + type: String + displayName: Netherlands Antilles + required: false + - value: New Caledonia + type: String + displayName: New Caledonia + required: false + - value: New Zealand + type: String + displayName: New Zealand + required: false + - value: Nicaragua + type: String + displayName: Nicaragua + required: false + - value: Niger + type: String + displayName: Niger + required: false + - value: Nigeria + type: String + displayName: Nigeria + required: false + - value: Niue + type: String + displayName: Niue + required: false + - value: Norfolk Island + type: String + displayName: Norfolk Island + required: false + - value: Northern Mariana Islands + type: String + displayName: Northern Mariana Islands + required: false + - value: Norway + type: String + displayName: Norway + required: false + - value: Oman + type: String + displayName: Oman + required: false + - value: Pakistan + type: String + displayName: Pakistan + required: false + - value: Palau + type: String + displayName: Palau + required: false + - value: 'Palestinian Territory, Occupied' + type: String + displayName: 'Palestinian Territory, Occupied' + required: false + - value: Panama + type: String + displayName: Panama + required: false + - value: Papua New Guinea + type: String + displayName: Papua New Guinea + required: false + - value: Paraguay + type: String + displayName: Paraguay + required: false + - value: Peru + type: String + displayName: Peru + required: false + - value: Philippines + type: String + displayName: Philippines + required: false + - value: Pitcairn + type: String + displayName: Pitcairn + required: false + - value: Poland + type: String + displayName: Poland + required: false + - value: Portugal + type: String + displayName: Portugal + required: false + - value: Puerto Rico + type: String + displayName: Puerto Rico + required: false + - value: Qatar + type: String + displayName: Qatar + required: false + - value: Reunion + type: String + displayName: Reunion + required: false + - value: Romania + type: String + displayName: Romania + required: false + - value: Russian Federation + type: String + displayName: Russian Federation + required: false + - value: Rwanda + type: String + displayName: Rwanda + required: false + - value: Saint Barthelemy + type: String + displayName: Saint Barthelemy + required: false + - value: Saint Helena + type: String + displayName: Saint Helena + required: false + - value: Saint Kitts and Nevis + type: String + displayName: Saint Kitts and Nevis + required: false + - value: Saint Lucia + type: String + displayName: Saint Lucia + required: false + - value: Saint Martin + type: String + displayName: Saint Martin + required: false + - value: Saint Pierre and Miquelon + type: String + displayName: Saint Pierre and Miquelon + required: false + - value: Saint Vincent and the Grenadines + type: String + displayName: Saint Vincent and the Grenadines + required: false + - value: Samoa + type: String + displayName: Samoa + required: false + - value: San Marino + type: String + displayName: San Marino + required: false + - value: Sao Tome and Principe + type: String + displayName: Sao Tome and Principe + required: false + - value: Saudi Arabia + type: String + displayName: Saudi Arabia + required: false + - value: Senegal + type: String + displayName: Senegal + required: false + - value: Serbia + type: String + displayName: Serbia + required: false + - value: Seychelles + type: String + displayName: Seychelles + required: false + - value: Sierra Leone + type: String + displayName: Sierra Leone + required: false + - value: Singapore + type: String + displayName: Singapore + required: false + - value: Sint Maarten + type: String + displayName: Sint Maarten + required: false + - value: Slovakia + type: String + displayName: Slovakia + required: false + - value: Slovenia + type: String + displayName: Slovenia + required: false + - value: Solomon Islands + type: String + displayName: Solomon Islands + required: false + - value: Somalia + type: String + displayName: Somalia + required: false + - value: South Africa + type: String + displayName: South Africa + required: false + - value: S. Georgia & S. Sandwich Is + type: String + displayName: S. Georgia & S. Sandwich Is + required: false + - value: Spain + type: String + displayName: Spain + required: false + - value: Sri Lanka + type: String + displayName: Sri Lanka + required: false + - value: Sudan + type: String + displayName: Sudan + required: false + - value: South Sudan + type: String + displayName: South Sudan + required: false + - value: Suriname + type: String + displayName: Suriname + required: false + - value: Svalbard and Jan Mayen + type: String + displayName: Svalbard and Jan Mayen + required: false + - value: Sweden + type: String + displayName: Sweden + required: false + - value: Switzerland + type: String + displayName: Switzerland + required: false + - value: Syrian Arab Republic + type: String + displayName: Syrian Arab Republic + required: false + - value: Taiwan + type: String + displayName: Taiwan + required: false + - value: Tajikistan + type: String + displayName: Tajikistan + required: false + - value: 'Tanzania, United Republic of' + type: String + displayName: 'Tanzania, United Republic of' + required: false + - value: Thailand + type: String + displayName: Thailand + required: false + - value: Timor-Leste + type: String + displayName: Timor-Leste + required: false + - value: Togo + type: String + displayName: Togo + required: false + - value: Tokelau + type: String + displayName: Tokelau + required: false + - value: Tonga + type: String + displayName: Tonga + required: false + - value: Trinidad and Tobago + type: String + displayName: Trinidad and Tobago + required: false + - value: Tunisia + type: String + displayName: Tunisia + required: false + - value: Turkey + type: String + displayName: Turkey + required: false + - value: Turkmenistan + type: String + displayName: Turkmenistan + required: false + - value: Turks and Caicos Islands + type: String + displayName: Turks and Caicos Islands + required: false + - value: Tuvalu + type: String + displayName: Tuvalu + required: false + - value: Uganda + type: String + displayName: Uganda + required: false + - value: Ukraine + type: String + displayName: Ukraine + required: false + - value: United Arab Emirates + type: String + displayName: United Arab Emirates + required: false + - value: United Kingdom + type: String + displayName: United Kingdom + required: false + - value: US Minor Outlying Islands + type: String + displayName: US Minor Outlying Islands + required: false + - value: Uruguay + type: String + displayName: Uruguay + required: false + - value: Uzbekistan + type: String + displayName: Uzbekistan + required: false + - value: Vanuatu + type: String + displayName: Vanuatu + required: false + - value: Vatican City State + type: String + displayName: Vatican City State + required: false + - value: Venezuela + type: String + displayName: Venezuela + required: false + - value: Vietnam + type: String + displayName: Vietnam + required: false + - value: 'Virgin Islands, British' + type: String + displayName: 'Virgin Islands, British' + required: false + - value: 'Virgin Islands, U.S' + type: String + displayName: 'Virgin Islands, U.S' + required: false + - value: Wallis and Futuna + type: String + displayName: Wallis and Futuna + required: false + - value: Western Sahara + type: String + displayName: Western Sahara + required: false + - value: Yemen + type: String + displayName: Yemen + required: false + - value: Zambia + type: String + displayName: Zambia + required: false + - value: Zimbabwe + type: String + displayName: Zimbabwe + required: false + required: false + validation: + warnings: + - field: Addresses.Country + details: Required if TaxNumber is supplied + information: [] + required: false + validation: + warnings: + - field: Addresses + details: 'If supplied, must contain only 1 address' + - field: Addresses + details: 'If TaxNumber is supplied, an Address with a Country is required' + information: [] + required: true + Sandbox: + value: + type: Object + displayName: Supplier + description: A Supplier is a person or organisation that provides a product or service + properties: + supplierName: + type: String + displayName: Supplier Name + description: 'The name for the supplier, typically a company name' + required: true + contactName: + type: String + displayName: Contact Name + description: The name of the main contact for the supplier + required: true + emailAddress: + type: String + displayName: Email Address + description: The preferred email address the supplier should be contacted on + required: true + phone: + type: String + displayName: Phone + description: The preferred phone number the supplier should be contacted on + required: true + addresses: + type: Array + displayName: Addresses + description: A collection of addresses associated to the supplier + properties: + type: + type: String + displayName: Address Type + description: The type of the address + required: true + line1: + type: String + displayName: Line 1 + description: The first line of the address + required: true + line2: + type: String + displayName: Line 2 + description: The second line of the address + required: true + city: + type: String + displayName: City + description: 'The third line of the address, or city' + required: true + region: + type: String + displayName: Region + description: 'The fourth line of the address, or region' + required: true + country: + type: String + displayName: Country + description: The country for the address + required: true + postalCode: + type: String + displayName: Postal/Zip Code + description: The postal (or zip) code for the address + required: true + required: true + registrationNumber: + type: String + displayName: Registration Number + description: The supplier's registration number + required: true + taxNumber: + type: String + displayName: Tax Number + description: The supplier's tax number + required: true + status: + type: String + displayName: Supplier Status + description: The current state of the supplier + required: true + defaultCurrency: + type: String + displayName: Default Currency + description: The default currency for transactions recorded against the supplier + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + Xero: + value: + type: Object + displayName: Suppliers + description: 'An accounts payable contact that supplies good or services, also referred to as a vendor.' + properties: + supplierName: + type: String + displayName: Name + description: Name of the supplier. + required: true + phone: + type: String + displayName: Phone + description: Main contact phone number for the supplier. + required: false + validation: + warnings: + - field: phone + details: 'Country, area, and number are space separated' + information: [] + emailAddress: + type: String + displayName: Email + description: Main contact email for the supplier. + required: false + registrationNumber: + type: String + displayName: Registration Number + description: Legal company registration identifier. + required: false + validation: + warnings: + - field: registrationNumber + details: Max length of 50 characters + information: [] + taxNumber: + type: String + displayName: Tax Number + description: Legal tax registration identifier. + required: false + status: + type: String + displayName: Status + description: Status of the supplier account. + options: + - value: Active + type: String + displayName: Active + required: false + - value: InActive + type: String + displayName: Inactive + required: false + required: false + addresses: + type: Array + displayName: Addresses + description: Contact addresses for the supplier. + properties: + line1: + type: String + displayName: Address Line 1 + description: First line of the address. + required: false + validation: + warnings: + - field: addresses.line1 + details: Max length of 500 characters. + information: [] + line2: + type: String + displayName: Address Line 2 + description: Second line of the address. + required: false + validation: + warnings: + - field: addresses.line2 + details: Max length of 500 characters. + information: [] + city: + type: String + displayName: City + description: Local city for the address. + required: false + validation: + warnings: + - field: addresses.city + details: Max length of 255 characters. + information: [] + region: + type: String + displayName: Region + description: Region the address is located in. + required: false + validation: + warnings: + - field: addresses.region + details: Max length of 255 characters. + information: [] + country: + type: String + displayName: Country + description: Country for the address. + required: false + validation: + warnings: + - field: addresses.country + details: Max length of 50 characters. + information: [] + postalCode: + type: String + displayName: Postal code + description: Post or Zip code for the address. + required: false + validation: + warnings: + - field: addresses.postalCode + details: Only English alphabet characters are permitted. + - field: addresses.postalCode + details: Max length of 50 characters. + information: [] + type: + type: String + displayName: Type + description: The type of address as it related to the supplier. + options: + - value: Billing + type: String + displayName: Billing Address + required: false + - value: Delivery + type: String + displayName: Delivery Address + required: false + required: true + validation: + warnings: + - field: addresses.type + details: 'Billing = POBOX, Delivery/Unknown = DELIVERY' + information: [] + required: false + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-update-suppliers-model + x-speakeasy-group: loan-writeback.suppliers + description: "The *Get create/update supplier model* endpoint returns the expected data for the request payload when creating and updating a [supplier](https://docs.codat.io/lending-api#/schemas/Supplier) for a given company and integration.\r\n\r\n[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\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/suppliers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingSupplier' + examples: + Sage Intacct: + value: + id: '73593' + supplierName: test 20230420 1004 + contactName: Joe Bloggs + status: Active + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateSupplierResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + summary: Create supplier + description: "The *Create supplier* endpoint creates a new [supplier](https://docs.codat.io/lending-api#/schemas/Supplier) for a given company's connection.\r\n\r\n[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.\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 supplier model](https://docs.codat.io/lending-api#/operations/get-create-update-suppliers-model).\r\n" + operationId: create-supplier + x-speakeasy-group: loan-writeback.suppliers + '/companies/{companyId}/connections/{connectionId}/options/transfers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create transfer model + tags: + - Loan writeback + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + Exact (Netherlands): + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + contactRef: + type: Object + displayName: Contact Reference + description: The customer or supplier for this transfer if known + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: ContactRef.Id + details: Must match the ID of an existing customer or supplier. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: customers + type: String + displayName: customers + required: false + - value: suppliers + type: String + displayName: suppliers + required: false + required: true + required: false + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: From.Amount + details: Transfer Amount must be greater than zero. + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank or nominal account. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: chartOfAccounts + type: String + displayName: chartOfAccounts + required: false + required: true + required: true + validation: + warnings: + - field: From.AccountRef + details: Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account). + information: [] + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: To.Amount + details: Transfer Amount must be greater than zero. + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank or nominal account. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: chartOfAccounts + type: String + displayName: chartOfAccounts + required: false + required: true + required: true + validation: + warnings: + - field: To.AccountRef + details: Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account). + information: [] + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this transfer is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: false + required: false + required: true + Exact (UK): + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + contactRef: + type: Object + displayName: Contact Reference + description: The customer or supplier for this transfer if known + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: ContactRef.Id + details: Must match the ID of an existing customer or supplier. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: customers + type: String + displayName: customers + required: false + - value: suppliers + type: String + displayName: suppliers + required: false + required: true + required: false + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: From.Amount + details: Transfer Amount must be greater than zero. + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank or nominal account. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: chartOfAccounts + type: String + displayName: chartOfAccounts + required: false + required: true + required: true + validation: + warnings: + - field: From.AccountRef + details: Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account). + information: [] + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: To.Amount + details: Transfer Amount must be greater than zero. + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank or nominal account. + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: chartOfAccounts + type: String + displayName: chartOfAccounts + required: false + required: true + required: true + validation: + warnings: + - field: To.AccountRef + details: Transfers between two bank accounts must be handled with two separate transfers to/from an offset account (only balance sheet type nominal account). + information: [] + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this transfer is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: false + required: false + required: true FreeAgent: value: - 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: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank account. + information: [] + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: From.Amount + details: Must be provided and be greater than zero. + information: [] + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank account. + information: [] + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: false + validation: + warnings: + - field: To.Amount + details: 'If provided, must be greater than zero.' + - field: To.Amount + details: It will be taken into account just if the accounts are in different currencies and will override the automatic currency conversion. + information: [] + required: true + required: true + Oracle NetSuite: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: false + validation: + warnings: [] + information: + - field: Date + details: Will default to today's date if not provided + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Either the 'From' account or the 'To' account must be a bank account - the other must be an undeposited funds account + information: [] + required: true + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Either the 'From' account or the 'To' account must be a bank account - the other must be an undeposited funds account + information: [] + required: true + required: true + depositedRecordRefs: + type: Array + displayName: Deposited Record References + description: A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer. + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this transfer is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + validation: + warnings: + - field: TrackingCategoryRefs.Id + details: 'One location, one department and one classification may be provided' + information: [] + required: false + required: true + validation: + warnings: + - details: Currently only transfers between bank accounts and undeposited funds accounts are supported + information: [] + QuickBooks Desktop: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: From.Amount + details: Value should match To.Amount + - field: From.Amount + details: Value should be greater than zero + information: [] + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + validation: + warnings: + - field: From.Currency + details: 'This value is not used in the push, and will be ignored.' + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: To.Amount + details: Value should match To.Amount + - field: To.Amount + details: Value should be greater than zero + information: [] + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: false + validation: + warnings: + - field: To.Currency + details: 'This value is not used in the push, and will be ignored.' + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this transfer is being tracked against + required: false + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + validation: + warnings: + - field: Description + details: Max length of 4096 characters. + information: [] + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + contactRef: + type: Object + displayName: Contact Reference + description: The customer or supplier for this transfer if known + required: false + validation: + warnings: + - field: ContactRef + details: 'This value is not used in the push, and will be ignored.' + information: [] + sourceModifiedDate: + type: DateTime + displayName: Source Modified Date + description: The date the record was last changed in the originating system + required: true + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + required: true + depositedRecordRefs: + type: Array + displayName: Deposited Record References + description: A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer. + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: payments + type: String + displayName: Payments + required: false + - value: directIncomes + type: String + displayName: DirectIncomes + required: false + - value: journalEntries + type: String + displayName: JournalEntries + required: false + required: true + required: false + required: true + validation: + warnings: + - details: 'When pushing a transfer using two different currencies, the exchange rate will be calculated and passed to QuickBooks, QuickBooks performs rounding on this value which may affect the values in the transfer' + - details: Transfers between accounts in different currencies can only be made if multi-currency is enabled for company + - details: The currency of at least one of the accounts used must be the same as the company's currency + information: [] + QuickBooks Online: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + required: true + depositedRecordRefs: + type: Array + displayName: Deposited Record References + description: A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer. + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: payments + type: String + displayName: Payments + required: false + - value: directIncomes + type: String + displayName: DirectIncomes + required: false + - value: journalEntries + type: String + displayName: JournalEntries + required: false + required: true + required: false + required: true + validation: + warnings: + - details: 'When pushing a transfer using two different currencies, the exchange rate will be calculated and passed to QuickBooks, QuickBooks performs rounding on this value which may affect the values in the transfer' + - details: Transfers between accounts in different currencies can only be made if multi-currency is enabled for company + - details: The currency of at least one of the accounts used must be the same as the company's currency + information: [] + Sage Business Cloud Accounting: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: false + validation: + warnings: + - field: Description + details: Must be provided if pushing a bank deposit. + information: + - field: Description + details: Must not be longer than 2000 characters. + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + validation: + warnings: [] + information: + - field: Date + details: Must be provided. + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: Must be different from To.AccountRef.Id. + - field: AccountRef.Id + details: Must match the ID of an existing bank account in the company's base currency. + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: [] + information: + - field: From.Amount + details: Must be equal to To.Amount. + - field: From.Amount + details: Must be greater than zero. + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: Must be different from From.AccountRef.Id. + - field: AccountRef.Id + details: Must match the ID of an existing bank account in the company's base currency. + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: [] + information: + - field: To.Amount + details: Must be equal to From.Amount. + - field: To.Amount + details: Must be greater than zero. + required: true + required: true + Sandbox: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + description: + type: String + displayName: Transfer Description + description: The description of the transfer + required: true + contactRef: + type: Object + displayName: Contact Reference + description: The customer or supplier for this transfer if known + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + status: + type: String + displayName: Status + description: The status of the transfer in the account + required: true + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + currency: + type: String + displayName: Currency + description: The currency of the transfer + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + status: + type: String + displayName: Status + description: The status of the transfer in the account + required: true + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this transfer is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + name: + type: String + displayName: Tracking Category Name + description: The name of the category referenced by the identifier + required: true + required: true + depositedRecordRefs: + type: Array + displayName: Deposited Record References + description: A collection of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the undeposited funds (or other holding) account within this transfer. + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + Xero: + value: + type: Object + displayName: Transfer + description: Transfers to or from a bank account + properties: + date: + type: DateTime + displayName: Transfer Date + description: The date the transfer occurred + required: true + from: + type: Object + displayName: Transfered From + description: The account and amount that money was transfered from + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank account. + information: [] + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: From.Amount + details: Must be equal to To.Amount. + - field: From.Amount + details: Must be greater than zero. + information: [] + status: + type: String + displayName: Status + description: The status of the transfer in the account + options: + - value: Unknown + type: String + displayName: Unknown + required: false + - value: Unreconciled + type: String + displayName: Unreconciled + required: false + - value: Reconciled + type: String + displayName: Reconciled + required: false + required: true + validation: + warnings: [] + information: + - field: From.Status + details: Must be provided. + required: true + to: + type: Object + displayName: Transfered To + description: The account and amount that money was transfered to + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the bank or nominal account + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing bank account. + information: [] + required: true + amount: + type: Number + displayName: Amount + description: The amount transfered + required: true + validation: + warnings: + - field: To.Amount + details: Must be equal to From.Amount. + - field: To.Amount + details: Must be greater than zero. + information: [] + status: + type: String + displayName: Status + description: The status of the transfer in the account + options: + - value: Unknown + type: String + displayName: Unknown + required: false + - value: Unreconciled + type: String + displayName: Unreconciled + required: false + - value: Reconciled + type: String + displayName: Reconciled + required: false + required: true + validation: + warnings: [] + information: + - field: To.Status + details: Must be provided. + required: true + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-transfers-model + x-speakeasy-group: loan-writeback.transfers + description: | + The *Get create transfer model* endpoint returns the expected data for the request payload when creating a [transfer](https://docs.codat.io/lending-api#/schemas/Transfer) for a given company and integration. + + [Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. + + **Integration-specific behavior** + + See the *response examples* for integration-specific indicative models. + '/companies/{companyId}/connections/{connectionId}/push/transfers': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + summary: Create transfer + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingTransfer' + examples: + QuickBooks Desktop: + value: + description: test transfers push 20230126 12.08 + contactRef: + id: 80000028-167239230944 + dataType: customers + date: '2023-01-26T11:51:18.104Z' + from: + accountRef: + id: 80000028-1671794219 + dataType: bankAccounts + amount: 12 + to: + accountRef: + id: 80000004-1671793811 + dataType: bankAccounts + amount: 12 + status: Unknown + trackingCategoryRefs: + - id: 80000001-1674553252 + name: Class 1 + metadata: + isDeleted: true + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateTransferResponse' + examples: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Create transfer* endpoint creates a new [transfer](https://docs.codat.io/lending-api#/schemas/Transfer) for a given company's connection. + + [Transfers](https://docs.codat.io/lending-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create transfer model](https://docs.codat.io/lending-api#/operations/get-create-transfers-model). + operationId: create-transfer + x-speakeasy-group: loan-writeback.transfers + '/companies/{companyId}/connections/{connectionId}/options/bankAccounts/{accountId}/bankTransactions': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingAccountId' + get: + tags: + - Loan writeback + summary: Get create bank account transactions model + description: |- + The *Get create bank account transactions model* endpoint returns the expected data for the request payload when creating [bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) for a given company and integration. + + [Bank account transactions](https://docs.codat.io/lending-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 + x-speakeasy-group: loan-writeback.bank-transactions + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/push/bankAccounts/{accountId}/bankTransactions': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/accountingAccountId' + post: + tags: + - Loan writeback + summary: Create bank account transactions + description: | + The *Create bank account transactions* endpoint creates new [bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) for a given company's connection. + + [Bank account transactions](https://docs.codat.io/lending-api#/schemas/BankTransactions) are records of money that has moved in and out of an SMB's bank account. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create bank transaction model](https://docs.codat.io/lending-api#/operations/get-create-bankTransactions-model). + operationId: create-bank-transactions + x-speakeasy-group: loan-writeback.bank-transactions + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateBankTransactions' + examples: {} + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateBankTransactionsResponse' + 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}/options/directCosts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + summary: Get create direct cost model + tags: + - Loan writeback + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOption' + examples: + Dynamics 365 Business Central: + value: + type: Object + displayName: Direct Cost + description: '' + properties: + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: false + validation: + warnings: [] + information: + - field: Note + details: is not supported and will be ignored + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + required: false + validation: + warnings: [] + information: + - field: ContactRef + details: is not supported and will be ignored + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + validation: + warnings: [] + information: + - field: Currency + details: 'If unspecified, base currency is assumed. Must agree with the bank account in PaymentAllocations' + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + validation: + warnings: [] + information: + - field: CurrencyRate + details: Required if the currency is not the base currency + subTotal: + type: Number + displayName: Sub Total Amount + description: The total amount of the direct transaction excluding any taxes + required: false + validation: + warnings: [] + information: + - field: SubTotal + details: is not supported and will be ignored + taxAmount: + type: Number + displayName: Tax Amount + description: The total amount of tax on the direct transaction + required: false + validation: + warnings: [] + information: + - field: TaxAmount + details: is not supported and will be ignored + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: false + validation: + warnings: [] + information: + - field: TotalAmount + details: is not supported and will be ignored + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: false + validation: + warnings: [] + information: + - field: LineItems.UnitAmount + details: is not supported and will be ignored + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: false + validation: + warnings: [] + information: + - field: LineItems.Quantity + details: is not supported and will be ignored + discountAmount: + type: Number + displayName: Discount Amount + description: 'The value, in the given currency, of any discounts applied' + required: false + validation: + warnings: [] + information: + - field: LineItems.DiscountAmount + details: is not supported and will be ignored + discountPercentage: + type: Number + displayName: Discount Percentage + description: The percentage rate of any discount that has been applied + required: false + validation: + warnings: [] + information: + - field: LineItems.DiscountPercentage + details: is not supported and will be ignored + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: false + validation: + warnings: [] + information: + - field: LineItems.SubTotal + details: Required if totalAmount is not specified + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: false + validation: + warnings: [] + information: + - field: LineItems.TaxAmount + details: is not supported and will be ignored + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + validation: + warnings: [] + information: + - field: LineItems.TotalAmount + details: Required if subTotal is not specified + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + name: + type: String + displayName: Name + description: Name of the account + required: false + validation: + warnings: [] + information: + - field: AccountRef.Name + details: is not supported and will be ignored + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + name: + type: String + displayName: Name + description: The name of the tax rate referenced by the identifier + required: false + validation: + warnings: [] + information: + - field: TaxRateRef.Name + details: is not supported and will be ignored + effectiveTaxRate: + type: Number + displayName: Effective Tax Rate + description: 'The total applied tax percentage, including compounding details' + required: false + validation: + warnings: [] + information: + - field: TaxRateRef.EffectiveTaxRate + details: is not supported and will be ignored + required: true + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + required: false + validation: + warnings: [] + information: + - field: LineItems.ItemRef + details: is not supported and will be ignored + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + required: false + validation: + warnings: [] + information: + - field: LineItems.TrackingCategoryRefs + details: is not supported and will be ignored + required: true + validation: + warnings: + - field: LineItems + details: Only one line is supported + information: [] + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + name: + type: String + displayName: Name + description: Name of the account + required: false + validation: + warnings: [] + information: + - field: AccountRef.Name + details: is not supported and will be ignored + required: true + currency: + type: String + displayName: Currency + description: The currency for the payment + required: false + validation: + warnings: [] + information: + - field: Payment.Currency + details: is not supported and will be ignored + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the base company + required: false + validation: + warnings: [] + information: + - field: Payment.CurrencyRate + details: is not supported and will be ignored + paidOnDate: + type: DateTime + displayName: Paid On Date + description: The date the payment was paid + required: false + validation: + warnings: [] + information: + - field: Payment.PaidOnDate + details: is not supported and will be ignored + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: false + validation: + warnings: [] + information: + - field: Payment.TotalAmount + details: is not supported and will be ignored + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: false + validation: + warnings: [] + information: + - field: Allocation.Currency + details: is not supported and will be ignored + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the transaction + required: false + validation: + warnings: [] + information: + - field: Allocation.CurrencyRate + details: is not supported and will be ignored + allocatedOnDate: + type: DateTime + displayName: Allocated On Date + description: The date the payment was allocated + required: false + validation: + warnings: [] + information: + - field: Allocation.AllocatedOnDate + details: is not supported and will be ignored + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: false + validation: + warnings: [] + information: + - field: Allocation.TotalAmount + details: is not supported and will be ignored + required: true + required: true + validation: + warnings: + - field: PaymentAllocations + details: Only one line is supported + information: [] + required: true + FreeAgent: value: - 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 + type: Object + displayName: Direct Cost + description: '' + properties: + id: + type: String + displayName: Unique Direct Transaction ID + description: 'The identifier for the direct transaction, unique to the company' + required: false + validation: + warnings: + - field: Id + details: 'will be ignored on push. ' + information: [] + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + validation: + warnings: + - field: Reference + details: 'is not supported by FreeAgent and will not be mapped. ' + information: [] + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: true + validation: + warnings: [] + information: + - field: Note + details: must be provided + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: false + validation: + warnings: + - field: ContactRef.Id + details: 'is not supported by FreeAgent and will be ignored on push. ' + information: [] + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: false + validation: + warnings: + - field: ContactRef.DataType + details: 'is not supported by FreeAgent and will be ignored on push. ' + information: [] + required: false + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + validation: + warnings: [] + information: + - field: IssueDate + details: must be provided + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + validation: + warnings: + - field: CurrencyRate + details: 'will be ignored on push. ' + information: [] + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + validation: + warnings: + - field: LineItems.Description + details: 'If a Note is provided, this field will be ignored on push. ' + information: [] + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: false + validation: + warnings: + - field: LineItems.UnitAmount + details: 'will be ignored on push. ' + information: [] + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: false + validation: + warnings: + - field: LineItems.Quantity + details: 'will be ignored on push. ' + information: [] + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: false + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: must be provided + name: + type: String + displayName: Name + description: Name of the account + required: false + validation: + warnings: + - field: AccountRef.Name + details: 'will be ignored on push. ' + information: [] + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: false + validation: + warnings: + - field: TaxRateRef.Id + details: 'will be ignored on push. ' + information: [] + name: + type: String + displayName: Name + description: The name of the tax rate referenced by the identifier + required: false + validation: + warnings: + - field: TaxRateRef.Name + details: 'will be ignored on push. ' + information: [] + effectiveTaxRate: + type: Number + displayName: Effective Tax Rate + description: 'The total applied tax percentage, including compounding details' + required: false + validation: + warnings: + - field: TaxRateRef.EffectiveTaxRate + details: 'will be ignored on push. ' + information: [] + required: false + required: true + validation: + warnings: + - field: LineItems + details: Exactly one line item must be specified + information: [] + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + id: + type: String + displayName: Identifier + description: The identifier for the allocated payment + required: false + note: + type: String + displayName: Note + description: Any additional text based information associated with the allocated payment + required: false + reference: + type: String + displayName: Reference + description: Reference associated with the allocated payment + required: false + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: must be provided + name: + type: String + displayName: Name + description: Name of the account + required: false + validation: + warnings: + - field: AccountRef.Name + details: 'will be ignored on push. ' + information: [] + required: true + currency: + type: String + displayName: Currency + description: The currency for the payment + required: false + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the base company + required: false + paidOnDate: + type: DateTime + displayName: Paid On Date + description: The date the payment was paid + required: false + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: false + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: false + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the transaction + required: false + allocatedOnDate: + type: DateTime + displayName: Allocated On Date + description: The date the payment was allocated + required: false + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: false + required: false + required: true + subTotal: + type: Number + displayName: Sub Total Amount + description: The total amount of the direct transaction excluding any taxes + required: false + taxAmount: + type: Number + displayName: Tax Amount + description: The total amount of tax on the direct transaction + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: false + modifiedDate: + type: DateTime + displayName: Modified Date + description: The date the record was last updated in the system cache + required: false + validation: + warnings: + - field: ModifiedDate + details: 'will be ignored on push. ' + information: [] + sourceModifiedDate: + type: DateTime + displayName: Source Modified Date + description: The date the record was last changed in the originating system + required: false + validation: + warnings: + - field: SourceModifiedDate + details: 'will be ignored on push. ' + information: [] + required: true Oracle NetSuite: value: - 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 + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: false + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + required: true + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: true + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: false + validation: + warnings: [] + information: + - field: LineItems.UnitAmount + details: Should have the same sign across all line items + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: false + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: false + validation: + warnings: + - field: LineItems.AccountRef + details: Should not be a bank account + - field: LineItems.AccountRef + details: Should only be specified when pushing an expense + information: [] + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the item + required: true + required: false + validation: + warnings: + - field: LineItems.ItemRef + details: Should only be specified when pushing an item (not an expense) + information: [] + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + required: false + validation: + warnings: + - field: LineItems.TaxRateRef + details: Should be specified when item type is not 'Discount' + information: [] + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + required: false + required: true + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing account of type 'Bank' OR type 'Credit Card' + information: [] + required: true + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + required: true + required: true + validation: + warnings: [] + information: + - field: PaymentAllocations + details: Must contain a single allocation + required: true + QuickBooks Desktop: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + validation: + warnings: + - field: Reference + details: Represents the check number + information: [] + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: false + validation: + warnings: + - field: Note + details: Max length of 4096 characters. + information: [] + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + required: false + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + validation: + warnings: + - field: Currency + details: Must be a three letter ISO code + - field: Currency + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + information: + - field: Currency + details: 'If not set, will default to the default currency' + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + validation: + warnings: [] + information: + - field: CurrencyRate + details: 'If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1.' + - field: CurrencyRate + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: true + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: true + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: false + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: true + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + required: true + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + required: true + required: true + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + id: + type: String + displayName: Identifier + description: The identifier for the allocated payment + required: true + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + required: true + validation: + warnings: [] + information: + - field: Payment.AccountRef + details: The account in which to make the deposit + reference: + type: String + displayName: Reference + description: Reference associated with the allocated payment + required: false + validation: + warnings: [] + information: + - field: Payment.Reference + details: Use to reference the check number of this deposit. + note: + type: String + displayName: Note + description: Any additional text based information associated with the allocated payment + required: true + currency: + type: String + displayName: Currency + description: The currency for the payment + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the base company + required: true + paidOnDate: + type: DateTime + displayName: Paid On Date + description: The date the payment was paid + required: true + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: true + required: true + required: true + validation: + warnings: + - field: PaymentAllocations + details: Must contain a single payment allocation + information: [] + taxAmount: + type: Number + displayName: Tax Amount + description: The total amount of tax on the direct transaction + required: true + subTotal: + type: Number + displayName: Sub Total Amount + description: The total amount of the direct transaction excluding any taxes + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: false + sourceModifiedDate: + type: DateTime + displayName: Source Modified Date + description: The date the record was last changed in the originating system + required: false + modifiedDate: + type: DateTime + displayName: Modified Date + description: The date the record was last updated in the system cache + required: false + required: true QuickBooks Online Sandbox: value: - 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 + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: Suppliers + type: String + displayName: Suppliers + required: false + required: true + required: true + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: false + validation: + warnings: [] + information: + - field: IssueDate + details: 'If the issue date is not supplied, the current date on the server is used.' + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + validation: + warnings: + - field: Reference + details: Must be less than 22 characters. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + validation: + warnings: [] + information: + - field: Currency + details: Required if multi-currency is enabled for the company. + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: false + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: false + validation: + warnings: + - field: Allocation.TotalAmount + details: Must match the sum of the line items + information: [] + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: false + validation: + warnings: + - field: Allocation.Currency + details: Must match the Currency of the company + information: [] + required: false + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: false + validation: + warnings: + - field: Payment.TotalAmount + details: Must match the sum of the line items + information: [] + currency: + type: String + displayName: Currency + description: The currency for the payment + required: false + validation: + warnings: + - field: Payment.Currency + details: Must match the Currency of the company + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: 'Must be Bank, Cash or Asset account' + required: true + required: true + required: true + validation: + warnings: + - field: PaymentAllocations + details: Must have exactly one payment allocation. + information: [] + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + validation: + warnings: + - field: TrackingCategoryRefs.TrackingCategoryRefs + details: Must be a valid Id + information: [] + required: false + validation: + warnings: + - field: LineItems.TrackingCategoryRefs + details: Only one tracking category of type CLASS can be provided per item. + - field: LineItems.TrackingCategoryRefs + details: Only one tracking category of type DEPARTMENT can be provided per invoice. + - field: LineItems.TrackingCategoryRefs + details: All DEPARTMENT tracking categories must be the same + information: [] + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be an Expense or Income account + information: [] + required: false + validation: + warnings: + - field: LineItems.AccountRef + details: Must be set if ItemRef is not + information: [] + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the item + required: true + required: false + validation: + warnings: + - field: LineItems.ItemRef + details: Must be set if AccountRef is not + information: [] + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + validation: + warnings: + - field: LineItems.Description + details: Must be less than 4000 characters. + information: [] + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: true + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: false + validation: + warnings: + - field: LineItems.TaxAmount + details: Must be specified on all line items or none. If specified will override QBO tax calculations. + information: [] + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + validation: + warnings: [] + information: + - field: TaxRateRef.Id + details: 'If an organisation has Automated Sales Tax enabled for US locales, then only ''TAX'' (Automated Sales Tax) or ''NON'' (no tax) can be used. If Automated Sales Tax is disabled for US locales then ''TAX'' (Automated Sales Tax) will not be accepted and a different tax rate must be used.' + required: false + validation: + warnings: + - field: LineItems.TaxRateRef + details: Required for all companies except QuickBooks Online France companies. + information: [] + required: true + required: true QuickBooks Online: value: - 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): + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + options: + - value: Suppliers + type: String + displayName: Suppliers + required: false + required: true + required: true + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: false + validation: + warnings: [] + information: + - field: IssueDate + details: 'If the issue date is not supplied, the current date on the server is used.' + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + validation: + warnings: + - field: Reference + details: Must be less than 22 characters. + information: [] + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + validation: + warnings: [] + information: + - field: Currency + details: Required if multi-currency is enabled for the company. + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: false + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: false + validation: + warnings: + - field: Allocation.TotalAmount + details: Must match the sum of the line items + information: [] + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: false + validation: + warnings: + - field: Allocation.Currency + details: Must match the Currency of the company + information: [] + required: false + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: false + validation: + warnings: + - field: Payment.TotalAmount + details: Must match the sum of the line items + information: [] + currency: + type: String + displayName: Currency + description: The currency for the payment + required: false + validation: + warnings: + - field: Payment.Currency + details: Must match the Currency of the company + information: [] + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: 'Must be Bank, Cash or Asset account' + required: true + required: true + required: true + validation: + warnings: + - field: PaymentAllocations + details: Must have exactly one payment allocation. + information: [] + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + validation: + warnings: + - field: TrackingCategoryRefs.TrackingCategoryRefs + details: Must be a valid Id + information: [] + required: false + validation: + warnings: + - field: LineItems.TrackingCategoryRefs + details: Only one tracking category of type CLASS can be provided per item. + - field: LineItems.TrackingCategoryRefs + details: Only one tracking category of type DEPARTMENT can be provided per invoice. + - field: LineItems.TrackingCategoryRefs + details: All DEPARTMENT tracking categories must be the same + information: [] + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be an Expense or Income account + information: [] + required: false + validation: + warnings: + - field: LineItems.AccountRef + details: Must be set if ItemRef is not + information: [] + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the item + required: true + required: false + validation: + warnings: + - field: LineItems.ItemRef + details: Must be set if AccountRef is not + information: [] + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + validation: + warnings: + - field: LineItems.Description + details: Must be less than 4000 characters. + information: [] + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: true + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: false + validation: + warnings: + - field: LineItems.TaxAmount + details: Must be specified on all line items or none. If specified will override QBO tax calculations. + information: [] + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + validation: + warnings: [] + information: + - field: TaxRateRef.Id + details: 'If an organisation has Automated Sales Tax enabled for US locales, then only ''TAX'' (Automated Sales Tax) or ''NON'' (no tax) can be used. If Automated Sales Tax is disabled for US locales then ''TAX'' (Automated Sales Tax) will not be accepted and a different tax rate must be used.' + required: false + validation: + warnings: + - field: LineItems.TaxRateRef + details: Required for all companies except QuickBooks Online France companies. + information: [] + required: true + required: true + Sage 50 (UK): + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + reference: + type: String + displayName: Reference + description: The user reference for this direct cost. + required: false + issueDate: + type: Number + displayName: Issue Date + description: The date this payment was issued. + required: true + currency: + type: String + displayName: Currency + description: The currency in which the direct cost is issued in. + required: true + validation: + warnings: + - field: currency + details: This must match the target account's default currency. + information: [] + currencyRate: + type: Number + displayName: Currency Rate + description: The currency rate associated with this transaction. + required: true + accountRef: + type: Object + displayName: Bank Account + description: The bank account to pay this direct cost from. + properties: + id: + type: String + displayName: Account Id + description: Nominal code of the bank account. + required: true + validation: + warnings: + - field: accountRef.id + details: Must match the ID of an existing bank account and have a max length of 8 characters. + information: [] + required: true + subTotal: + type: Number + displayName: Sub Total + description: The net amount being paid in this direct cost. + required: true + validation: + warnings: [] + information: + - details: This must equal the sum of the line net amounts + taxAmount: + type: Number + displayName: Tax Amount + description: The tax amount being paid in this direct cost. + required: true + validation: + warnings: [] + information: + - details: This must equal the sum of the line tax amounts + totalAmount: + type: Number + displayName: Total Amount + description: The total amount being paid in this direct cost. + required: true + validation: + warnings: [] + information: + - details: This must equal the sum of the line amounts + lineItems: + type: Array + displayName: Line Items + description: Line items of the direct cost. + properties: + description: + type: String + displayName: description + description: Description of the direct cost line item. + required: false + accountRef: + type: Object + displayName: Nominal Code + description: Target bank account for the direct cost line item. + properties: + id: + type: String + displayName: Id + description: The ID of the Account the line is linked to. + required: true + required: true + unitAmount: + type: Number + displayName: Unit Amount + description: Unit amount for the direct cost line item. + required: true + validation: + warnings: + - field: LineItems.unitAmount + details: Cannot equal 0 and will be set to Net amount if not provided accordingly. + information: [] + quantity: + type: Number + displayName: Quantity + description: Quantity for the direct cost line item. + required: true + validation: + warnings: + - field: LineItems.quantity + details: Must be 1 or -1. + information: [] + subTotal: + type: Number + displayName: Net Amount + description: 'Amount for the direct cost line item. Debit entries are considered positive, and credit entries are considered negative.' + required: true + validation: + warnings: + - field: LineItems.subTotal + details: Cannot have both subtotal and tax amount as 0 for line item. + information: [] + taxAmount: + type: Number + displayName: Tax Amount + description: Tax amount for the direct cost line item. + required: false + validation: + warnings: + - field: LineItems.taxAmount + details: Cannot have both tax amount and subtotal as 0 for line item. + information: [] + totalAmount: + type: Number + displayName: Total Amount + description: Total amount for the direct cost line item. + required: false + validation: + warnings: [] + information: + - field: LineItems.totalAmount + details: Will be auto populated using tax amount and net amount. + taxCode: + type: Number + displayName: Tax Code Id + description: The tax code ID associated with this transaction. + required: true + trackingCategoryRefs: + type: Object + displayName: Tracking Category References + description: Tracking categories associated with this transaction. + properties: + id: + type: String + displayName: Id + description: The ID of the tracking category associated with the transaction + required: true + validation: + warnings: + - field: id + details: 'A department is required. If a project reference is provided, the cost code for that project must also be provided.' + information: [] + required: true + required: true + required: true + validation: + warnings: [] + information: + - details: 'Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company.' + Sage Intacct: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: true + validation: + warnings: [] + information: + - field: Note + details: Must be used to provide payee's name and contain no more than 80 characters. + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + validation: + warnings: [] + information: + - field: TaxRateRef.Id + details: Must be an existing tax rate in Sage Intacct. + required: true + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: true + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: false + validation: + warnings: [] + information: + - field: LineItems.Description + details: Must not contain no more than 1000 characters. + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: false + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: false + name: + type: String + displayName: Tracking Category Name + description: The name of the category referenced by the identifier + required: false + required: false + required: true + validation: + warnings: [] + information: + - field: LineItems + details: Must contain at least one line item. + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + paidOnDate: + type: DateTime + displayName: Paid On Date + description: The date the payment was paid + required: true + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: true + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: false + validation: + warnings: [] + information: + - field: Payment.TotalAmount + details: 'If provided, must match the sum of the line items.' + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: false + validation: + warnings: [] + information: + - field: Allocation.TotalAmount + details: 'If provided, must match the sum of the line items.' + required: true + required: true + validation: + warnings: [] + information: + - field: PaymentAllocations + details: Must contain a single allocation. + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + validation: + warnings: + - field: Currency + details: When supplying a currency ensure that it exists in your Sage Intacct entity otherwise the request will fail. + information: [] + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + validation: + warnings: [] + information: + - field: Reference + details: Must not contain no more than 45 characters. + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: false + validation: + warnings: [] + information: + - field: TotalAmount + details: 'If provided, must match the sum of the line items.' + required: true + Sandbox: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: true + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: true + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: true + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: true + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + name: + type: String + displayName: Name + description: Name of the account + required: true + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: true + name: + type: String + displayName: Name + description: The name of the tax rate referenced by the identifier + required: true + effectiveTaxRate: + type: Number + displayName: Effective Tax Rate + description: 'The total applied tax percentage, including compounding details' + required: true + required: true + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: true + discountAmount: + type: Number + displayName: Discount Amount + description: 'The value, in the given currency, of any discounts applied' + required: true + discountPercentage: + type: Number + displayName: Discount Percentage + description: The percentage rate of any discount that has been applied + required: true + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: true + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: true + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: true + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the item + required: true + name: + type: String + displayName: Name + description: The name of the item referenced by the identifier + required: true + required: true + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + name: + type: String + displayName: Tracking Category Name + description: The name of the category referenced by the identifier + required: true + required: true + tracking: + type: Object + displayName: Tracking + description: Information this item is being tracked against + properties: + recordRefs: + type: Array + displayName: Record References + description: A collection of records this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + invoiceTo: + type: Object + displayName: Invoice To + description: The entity the record should be invoiced to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + dataType: + type: String + displayName: DataType + description: The name of the data type for which the ID is valid. + required: true + required: true + required: true + required: true + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + id: + type: String + displayName: Identifier + description: The identifier for the allocated payment + required: true + note: + type: String + displayName: Note + description: Any additional text based information associated with the allocated payment + required: true + reference: + type: String + displayName: Reference + description: Reference associated with the allocated payment + required: true + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + name: + type: String + displayName: Name + description: Name of the account + required: true + required: true + currency: + type: String + displayName: Currency + description: The currency for the payment + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the base company + required: true + paidOnDate: + type: DateTime + displayName: Paid On Date + description: The date the payment was paid + required: true + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been paid + required: true + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the allocated payment and the currency of the transaction + required: true + allocatedOnDate: + type: DateTime + displayName: Allocated On Date + description: The date the payment was allocated + required: true + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: true + required: true + required: true + subTotal: + type: Number + displayName: Sub Total Amount + description: The total amount of the direct transaction excluding any taxes + required: true + taxAmount: + type: Number + displayName: Tax Amount + description: The total amount of tax on the direct transaction + required: true + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true + required: true + required: true + Xero: value: - 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: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + validation: + warnings: [] + information: + - field: IssueDate + details: Must be provided. + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + validation: + warnings: [] + information: + - field: Reference + details: Must not exceed 255 characters. + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: true + validation: + warnings: [] + information: + - field: Currency + details: Must be provided. + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + taxAmount: + type: Number + displayName: Tax Amount + description: The total amount of tax on the direct transaction + required: true + validation: + warnings: [] + information: + - field: TaxAmount + details: Must be provided. + totalAmount: + type: Number + displayName: Total Amount + description: 'The amount of the direct transaction, inclusive of tax' + required: true + validation: + warnings: [] + information: + - field: TotalAmount + details: Must be provided. + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: true + validation: + warnings: + - field: ContactRef.Id + details: Must be a valid GUID. + - field: ContactRef.Id + details: Must match the ID of an existing contact. + information: + - field: ContactRef.Id + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: ContactRef + details: Must be provided. + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be a bank account. + - field: AccountRef.Id + details: Must match the ID of an existing bank account. + information: + - field: AccountRef.Id + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: Payment.AccountRef + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: PaymentAllocations.Payment + details: Must be provided. + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + totalAmount: + type: Number + displayName: Total Amount + description: The total amount that has been allocated + required: true + validation: + warnings: + - field: Allocation.TotalAmount + details: Must be equal to the sum of line items. + information: + - field: Allocation.TotalAmount + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: PaymentAllocations.Allocation + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: PaymentAllocations + details: Must be provided. + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + description: + type: String + displayName: Description + description: Friendly name of the goods or services purchased + required: true + validation: + warnings: [] + information: + - field: LineItems.Description + details: Must not be longer than 4000 characters long. + quantity: + type: Number + displayName: Quantity + description: The number of units of goods or services purchased + required: true + validation: + warnings: [] + information: + - field: LineItems.Quantity + details: Must be provided. + unitAmount: + type: Number + displayName: Unit Amount + description: The price of each unit of goods or services + required: true + validation: + warnings: [] + information: + - field: LineItems.UnitAmount + details: Must be provided. + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + validation: + warnings: + - field: LineItems.TotalAmount + details: 'When negative, the push item will be converted to a DirectIncome and will be pushed accordingly.' + information: + - field: LineItems.TotalAmount + details: 'When one line is negative, all lines must be negative.' + taxAmount: + type: Number + displayName: Tax Amount + description: The amount of tax for the line + required: true + validation: + warnings: [] + information: + - field: LineItems.TaxAmount + details: Must be provided. + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be a valid GUID. + - field: AccountRef.Id + details: Must match the ID of an existing account. + information: + - field: AccountRef.Id + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: LineItems.AccountRef + details: Must be provided. + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + properties: + id: + type: String + displayName: Identifier + description: 'The identifier for the item, unique per tracking category' + required: true + validation: + warnings: [] + information: + - field: TrackingCategoryRefs.Id + details: Must be provided. + required: false + validation: + warnings: [] + information: + - field: LineItems.TrackingCategoryRefs + details: Tracking categories must not have the same parent tracking category. + - field: LineItems.TrackingCategoryRefs + details: Maximum of 2 Tracking Categories. + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: false + validation: + warnings: + - field: TaxRateRef.Id + details: Must match the ID of an existing tax rate. + information: + - field: TaxRateRef.Id + details: 'If not provided, will be set to the default tax rate for the line''s account.' + required: false + itemRef: + type: Object + displayName: Item Reference + description: 'Reference to the product or service type, or inventory item' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the item + required: false + validation: + warnings: + - field: ItemRef.Id + details: Must be a valid GUID. + - field: ItemRef.Id + details: Must match the ID of an existing item. + information: [] + required: false + required: true + validation: + warnings: [] + information: + - field: LineItems + details: Must be provided. + required: true + validation: + warnings: + - details: 'When negative, the push item will be converted to a DirectIncome and will be pushed accordingly.' + information: [] + Zoho Books: + value: + type: Object + displayName: Direct Cost + description: Direct Cost + properties: + reference: + type: String + displayName: Reference + description: User friendly reference for the direct transaction + required: false + note: + type: String + displayName: Note + description: The note attached to the direct transaction + required: false + issueDate: + type: DateTime + displayName: Issue Date + description: The date the direct transaction was issued + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the direct transaction and the base currency of the company + required: false + contactRef: + type: Object + displayName: Contact Ref + description: 'The contact associated with the direct transaction, if known' + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the record + required: false + required: false + validation: + warnings: [] + information: + - field: ContactRef + details: Required when pushing a negative direct cost & should reference either a Customer or Supplier when provided + lineItems: + type: Array + displayName: Direct Transaction Lines + description: A collection of lines that detail items related to the direct transaction + properties: + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the line, inclusive of discounts and tax' + required: false + validation: + warnings: [] + information: + - field: LineItems.TotalAmount + details: Should be provided when SubTotal is not provided + subTotal: + type: Number + displayName: Sub Total Amount + description: 'The amount of the line, inclusive of discounts but exclusive of tax' + required: false + validation: + warnings: [] + information: + - field: LineItems.SubTotal + details: Should be provided when TotalAmount is not provided + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the line item is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: true + taxRateRef: + type: Object + displayName: Tax Rate Reference + description: Reference to the tax rate code the line item is linked to + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the tax rate + required: false + required: false + trackingCategoryRefs: + type: Array + displayName: Tracking Category References + description: A collection of categories this item is being tracked against + required: false + required: true + currency: + type: String + displayName: Currency + description: The currency of the direct transaction + required: false + validation: + warnings: [] + information: + - field: Currency + details: Is required when pushing a negative direct cost + paymentAllocations: + type: Array + displayName: Payment Allocations + description: A collection of payments allocated to the direct transaction + properties: + payment: + type: Object + displayName: Payment + description: The payment to be allocated + properties: + currency: + type: String + displayName: Currency + description: The currency for the payment + required: false + validation: + warnings: [] + information: + - field: Payment.Currency + details: Is required when pushing a negative direct cost + accountRef: + type: Object + displayName: Account Reference + description: Reference to the account associated with the allocated payment + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: true + required: true + allocation: + type: Object + displayName: Allocation + description: The allocation information + properties: + currency: + type: String + displayName: Currency + description: The currency of the transaction + required: false + validation: + warnings: [] + information: + - field: Allocation.Currency + details: Is required when pushing a negative direct cost + required: true + required: true + required: true + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + operationId: get-create-directCosts-model + x-speakeasy-group: loan-writeback.direct-costs + description: | + The *Get create direct cost model* endpoint returns the expected data for the request payload when creating a [direct cost](https://docs.codat.io/lending-api#/schemas/DirectCost) for a given company and integration. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + + **Integration-specific behavior** + + See the *response examples* for integration-specific indicative models. + '/companies/{companyId}/connections/{connectionId}/push/directCosts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + summary: Create direct cost + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingDirectCost/definitions/directCostPrototype' + examples: + QuickBooks Desktop: + value: + reference: test ref + note: directCost 21/03 09.20 + contactRef: + id: 80000001-1671793885 + dataType: suppliers + issueDate: '2023-03-21T10:19:52.223Z' + currency: USD + lineItems: + - description: test description line 1 + unitAmount: 7 + quantity: 1 + discountAmount: 0 + discountPercentage: 0 + subTotal: 99 + taxAmount: 360 + totalAmount: 70 + accountRef: + id: 8000000D-1671793811 + name: Purchases - Hardware for Resale + itemRef: + id: 80000001-1674566705 + name: item test + trackingCategoryRefs: + - id: 80000001-1674553252 + name: Class 1 + paymentAllocations: + - payment: + note: payment allocations note + reference: payment allocations reference + accountRef: + id: 80000028-1671794219 + name: Bank Account 1 + paidOnDate: '2023-01-28T10:19:52.223Z' + totalAmount: 54 + allocation: + currencyRate: 0 + allocatedOnDate: '2023-01-29T10:19:52.223Z' + totalAmount: 88 + subTotal: 362 + taxAmount: 4 + totalAmount: 366 + Xero: + value: + reference: Scenario One neg DC + contactRef: + id: 699f0091-b127-4796-9f15-41a2f42abeb2 + dataType: suppliers + issueDate: '2023-02-25' + currency: GBP + lineItems: + - description: negative direct cost + unitAmount: 35 + quantity: -1 + subTotal: -35 + taxAmount: -7 + totalAmount: -42 + itemRef: + id: 965cfc0e-4d80-4059-9641-4a392f9ad549 + taxRateRef: + id: INPUT2 + paymentAllocations: + - payment: + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + currency: GBP + allocation: + totalAmount: -42 + subTotal: -35 + taxAmount: -7 + totalAmount: -42 + FreeAgent: + value: + issueDate: '2023-02-12' + currency: GBP + lineItems: + - unitAmount: 15 + quantity: 1 + subTotal: 15 + accountRef: + id: '288' + paymentAllocations: + - payment: + accountRef: + id: 750-1 + allocation: {} + subTotal: 15 + taxAmount: 0 + totalAmount: 15 + Sage Intacct: + value: + reference: test ref + note: Test 1 + issueDate: '2023-03-31T00:00:00' + currency: USD + currencyRate: 0.5 + lineItems: + - accountRef: + id: '195' + unitAmount: 9.99 + quantity: 1 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + paymentAllocations: + - payment: + id: '4355' + note: test note + reference: test reference + accountRef: + id: '348' + name: CMRR Renewal + currency: USD + paidOnDate: '2023-03-31T00:00:00' + totalAmount: 11.99 + allocation: + currency: USD + allocatedOnDate: '2023-03-31T00:00:00' + totalAmount: 11.99 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreateDirectCostResponse' + examples: + FreeAgent: 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 + changes: [] + data: + id: '372060709' + issueDate: '2023-02-12T00:00:00' + currency: GBP + currencyRate: 1 + lineItems: + - accountRef: + id: '288' + unitAmount: 15 + quantity: 1 + subTotal: 15 + taxAmount: 3 + totalAmount: 18 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '372060709' + accountRef: + id: 750-1 + currency: GBP + paidOnDate: '2023-02-12T00:00:00' + totalAmount: 18 + allocation: + currency: GBP + allocatedOnDate: '2023-02-12T00:00:00' + totalAmount: 18 + subTotal: 15 + taxAmount: 3 + totalAmount: 18 + sourceModifiedDate: '2023-02-12T15:15:53Z' + dataType: directCosts + companyId: a23f79d6-7cc9-486c-b388-8ab88faea947 + pushOperationKey: 0659a24d-2b66-4979-971e-4b98c3ed7f61 + dataConnectionKey: 35e38cd5-66ea-41b8-b555-9efd5b792b68 + requestedOnUtc: '2023-02-12T15:15:51.1723204Z' + completedOnUtc: '2023-02-12T15:15:54.7161036Z' + status: Success + statusCode: 200 Sage Intacct: value: - 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 + changes: + - type: Created + recordRef: + dataType: directCosts + data: + reference: test ref + note: Test 1 + issueDate: '2023-03-31T00:00:00' + currency: USD + currencyRate: 0.5 + lineItems: + - accountRef: + id: '195' + taxRateRef: + id: '95' + unitAmount: 9.99 + quantity: 1 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + id: '4355' + note: test note + reference: test reference + accountRef: + id: '348' + name: CMRR Renewal + currency: USD + paidOnDate: '2023-03-31T00:00:00' + totalAmount: 11.99 + allocation: + currency: USD + allocatedOnDate: '2023-03-31T00:00:00' + totalAmount: 11.99 + subTotal: 9.99 + taxAmount: 2 + totalAmount: 11.99 + dataType: directCosts + companyId: d7f743a9-1804-4116-8c8a-e606f7e2f66c + pushOperationKey: 0d74c1ad-00ad-4731-9e6e-98a86056959a + dataConnectionKey: fa139396-523a-4a58-bf2b-8da82c8a673f + requestedOnUtc: '2023-03-31T12:49:51.6503324Z' + status: Pending + statusCode: 202 Xero: value: - results: - - id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 - accountName: Business Bank Account - accountType: Debit - sortCode: '990404' - accountNumber: '987654321' - currency: GBP - balance: 6681.79 - modifiedDate: '2023-03-15T20:36:09Z' - sourceModifiedDate: '2023-03-15T20:35:07' - metadata: - isDeleted: false - - id: a8d6fb1a-8c5d-4683-90ce-bf9d28fc62ba - accountName: Business Savings Account - accountType: Debit - sortCode: '890303' - accountNumber: '876543210' - currency: GBP - balance: 0 - modifiedDate: '2023-03-15T20:36:09Z' - sourceModifiedDate: '2023-03-15T20:36:06' - metadata: - isDeleted: false - pageNumber: 1 - pageSize: 2 - totalResults: 2 - _links: - current: - href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/5ced9667-a310-443a-a711-958d36377141/connections/6a4bcf97-e46a-465c-abf6-c42cec8e48c0/data/bankAccounts - Zoho Books: - value: - results: - - id: '104957000000060010' - accountName: Abdi Test - accountType: Unknown - sortCode: '112233' - accountNumber: xxxx5678 - currency: GBP - balance: 69858.44 - modifiedDate: '2022-10-03T08:40:38Z' - institution: Test Bank - - id: '104957000000065002' - accountName: Abdi Test 2 - accountType: Unknown - sortCode: '' - accountNumber: '' - currency: AED - balance: 98.03 - modifiedDate: '2022-10-03T08:40:38Z' - institution: '' - pageNumber: 1 - pageSize: 2 - totalResults: 4 - _links: - current: - href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts?page=1&pageSize=2 - self: - href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts - next: - href: /companies/d0b68840-db50-4bc3-b88c-96e225333fea/connections/a2324b8e-60e9-451d-8eb1-0fdc8e8224df/data/bankAccounts?page=2&pageSize=2 + changes: [] + data: + reference: Scenario One neg DC + contactRef: + id: 699f0091-b127-4796-9f15-41a2f42abeb2 + dataType: suppliers + issueDate: '2023-02-25T00:00:00' + currency: GBP + lineItems: + - description: negative direct cost + taxRateRef: + id: INPUT2 + unitAmount: 35 + quantity: -1 + subTotal: -35 + taxAmount: -7 + totalAmount: -42 + itemRef: + id: 965cfc0e-4d80-4059-9641-4a392f9ad549 + trackingCategoryRefs: [] + paymentAllocations: + - payment: + accountRef: + id: bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4 + currency: GBP + paidOnDate: '0001-01-01T00:00:00' + totalAmount: 0 + allocation: + totalAmount: -42 + subTotal: 0 + taxAmount: -7 + totalAmount: -42 + dataType: directCosts + companyId: b5efee61-3fab-4a5d-9247-de03d6eda6db + pushOperationKey: 33347930-fcc5-4f95-aa13-4a0f7291b559 + dataConnectionKey: 1e355304-4476-422e-95cb-fa2a6d47fab4 + requestedOnUtc: '2023-02-24T13:43:26.5109173Z' + status: Pending + validation: + errors: [] + warnings: [] + statusCode: 202 '400': - $ref: '#/components/responses/Malformed-Query' + $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '402': @@ -1287,24 +72096,30 @@ 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': + description: |- + The *Create direct cost* endpoint creates a new [direct cost](https://docs.codat.io/lending-api#/schemas/DirectCost) for a given company's connection. + + [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) are business expenses that don't impact Accounts Payable. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create direct cost model](https://docs.codat.io/lending-api#/operations/get-create-directCosts-model). + operationId: create-direct-cost + x-speakeasy-group: loan-writeback.direct-costs + '/companies/{companyId}/connections/{connectionId}/options/payments': parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/connectionId' get: - summary: Get create/update bank account model - x-internal: true + summary: Get create payment model tags: - - Bank accounts + - Loan writeback responses: '200': description: OK @@ -1313,831 +72128,2441 @@ paths: schema: $ref: '#/components/schemas/PushOption' examples: - Dynamics 365 Business Central: - value: - type: Object - displayName: Bank Account - description: An account that bank transactions may be recorded against - properties: - accountName: - type: String - displayName: Name - description: The name of the bank account in the originating system - required: true - validation: - warnings: [] - information: - - field: AccountName - details: 'Needs to be of the format ''{No.}-{Name}''' - currency: - type: String - displayName: Currency - description: The currency of the bank account - required: true - accountNumber: - type: String - displayName: Account Number - description: The account number for the bank account - required: false - nominalCode: - type: String - displayName: Nominal Code - description: The external reference given to each nominal account for a business - required: false - validation: - warnings: [] - information: - - field: NominalCode - details: Bank Account Posting Group with Nominal Account must exist - sortCode: - type: String - displayName: Sort Code - description: The sort code for the bank account - required: false - validation: - warnings: [] - information: - - field: SortCode - details: Must have a length between 0 and 20 characters - iBan: - type: String - displayName: IBAN - description: The international bank account number of the account. Often used when making or receiving international payments - required: false - overdraftLimit: - type: Number - displayName: Overdraft Limit - description: The pre-arranged overdraft limit of the account - required: false - validation: - warnings: [] - information: - - field: OverdraftLimit - details: Default value is 0 - required: true - Exact (Netherlands): + 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 + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing account. + information: [] required: true - accountNumber: - type: String - displayName: Account Number - description: The account number for the bank account + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' required: true validation: warnings: - - field: 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. + - field: TotalAmount + details: Must match the sum of the line amounts. 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 + description: Currency of the payment required: true - accountNumber: - type: String - displayName: Account Number - description: The account number for the bank account + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company + required: true + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + validation: + warnings: [] + information: + - field: Lines.Amount + details: Must match the sum of the link amounts. + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: CreditNote + required: false + - value: Other + type: String + displayName: Other + required: false + required: true + required: true required: true validation: warnings: - - field: 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. + - field: Lines + details: Only one line may be specified 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: + FreshBooks: value: type: Object - displayName: Bank Account - description: An account that bank transactions may be recorded against + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) properties: - accountName: - type: String - displayName: Name - description: The name of the bank account in the originating system + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + required: true + required: true + validation: + warnings: + - field: Lines.Links + details: Payment Amount must not exceed Invoice Amount Due or available Customer Credit + - field: Lines.Links + details: Must be a Payment with one Invoice of PaymentOnAccount Link or two links of types Invoice and PaymentOnAccount + information: [] required: true - 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 + - field: Lines + details: Only one line is supported 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 + description: Currency of the payment options: - value: AED - type: String + type: Array displayName: AED required: false + - value: AFN + type: Array + displayName: AFN + required: false + - value: ALL + type: Array + displayName: ALL + required: false - value: AMD - type: String + type: Array displayName: AMD required: false + - value: ANG + type: Array + displayName: ANG + required: false - value: AOA - type: String + type: Array displayName: AOA required: false - value: ARS - type: String + type: Array displayName: ARS required: false - value: AUD - type: String + type: Array displayName: AUD required: false - value: AWG - type: String + type: Array displayName: AWG required: false - value: AZN - type: String + type: Array displayName: AZN required: false + - value: BAM + type: Array + displayName: BAM + required: false - value: BBD - type: String + type: Array displayName: BBD required: false - value: BDT - type: String + type: Array displayName: BDT required: false - value: BGN - type: String + type: Array displayName: BGN required: false + - value: BHD + type: Array + displayName: BHD + required: false + - value: BIF + type: Array + displayName: BIF + required: false + - value: BMD + type: Array + displayName: BMD + required: false + - value: BND + type: Array + displayName: BND + required: false + - value: BOB + type: Array + displayName: BOB + required: false - value: BRL - type: String + type: Array displayName: BRL required: false + - value: BSD + type: Array + displayName: BSD + required: false + - value: BTN + type: Array + displayName: BTN + required: false - value: BWP - type: String + type: Array displayName: BWP required: false + - value: BYR + type: Array + displayName: BYR + required: false + - value: BZD + type: Array + displayName: BZD + required: false - value: CAD - type: String + type: Array displayName: CAD required: false + - value: CDF + type: Array + displayName: CDF + required: false - value: CHF - type: String + type: Array displayName: CHF required: false - value: CLP - type: String + type: Array displayName: CLP required: false - value: CNY - type: String + type: Array displayName: CNY required: false - value: COP - type: String + type: Array displayName: COP required: false - value: CRC - type: String + type: Array displayName: CRC required: false - value: CUC - type: String + type: Array displayName: CUC required: false - value: CUP - type: String + type: Array displayName: CUP required: false + - value: CVE + type: Array + displayName: CVE + required: false - value: CZK - type: String + type: Array displayName: CZK required: false + - value: DJF + type: Array + displayName: DJF + required: false - value: DKK - type: String + type: Array displayName: DKK required: false - value: DOP - type: String + type: Array displayName: DOP required: false + - value: DZD + type: Array + displayName: DZD + required: false - value: EGP - type: String + type: Array displayName: EGP required: false + - value: ERN + type: Array + displayName: ERN + required: false + - value: ETB + type: Array + displayName: ETB + required: false - value: EUR - type: String + type: Array displayName: EUR required: false - value: FJD - type: String + type: Array displayName: FJD required: false + - value: FKP + type: Array + displayName: FKP + required: false - value: GBP - type: String + type: Array displayName: GBP required: false - value: GEL - type: String + type: Array displayName: GEL required: false + - value: GGP + type: Array + displayName: GGP + required: false - value: GHS - type: String + type: Array displayName: GHS required: false + - value: GIP + type: Array + displayName: GIP + required: false + - value: GMD + type: Array + displayName: GMD + required: false + - value: GNF + type: Array + displayName: GNF + required: false - value: GTQ - type: String + type: Array displayName: GTQ required: false - value: GYD - type: String + type: Array displayName: GYD required: false - value: HKD - type: String + type: Array displayName: HKD required: false - value: HNL - type: String + type: Array displayName: HNL required: false - value: HRK - type: String + type: Array displayName: HRK required: false + - value: HTG + type: Array + displayName: HTG + required: false - value: HUF - type: String + type: Array displayName: HUF required: false - value: IDR - type: String + type: Array displayName: IDR required: false - value: ILS - type: String + type: Array displayName: ILS required: false + - value: IMP + type: Array + displayName: IMP + required: false - value: INR - type: String + type: Array displayName: INR required: false + - value: IQD + type: Array + displayName: IQD + required: false + - value: IRR + type: Array + displayName: IRR + required: false - value: ISK - type: String + type: Array displayName: ISK required: false + - value: JEP + type: Array + displayName: JEP + required: false - value: JMD - type: String + type: Array displayName: JMD required: false + - value: JOD + type: Array + displayName: JOD + required: false - value: JPY - type: String + type: Array displayName: JPY required: false - value: KES - type: String + type: Array displayName: KES required: false + - value: KGS + type: Array + displayName: KGS + required: false + - value: KHR + type: Array + displayName: KHR + required: false + - value: KMF + type: Array + displayName: KMF + required: false + - value: KPW + type: Array + displayName: KPW + required: false - value: KRW - type: String + type: Array displayName: KRW required: false - value: KWD - type: String + type: Array displayName: KWD required: false - value: KYD - type: String + type: Array displayName: KYD required: false - value: KZT - type: String + type: Array displayName: KZT required: false - value: LAK - type: String + type: Array displayName: LAK required: false - value: LBP - type: String + type: Array displayName: LBP required: false - value: LKR - type: String + type: Array displayName: LKR required: false - - value: LTL - type: String - displayName: LTL + - value: LRD + type: Array + displayName: LRD required: false - - value: LVL - type: String - displayName: LVL + - value: LSL + type: Array + displayName: LSL + required: false + - value: LYD + type: Array + displayName: LYD required: false - value: MAD - type: String + type: Array displayName: MAD required: false - value: MDL - type: String + type: Array displayName: MDL required: false - value: MGA - type: String + type: Array displayName: MGA required: false + - value: MKD + type: Array + displayName: MKD + required: false + - value: MMK + type: Array + displayName: MMK + required: false + - value: MNT + type: Array + displayName: MNT + required: false + - value: MOP + type: Array + displayName: MOP + required: false + - value: MRO + type: Array + displayName: MRO + required: false - value: MUR - type: String + type: Array displayName: MUR required: false - value: MVR - type: String + type: Array displayName: MVR required: false - value: MWK - type: String + type: Array displayName: MWK required: false - value: MXN - type: String + type: Array displayName: MXN required: false - value: MYR - type: String + type: Array displayName: MYR required: false - value: MZN - type: String + type: Array displayName: MZN required: false - value: NAD - type: String + type: Array displayName: NAD required: false - value: NGN - type: String + type: Array displayName: NGN required: false + - value: NIO + type: Array + displayName: NIO + required: false - value: NOK - type: String + type: Array displayName: NOK required: false - value: NPR - type: String + type: Array displayName: NPR required: false - value: NZD - type: String + type: Array displayName: NZD required: false - value: OMR - type: String + type: Array displayName: OMR required: false + - value: PAB + type: Array + displayName: PAB + required: false - value: PEN - type: String + type: Array displayName: PEN required: false + - value: PGK + type: Array + displayName: PGK + required: false - value: PHP - type: String + type: Array displayName: PHP required: false - value: PKR - type: String + type: Array displayName: PKR required: false - value: PLN - type: String + type: Array displayName: PLN required: false + - value: PYG + type: Array + displayName: PYG + required: false - value: QAR - type: String + type: Array displayName: QAR required: false - value: RON - type: String + type: Array displayName: RON required: false - value: RSD - type: String + type: Array displayName: RSD required: false - value: RUB - type: String + type: Array displayName: RUB required: false - value: RWF - type: String + type: Array displayName: RWF required: false - value: SAR - type: String + type: Array displayName: SAR required: false + - value: SBD + type: Array + displayName: SBD + required: false - value: SCR - type: String + type: Array displayName: SCR required: false + - value: SDG + type: Array + displayName: SDG + required: false - value: SEK - type: String + type: Array displayName: SEK required: false - value: SGD - type: String + type: Array displayName: SGD required: false + - value: SHP + type: Array + displayName: SHP + required: false + - value: SLL + type: Array + displayName: SLL + required: false + - value: SOS + type: Array + displayName: SOS + required: false + - value: SPL + type: Array + displayName: SPL + required: false + - value: SRD + type: Array + displayName: SRD + required: false + - value: STD + type: Array + displayName: STD + required: false + - value: SVC + type: Array + displayName: SVC + required: false + - value: SYP + type: Array + displayName: SYP + required: false + - value: SZL + type: Array + displayName: SZL + required: false - value: THB - type: String + type: Array displayName: THB required: false + - value: TJS + type: Array + displayName: TJS + required: false + - value: TMT + type: Array + displayName: TMT + required: false - value: TND - type: String + type: Array displayName: TND required: false + - value: TOP + type: Array + displayName: TOP + required: false - value: TRY - type: String + type: Array displayName: TRY required: false - value: TTD - type: String + type: Array displayName: TTD required: false + - value: TVD + type: Array + displayName: TVD + required: false - value: TWD - type: String + type: Array displayName: TWD required: false - value: TZS - type: String + type: Array displayName: TZS required: false - value: UAH - type: String + type: Array displayName: UAH required: false - value: UGX - type: String + type: Array displayName: UGX required: false - value: USD - type: String + type: Array displayName: USD required: false - value: UYU - type: String + type: Array displayName: UYU required: false + - value: UZS + type: Array + displayName: UZS + required: false - value: VEF - type: String + type: Array displayName: VEF required: false - value: VND - type: String + type: Array displayName: VND required: false - value: VUV - type: String + type: Array displayName: VUV required: false + - value: WST + type: Array + displayName: WST + required: false - value: XAF - type: String + type: Array displayName: XAF required: false - value: XCD - type: String + type: Array displayName: XCD required: false + - value: XDR + type: Array + displayName: XDR + required: false - value: XOF - type: String + type: Array displayName: XOF required: false + - value: XPF + type: Array + displayName: XPF + required: false + - value: YER + type: Array + displayName: YER + required: false - value: ZAR - type: String + type: Array displayName: ZAR required: false - - value: ZMK + - value: ZMW + type: Array + displayName: ZMW + required: false + - value: ZWD + type: Array + displayName: ZWD + required: false + required: false + validation: + warnings: + - field: Currency + details: Can be used for Payments on Account only + information: [] + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + required: true + MYOB AccountRight and Essentials: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + validation: + warnings: + - field: CustomerRef.Id + details: Must be a valid GUID. + - field: CustomerRef.Id + details: Must match the ID of an existing customer. + information: + - field: CustomerRef.Id + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: CustomerRef + details: Must be provided. + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be a valid GUID. + - field: AccountRef.Id + details: Must match the ID of an existing account. + information: + - field: AccountRef.Id + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: AccountRef + details: Must be provided. + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: Precision must be maximum of two decimal places. + - field: TotalAmount + details: Must be greater than zero. + information: + - field: TotalAmount + details: Must be provided and must equal the sum of the link items amount. + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + validation: + warnings: [] + information: + - field: Date + details: Must be provided. + reference: + type: String + displayName: Reference + description: A user friendly reference for the payment + required: false + validation: + warnings: [] + information: + - field: Reference + details: Must not be greater than 8 characters long. + currency: + type: String + displayName: Currency + description: Currency of the payment + options: + - value: AUD type: String - displayName: ZMK + displayName: Australian Dollar required: false required: true - balance: + validation: + warnings: [] + information: + - field: Currency + details: Must be provided. + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + validation: + warnings: [] + information: + - field: Lines.Amount + details: Must be provided. + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + validation: + warnings: [] + information: + - field: Links.Id + details: Must be provided. + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + validation: + warnings: [] + information: + - field: Links.Amount + details: Precision must be maximum of two decimal places. + - field: Links.Amount + details: Must be provided. + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + required: false + required: true + validation: + warnings: [] + information: + - field: Links.Type + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: Lines.Links + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: Lines + details: Must be provided. + required: true + Oracle NetSuite: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + required: true + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing account of type 'Bank' OR type 'Asset' (with category 'FixedAsset'/'OthAsset'/'OthCurrAsset') OR type 'Liability' (with category 'LongTermLiab'/'OthCurrLiab') OR type 'Expense' (with category 'Expense'/'OthExpense') + information: [] + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: Must be greater than zero + - field: TotalAmount + details: Must be provided and must be equal to the sum of the lines amounts + information: [] + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + currency: + type: String + displayName: Currency + description: Currency of the payment + required: false + validation: + warnings: + - field: Currency + details: If the currency is set make sure it's the same as the 'Invoice' and/or 'CreditMemo' currency + information: [] + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + reference: + type: String + displayName: Reference + description: A user friendly reference for the payment + required: false + validation: + warnings: + - field: Reference + details: The id format should be 'location-' + information: + - field: Reference + details: This field can be used to provide a tracking category id (Location only) + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + validation: + warnings: + - field: Links.Id + details: If the Link Type specified is an 'Invoice' or 'CreditNote' make sure the status is either 'PartiallyPaid' or 'Submitted' + information: [] + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: Credit Note + required: false + - value: PaymentOnAccount + type: String + displayName: Payment On Account + required: false + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + required: true + required: true + required: true + QuickBooks Desktop: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + validation: + warnings: + - field: CustomerRef.Id + details: Must match the ID of an existing supplier. + information: [] + required: true + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing 'Bank' or 'Other Current Asset' account. + information: + - field: AccountRef.Id + details: Not required if total amount of the payment is 0. + required: true + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + reference: + type: String + displayName: Reference + description: A user friendly reference for the payment + required: false + validation: + warnings: + - field: Reference + details: Max length of 20 characters. + information: [] + currency: + type: String + displayName: Currency + description: Currency of the payment + required: false + validation: + warnings: + - field: Currency + details: Must be a three letter ISO code that matches the currency of the customer. + - field: Currency + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + information: + - field: Currency + details: 'If not set, will default to the default currency of the customer.' + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company + required: false + validation: + warnings: [] + information: + - field: CurrencyRate + details: 'If not set, will default to the rate set within QuickBooks Desktop, if no rate is set in QuickBooks Desktop, it will default to 1.' + - field: CurrencyRate + details: Can only be set if the QuickBooks Desktop company has Multicurrency enabled. + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: Must match the sum of amounts in the lines + information: [] + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + validation: + warnings: + - field: Lines.Amount + details: Amount plus the sum of amounts in the links must equal 0 + information: [] + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: Credit Note + required: false + - value: PaymentOnAccount + type: String + displayName: Payment On Account + required: false + required: true + validation: + warnings: + - field: Links.Type + details: 'Only 1 link with type ''PaymentOnAccount'' may be specified per line, this line may contain no other links' + - field: Links.Type + details: Only 1 link with type 'Invoice' may be specified per line + information: [] + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + required: true + required: true + required: true + QuickBooks Online Sandbox: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + required: true + validation: + warnings: [] + information: + - field: CustomerRef + details: 'Must be the ID of the Customer associated with the Invoice, Credit Note or Payment On Account.' + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: false + validation: + warnings: [] + information: + - field: AccountRef + details: Must match the ID of an existing Account. + paymentMethodRef: + type: Object + displayName: Payment Method Reference + description: Reference to the method of this payment + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the payment method + required: true + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + currency: + type: String + displayName: Currency + description: Currency of the payment + required: false + validation: + warnings: [] + information: + - field: Currency + details: Required if multi-currency is enabled for the company + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: Credit Note + required: false + - value: PaymentOnAccount + type: String + displayName: Payment On Account + required: false + required: true + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + required: true + required: false + required: true + QuickBooks Online: + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + required: true + validation: + warnings: [] + information: + - field: CustomerRef + details: 'Must be the ID of the Customer associated with the Invoice, Credit Note or Payment On Account.' + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + required: false + validation: + warnings: [] + information: + - field: AccountRef + details: Must match the ID of an existing Account. + paymentMethodRef: + type: Object + displayName: Payment Method Reference + description: Reference to the method of this payment + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the payment method + required: true + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + currency: + type: String + displayName: Currency + description: Currency of the payment + required: false + validation: + warnings: [] + information: + - field: Currency + details: Required if multi-currency is enabled for the company + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: false + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: Credit Note + required: false + - value: PaymentOnAccount + type: String + displayName: Payment On Account + required: false + required: true + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + required: true + required: false + required: true + Sage 50 (UK): + value: + type: Object + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) + properties: + accountRef: + type: Object + displayName: Bank Account + description: The bank account to pay this invoice from. + properties: + id: + type: String + displayName: Account Id + description: Nominal code of the bank account. + required: true + validation: + warnings: + - field: accountRef.id + details: Must match the ID of an existing bank account and have a max length of 8 characters. + information: [] + required: true + customerRef: + type: Object + displayName: Customer + description: Customer to be paid. + properties: + id: + type: String + displayName: Customer Id + description: Identifier of the customer. + required: true + validation: + warnings: + - field: customerRef.id + details: Must match the ID of an existing customer and have a max length of 8 characters. + information: [] + required: true + totalAmount: + type: Number + displayName: Total Amount + description: The total amount being paid to the customer. + required: true + validation: + warnings: [] + information: + - details: This must equal the sum of the line amounts + reference: + type: Number + displayName: Reference + description: The user reference for this invoice payment. + required: false + date: + type: Number + displayName: Issue Date + description: The date this payment was issued. + required: true + note: type: Number - displayName: Balance - description: The balance of the bank account + displayName: Note + description: A description of the payment. required: false + lines: + type: Array + displayName: Line Items + description: Line items of the payment. + properties: + amount: + type: Number + displayName: Amount + description: The amount of this line item + required: true + validation: + warnings: [] + information: + - details: this must equal the negative of the sum of the link amounts + links: + type: Array + displayName: Links + description: Links to the invoice being paid. + properties: + amount: + type: Number + displayName: Amount + description: The amount to be added to the value of the invoice + required: true + validation: + warnings: [] + information: + - details: 'When paying off an invoice, this value will be negative' + id: + type: String + displayName: Invoice Id + description: The ID of the invoice to pay + required: true + type: + type: String + displayName: Payment Link Type + description: The type of the item to be paid + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: PaymentOnAccount + type: String + displayName: Payment On Account + required: false + - value: Refund + type: String + displayName: Refund + required: false + - value: CreditNote + type: String + displayName: Credit Note + required: false + - value: Payment + type: String + displayName: Payment + required: false + required: true + required: true + required: true validation: warnings: [] information: - - field: Balance - details: 'The opening balance, in the account currency' - institution: - type: String - displayName: Institution - description: The institution of the bank account - required: false + - details: Sage 50 only supports one line item per invoice payment so all lines will be merged together in the response. required: true - KashFlow: + validation: + warnings: [] + information: + - details: 'Pushing to Sage 50 2015 (v21) or below is not supported. To enable push, please upgrade to at least Sage 50 2016 (v22) and re-sync the company.' + Sage Business Cloud Accounting: value: type: Object - displayName: Bank Account - description: An account that bank transactions may be recorded against + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) properties: - accountName: - type: String - displayName: Account Name - description: Name of the bank account as it appears in Kashflow. + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must match the ID of an existing Account. + information: + - field: AccountRef.Id + details: Must be provided. + required: false + validation: + warnings: + - field: AccountRef + details: Required unless the Payment is only allocating a Credit Note. + information: [] + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + validation: + warnings: + - field: CustomerRef.Id + details: Must match the ID of an existing Customer. + information: + - field: CustomerRef.Id + details: Must be provided. required: true - balance: + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + validation: + warnings: [] + information: + - field: Date + details: Must be provided. + totalAmount: type: Number - displayName: Balance - description: 'The opening balance, in the account currency.' + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true + validation: + warnings: + - field: TotalAmount + details: Must be zero when allocating against Invoices using a Credit Note only. + - field: TotalAmount + details: Must equal the sum of the link items amount. + information: + - field: TotalAmount + details: Must be provided. + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment required: false + validation: + warnings: + - field: Note + details: Should not be longer than 25 characters. + information: [] currency: type: String displayName: Currency - description: The currency of the bank account. + description: Currency of the payment + required: false + validation: + warnings: [] + information: + - field: Currency + details: 'If supplied, must match the currency of the customer.' + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company + required: false + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + validation: + warnings: [] + information: + - field: Links.Id + details: Must be provided. + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + validation: + warnings: + - field: Links.Amount + details: Must be greater than zero except when Type is Invoice + information: + - field: Links.Amount + details: Must be provided. + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: PaymentOnAccount + type: String + displayName: PaymentOnAccount + required: false + - value: Refund + type: String + displayName: Refund + required: false + - value: CreditNote + type: String + displayName: CreditNote + required: false + required: true + validation: + warnings: [] + information: + - field: Links.Type + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: Lines.Links + details: Must be provided. required: true required: true - QuickBooks Desktop: + Sage Intacct: value: type: Object - displayName: Bank Account - description: An account that bank transactions may be recorded against + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) properties: - nominalCode: - type: String - displayName: Nominal Code - description: The external reference given to each nominal account for a business + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' required: true validation: - warnings: - - field: NominalCode - details: Max length of 7 characters. - information: [] - accountName: + warnings: [] + information: + - field: TotalAmount + details: Must equal the sum of Lines.Amount. + note: type: String - displayName: Name - description: The name of the bank account in the originating system + displayName: Note + description: Any additional text based information associated with the payment + required: false + validation: + warnings: [] + information: + - field: Note + details: Must be less than 1000 characters. + paymentMethodRef: + type: Object + displayName: Payment Method Reference + description: Reference to the method of this payment + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the payment method + options: + - value: '1' + type: String + displayName: Printed Check + required: false + - value: '3' + type: String + displayName: Credit Card + required: false + - value: '5' + type: String + displayName: EFT + required: false + - value: '6' + type: String + displayName: Cash + required: false + required: true required: true + reference: + type: String + displayName: Reference + description: A user friendly reference for the payment + required: false validation: - warnings: - - field: AccountName - details: Max length of 31 characters. - information: [] + warnings: [] + information: + - field: Reference + details: Can be used to set the Document/Check No. in Sage Intacct. currency: type: String displayName: Currency - description: The currency of the bank account + description: Currency of the payment 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: + currencyRate: type: Number - displayName: Balance - description: The balance of the bank account + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company required: false + validation: + warnings: [] + information: + - field: CurrencyRate + details: Is required if currency is provided. + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + validation: + warnings: [] + information: + - field: Date + details: Must occur after the date the invoice was created. + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + validation: + warnings: [] + information: + - field: CustomerRef.Id + details: Must be an existing customer ID in Sage Intacct. + required: true + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: [] + information: + - field: AccountRef.Id + details: For undeposited payments use the GL account record number to charge. + - field: AccountRef.Id + details: 'To charge either a savings, checking or credit card account use its associated GL account number.' + required: true + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + validation: + warnings: [] + information: + - field: Lines.Amount + details: When added together with the sum of the Links.Amount the total must be zero. + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + validation: + warnings: [] + information: + - field: Links.Id + details: 'Must be a valid Record No. from accounts receivable of either an invoice for an ''Invoice'', adjustment for a ''CreditNote'' or an advance for a ''PaymentOnAccount'' in Sage Intacct.' + - field: Links.Id + details: Must be an integer. + - field: Links.Id + details: Must related to CustomerRef.Id in Sage Intacct. + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + required: true + validation: + warnings: [] + information: + - field: Links.Type + details: Must be one of Invoiceor CreditNoteor PaymentOnAccount. + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + validation: + warnings: [] + information: + - field: Links.Amount + details: Must not be more than the total amount due for an invoice or the available funds in the account to be charged. + required: true + validation: + warnings: [] + information: + - field: Lines.Links + details: No more than two links can exist when paying for an invoice via a CreditNoteor PaymentOnAccount. + - field: Lines.Links + details: Must contain only one Invoice. + required: true + validation: + warnings: [] + information: + - field: Lines + details: Must contain at least one payment line. required: true - QuickBooks Online Sandbox: + validation: + warnings: [] + information: + - details: Sage Intacct handles allocated payments only. + Sandbox: value: type: Object - displayName: Bank Account - description: An account that bank transactions may be recorded against + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) properties: - accountName: - type: String - displayName: Account Name - description: Name of account as it appears in the chart of accounts or general ledger. + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + companyName: + type: String + displayName: Name + description: The name of the customer referenced by the identifier + required: true required: true - 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. + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + name: + type: String + displayName: Name + description: Name of the account + required: true + required: true + paymentMethodRef: + type: Object + displayName: Payment Method Reference + description: Reference to the method of this payment + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the payment method + required: true + name: + type: String + displayName: Name + description: The name of the payment method referenced by the identifier + required: true + required: true + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' required: true currency: type: String displayName: Currency - description: Currency of the bank account. + description: Currency of the payment + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company + required: true + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true + note: + type: String + displayName: Note + description: Any additional text based information associated with the payment + required: true + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + required: true + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the currency of the linked transaction + required: true + required: true + allocatedOnDate: + type: DateTime + displayName: Allocated On Date + description: The date the payment was allocated + required: true + required: true + reference: + type: String + displayName: Reference + description: A user friendly reference for the payment + required: true + metadata: + type: Object + displayName: Metadata + description: Miscellaneous data about the item + properties: + isDeleted: + type: Boolean + displayName: IsDeleted + description: A boolean to indicate whether the object has been deleted + required: true required: true required: true - Sage Business Cloud Accounting: + Xero: value: type: Object - displayName: Bank Account - description: An account that bank transactions may be recorded against + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) properties: - accountName: - type: String - displayName: Name - description: The name of the bank account in the originating system + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true + validation: + warnings: + - field: CustomerRef.Id + details: Must be a valid GUID. + - field: CustomerRef.Id + details: Must match the ID of an existing account. + information: + - field: CustomerRef.Id + details: Must be provided. required: true validation: warnings: [] information: - - field: AccountName + - field: CustomerRef 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 + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: Must be a valid GUID. + - field: AccountRef.Id + details: Must match the ID of an existing account. + information: + - field: AccountRef.Id + details: Must be either a type of BANK account or enable payments must be switched on. required: true validation: warnings: [] information: - - field: Currency + - field: AccountRef 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 + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' + required: true validation: - warnings: [] + warnings: + - field: TotalAmount + details: 'Must be greater than 0, unless the payment is a credit note allocation.' 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 + - field: TotalAmount + details: Must be provided and must equal the sum of the link items amount. + date: + type: DateTime + displayName: Date + description: The date the payment was recorded + required: true validation: warnings: [] information: - - field: AccountNumber - details: Should not be longer than 25 characters. - iBan: + - field: Date + details: Must be provided. + reference: type: String - displayName: IBAN - description: The international bank account number of the account. Often used when making or receiving international payments + displayName: Reference + description: A user friendly reference for the payment + required: false + currencyRate: + type: Number + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company required: false + currency: + type: String + displayName: Currency + description: Currency of the payment + required: true validation: warnings: [] information: - - field: 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 + - field: Currency + details: Must be provided. + lines: + type: Array + displayName: Lines + description: A collection of payment lines + properties: + amount: + type: Number + displayName: Amount + description: The total amount for the line in the payment currency + required: true + validation: + warnings: [] + information: + - field: Lines.Amount + details: Must be provided. + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + validation: + warnings: + - field: Links.Id + details: Must be a valid GUID. + information: + - field: Links.Id + details: Invoice and Credit Note ID must be provided in order to allocate a Credit Note to an Invoice. + - field: Links.Id + details: Must be provided. + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + validation: + warnings: [] + information: + - field: Links.Amount + details: Must be provided. + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - value: Invoice + type: String + displayName: Invoice + required: false + - value: CreditNote + type: String + displayName: CreditNote + required: false + - value: Payment + type: String + displayName: Payment + required: false + required: true + validation: + warnings: [] + information: + - field: Links.Type + details: Must be provided. + required: true + validation: + warnings: [] + information: + - field: Lines.Links + details: Must be provided. + required: true validation: warnings: [] - information: - - field: NominalCode - details: Should be a number between 1 and 99999999. + information: + - field: Lines + details: Must be provided. required: true - Sandbox: + Zoho Books: value: type: Object - displayName: Bank Account - description: An account that bank transactions may be recorded against + displayName: Payment + description: A payment represents an allocation of transactions across an 'accounts receivable' account (customer) 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 + accountRef: + type: Object + displayName: Nominal Account Reference + description: Reference to the nominal account the payment is linked to + properties: + id: + type: String + displayName: Account ID + description: The identifier for the account + required: true + validation: + warnings: + - field: AccountRef.Id + details: AccountRef.ID is required when making a payment to an invoice and/or a payment on account + information: [] required: true - iBan: - type: String - displayName: IBAN - description: The international bank account number of the account. Often used when making or receiving international payments + customerRef: + type: Object + displayName: Customer Reference + description: Reference to the customer the payment has been sent by + properties: + id: + type: String + displayName: Identifier + description: The reference identifier for the customer + required: true required: true currency: type: String displayName: Currency - description: The currency of the bank account - required: true - balance: - type: Number - displayName: Balance - description: The balance of the bank account + description: Currency of the payment required: true - availableBalance: - type: Number - displayName: Available Balance - description: The available balance of the bank account + validation: + warnings: + - field: Currency + details: must match the currency of any invoices or credit notes + information: [] + date: + type: DateTime + displayName: Date + description: The date the payment was recorded required: true - overdraftLimit: + currencyRate: type: Number - displayName: Overdraft Limit - description: The pre-arranged overdraft limit of the account + displayName: Currency Exchange Rate + description: The exchange rate between the currency of the payment and the base currency of the company required: true - institution: + note: type: String - displayName: Institution - description: The institution of the bank account + displayName: Note + description: Any additional text based information associated with the payment + required: false + totalAmount: + type: Number + displayName: Total Amount + description: 'The total amount of the payment, inclusive of discounts and tax' required: true - metadata: - type: Object - displayName: Metadata - description: Miscellaneous data about the item + validation: + warnings: + - field: TotalAmount + details: must be greater than or equal to 0 + information: [] + lines: + type: Array + displayName: Lines + description: A collection of payment lines properties: - isDeleted: - type: Boolean - displayName: IsDeleted - description: A boolean to indicate whether the object has been deleted + links: + type: Array + displayName: Links + description: A collection of linked transactions + properties: + amount: + type: Number + displayName: Amount + description: 'The amount by which the balance of the linked entity is altered, in the currency of the linked entity' + required: true + validation: + warnings: + - field: Links.Amount + details: the sum of all link amounts must equal the negated total amount of the payment + information: [] + id: + type: String + displayName: Identifier + description: The identifier for the referenced transaction + required: true + type: + type: String + displayName: Link Type + description: The type of transaction that is being linked + options: + - type: Array + displayName: Invoice + required: false + - type: Array + displayName: CreditNote + required: false + - type: Array + displayName: PaymentOnAccount + required: false + required: true required: true + validation: + warnings: + - field: Lines.Links + details: 'if a credit note link is provided, exactly one invoice link must be provided, otherwise unlimited invoice links and one payment on account link are allowed' + information: [] required: true required: true '401': @@ -2154,2034 +74579,8826 @@ 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': + operationId: get-create-payment-model + x-speakeasy-group: loan-writeback.payments + description: |- + The *Get create payment model* endpoint returns the expected data for the request payload when creating a [payment](https://docs.codat.io/lending-api#/schemas/Payment) for a given company and integration. + + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. + + **Integration-specific behavior** + + See the *response examples* for integration-specific indicative models. + '/companies/{companyId}/connections/{connectionId}/push/payments': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Loan writeback + summary: Create payment + parameters: + - $ref: '#/components/parameters/timeoutInMinutes' + - $ref: '#/components/parameters/allowSyncOnPushComplete' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingPayment' + examples: + QuickBooks Desktop: + value: + customerRef: + id: 80000002-1674552702 + companyName: string + accountRef: + id: '8000002E-1675267199' + name: Undeposited Funds + paymentMethodRef: + id: string + name: string + totalAmount: 28 + currency: USD + currencyRate: 1 + date: '2023-02-10T11:47:04.792Z' + note: note 14/02 1147 + lines: + - amount: 28 + links: + - type: Invoice + id: 181-1676374586 + amount: -28 + currencyRate: 1 + allocatedOnDate: '2023-02-11T11:47:04.792Z' + reference: ref 14/02 1147 + Sage 50 (UK): + value: + customerRef: + id: CUST1 + accountRef: + id: '1200' + name: Bank Current Account + paymentMethodRef: + id: '4405' + totalAmount: 4 + currency: GBP + currencyRate: 1 + date: '2023-03-17T11:47:04.792Z' + note: note 07/03 14.31 + lines: + - amount: 4 + links: + - type: Invoice + id: INV-31 + amount: -4 + currencyRate: 1 + allocatedOnDate: '2023-02-11T11:47:04.792Z' + reference: ref + Sage Business Cloud Accounting: + value: + customerRef: + id: 30444c5bd4964fd787c7f8e2e5301ce1 + companyName: Stanley test customer + accountRef: + id: 9a25937b267a11e797950a57719b2edb + name: Current + totalAmount: 0.17 + currency: GBP + currencyRate: 1 + date: '2023-03-20T11:47:04.792Z' + note: Need to send products asap. + lines: + - amount: 0.17 + links: + - type: Invoice + id: bb85db9226d7450fb99eb83e7fb37505 + amount: -0.17 + currencyRate: 1 + allocatedOnDate: '2023-02-11T11:47:04.792Z' + reference: normal payment 20/03 17.05 + Sage Intacct: + value: + customerRef: + id: '19' + accountRef: + id: '81' + date: '2022-03-12T00:00:00' + totalAmount: 0 + lines: + - amount: 0 + links: + - id: '246' + type: Invoice + amount: -1.1 + - id: '280' + type: CreditNote + amount: 1.1 + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/AccountingCreatePaymentResponse' + examples: + Sage Intacct: + value: + data: + customerRef: + id: '19' + accountRef: + id: '81' + totalAmount: 0 + date: '2022-03-12T00:00:00' + lines: + - amount: 0 + links: + - type: Invoice + id: '246' + amount: -1.1 + - type: CreditNote + id: '280' + amount: 1.1 + dataType: payments + companyId: ffa6368e-fde4-4165-9a0a-4bda1a6f916e + pushOperationKey: 673f5d97-1c53-41ef-b9c8-cc9a8415d17c + dataConnectionKey: bbecdbf3-913a-43ae-9c91-e830b3686657 + requestedOnUtc: '0001-01-01T00:00:00' + status: Pending + statusCode: 202 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + description: |- + The *Create payment* endpoint creates a new [payment](https://docs.codat.io/lending-api#/schemas/Payment) for a given company's connection. + + [Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. + + **Integration-specific behavior** + + Required data may vary by integration. To see what data to post, first call [Get create payment model](https://docs.codat.io/lending-api#/operations/get-create-payments-model). + operationId: create-payment + x-speakeasy-group: loan-writeback.payments + '/companies/{companyId}/push/{pushOperationKey}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/pushOperationKey' + get: + summary: Get create operation + tags: + - Loan writeback + operationId: get-create-operation + x-speakeasy-group: loan-writeback.create-operations + description: Retrieve create operation. + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/PushOperation' + examples: {} + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/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: + - Loan writeback + operationId: list-create-operations + x-speakeasy-group: loan-writeback.create-operations + description: List create operations. + 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}/bankStatements/upload/configuration': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + get: + tags: + - Bank statements + summary: Get upload configuration + description: "Use the *Get upload configuration* endpoint to view the existing bank statement upload configuration for the specified data connection.\n\nWith this configuration, you set the source of the data you plan to upload, the ID of the account in third-party banking platform, and a provider ID, if required. This lets us determine the expected format of the data and any source-specific requirements.\n\nWhen you use the [*Upload data*](https://docs.codat.io/lending-api#/operations/upload-bank-statement-data) endpoint next, you must upload the data for the account you configured. " + operationId: get-bank-statement-upload-configuration + x-speakeasy-name-override: get-upload-configuration + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankStatementUploadConfiguration' + examples: + Codat: + $ref: '#/components/examples/CodatBankStatementUploadConfiguration' + '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' + post: + tags: + - Bank statements + summary: Set upload configuration + description: "Use the *Set upload configuration* endpoint to create bank statement upload configuration for the specified data connection. \n\nWith this configuration, you set the source of the data you plan to upload, the ID of the account in third-party banking platform, and a provider ID, if required. This lets us determine the expected format of the data and any source-specific requirements.\n\nEach data connection can only have one configuration for each company and external account ID combination. You will receive a Bad Request response if you try to set it again. " + operationId: set-bank-statement-upload-configuration + x-speakeasy-name-override: set-upload-configuration + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BankStatementUploadConfiguration' + examples: + Codat: + $ref: '#/components/examples/CodatBankStatementUploadConfiguration' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/BankStatementUploadConfiguration' + examples: + Codat: + $ref: '#/components/examples/CodatBankStatementUploadConfiguration' + '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}/bankStatements/upload/startSession': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + post: + tags: + - Bank statements + summary: Start upload session + description: "Use the *Start upload session* endpoint to initiate a bank statement upload session for a given company.\n\nA session is a one-time process that enables you to upload bank statements to Codat. It will time out after 90 minutes if no data is uploaded. \n\nYou can only have one active session per data type at a time. You can complete or cancel a session using the [*End upload session*](https://docs.codat.io/lending-api#/operations/end-bank-statement-upload-session) endpoint." + operationId: start-bank-statement-upload-session + x-speakeasy-name-override: start-upload-session + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StartUploadSessionRequest' + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/PullOperation' + '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}/bankStatements/upload/dataset/{datasetId}/upload': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/datasetId' + - $ref: '#/components/parameters/path' + post: + tags: + - Bank statements + summary: Upload data + description: "During an active session, use the **Upload data* endpoint to uploads a page of bank accounts or bank transactions data to the session.\n\nMake sure you created configuration for the account using the [*Set upload configuration*](https://docs.codat.io/lending-api#/operations/set-bank-statement-upload-configuration) endpoint before attempting an upload. " + operationId: upload-bank-statement-data + requestBody: + required: true + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/BankingAccount' + - $ref: '#/components/schemas/BankingTransactions' + - $ref: '#/components/schemas/ThirdPartySchema' + responses: + '200': + description: Success + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/connections/{connectionId}/bankStatements/upload/dataset/{datasetId}/endSession': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/datasetId' + post: + tags: + - Bank statements + summary: End upload session + description: |- + Use the *End upload session* endpoint to finalize a bank statement upload session. Include a `status` in the request body to indicate if you want to cancel the processing of the dataset or trigger the ingestion and enrichment of the data. + + A session is a one-time process that enables you to upload bank statements to Codat. It will time out after 90 minutes if no data is uploaded. + operationId: end-bank-statement-upload-session + x-speakeasy-name-override: end-upload-session + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EndUploadSessionRequest' + responses: + '200': + description: Success + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/{reportType}': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportType' + post: + tags: + - Manage reports + summary: Generate report + description: |- + Use the *Generate report* endpoint to initiate the generation of a report specified by the `reportType` parameter. + + This action triggers the system to refresh and pull the necessary data from the company's data sources to ensure the report contains the most up-to-date information. + operationId: generate-report + x-speakeasy-name-override: generate-report + responses: + '202': + description: Accepted (pending) + content: + application/json: + schema: + $ref: '#/components/schemas/ReportOperation' + examples: + Report: + $ref: '#/components/examples/SingleReportExample' + '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' + '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}/reports/{reportType}/{reportId}/status': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportType' + - $ref: '#/components/parameters/reportId' + - $ref: '#/components/parameters/maxAge' + get: + tags: + - Manage reports + summary: Get report status + description: |+ + Use the *Get report status* endpoint to return the metadata about report generation, such as its current status, date of request, and date of generation. + + You can either provide the ID of a report or use `latest` as the ID value to get the most recent generated *reportName* report for the company. + + operationId: get-report-status + x-speakeasy-name-override: get-report-status + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ReportOperation' + examples: + Report: + $ref: '#/components/examples/SingleReportExample' + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/categorizedBankStatement/{reportId}/transactions': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportId' + - $ref: '#/components/parameters/maxAge' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + get: + tags: + - Bank statements + summary: Get categorized bank statement transactions + description: |- + The *Get categorized bank statement transactions* endpoint returns fully categorized bank transactions for a company. Transaction data is obtained from the company's connected bank accounts. + + Before using it, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `categorizedBankStatement`. + operationId: get-categorized-bank-statement-transactions + x-speakeasy-name-override: get-categorized-bank-statement-transactions + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CategorizedBankStatementTransactions' + example: + pageNumber: 1 + pageSize: 100 + totalResults: 2194 + _links: + self: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions + current: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=1&pageSize=100 + next: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=2&pageSize=100 + results: + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: ab5e07a0-5578-4d91-8421-2dc72713b74f + date: '2022-11-08T00:00:00' + description: Payment m86SDGpQr3 + amount: -6905.44 + currency: GBP + transactionCategory: + confidence: 52.53 + levels: + - Expense + - Operating + confidences: + - 56 + - 52.53 + platformName: Shopify + counterpartyNames: + - Shopify + modifiedDate: '2022-11-08T12:00:00' + isRecurring: true + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: 9846bbed-46d3-472c-a848-1ce8ebea7213 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 4332.84 + currency: GBP + transactionCategory: + confidence: 88 + levels: + - Expense + confidences: + - 88 + platformName: Amazon + counterpartyNames: + - Amazon + - Amazon Marketplace + modifiedDate: '2022-11-08T12:00:00' + isRecurring: false + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 94b213fb-d742-435e-90f1-bfe723a076d5 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 4034.3 + currency: GBP + transactionCategory: + confidence: 61.08 + levels: + - Income + - Revenue + confidences: + - 65 + - 61.08 + platformName: Shopify + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + isRecurring: null + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: cfceb7ff-eaa2-45b6-aca7-fa0e0b439161 + date: '2022-11-08T00:00:00' + description: Payment to supplier 78792d13-90a0-4ea2-8e07-81c3c893997e + amount: -313.76 + currency: GBP + transactionCategory: + confidence: 40.98 + levels: + - Expense + - CostOfSales + confidences: + - 40.98 + - 99.9 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + isRecurring: true + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: ba814f14-0fe3-41d0-9308-57f40642ac75 + date: '2022-11-08T00:00:00' + description: Payment to supplier 46d2e1fb-b4e9-469c-814a-21ff8105a26e + amount: -614.4 + currency: GBP + transactionCategory: + confidence: 55.84 + levels: + - Income + - Revenue + confidences: + - 55.84 + - 75.5 + platformName: Zettle + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + isRecurring: false + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: e67cc30e-fd5c-4eea-8365-ec40dfdd3ef6 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 5199.62 + currency: GBP + transactionCategory: + confidence: 57.85 + levels: + - Expense + confidences: + - 57.85 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + isRecurring: null + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: e0f08a0b-3575-4dde-98c4-3c854028d2d2 + date: '2022-11-08T00:00:00' + description: Payment to supplier 18ac18dc-945b-4083-9013-e8a100b999fa + amount: -21420.94 + currency: GBP + transactionCategory: + confidence: 70.58 + levels: + - Expense + - Operating + confidences: + - 70.58 + - 100 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + isRecurring: true + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 4b70d379-8284-4f44-bb37-c7935df950cc + date: '2022-11-08T00:00:00' + description: Payment to supplier 630a3f16-5f01-4986-ae6b-82333ec49449 + amount: -30924.22 + currency: GBP + transactionCategory: + confidence: 48.26 + levels: + - Income + confidences: + - 48.26 + platformName: DoorDash + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + isRecurring: false + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 76b73373-9345-472e-8edf-5be849d797fe + date: '2022-11-08T00:00:00' + description: Payment to supplier bQATU4eSb9 + amount: -568.78 + currency: GBP + transactionCategory: + confidence: 65.21 + levels: + - Income + - Revenue + confidences: + - 65.21 + - 100 + platformName: Uber + counterpartyNames: + - Uber + modifiedDate: '2022-11-08T12:00:00' + isRecurring: true + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: ee92fd6f-e0f7-4391-85fd-4b50921b973f + date: '2022-11-08T00:00:00' + description: Payment to supplier 9c37eb21-579a-4886-8296-3a853076b7bd + amount: -13050.79 + currency: GBP + transactionCategory: + confidence: 92.33 + levels: + - Income + - Revenue + confidences: + - 92.33 + - 92.33 + platformName: DoorDash + counterpartyNames: + - DoorDash + modifiedDate: '2022-11-08T12:00:00' + isRecurring: false + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/categorizedBankStatement/{reportId}/accounts': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportId' + - $ref: '#/components/parameters/maxAge' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + get: + tags: + - Bank statements + summary: List categorized bank statement accounts + description: "The *Get categorized bank statement accounts* endpoint returns a list of bank accounts associated with categorized transactions for a company. \n\nBefore using it, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `categorizedBankStatement`." + operationId: list-categorized-bank-statement-accounts + x-speakeasy-name-override: list-categorized-bank-statement-accounts + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/CategorizedBankStatementAccounts' + example: + pageNumber: 1 + pageSize: 10 + totalResults: 15 + _links: + self: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions + current: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=1&pageSize=10 + next: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=2&pageSize=10 + results: + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Savings Account + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Banking - Business Credit Card + accountType: Credit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Undeposited Funds + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Current Account + accountType: Debit + currency: GBP + currentBalance: 0 + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/categorizedBankStatement/{reportId}/excel': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportId' + - $ref: '#/components/parameters/maxAge' + get: + tags: + - Bank statements + summary: Download categorized bank statement Excel + description: "Use the *Download categorized bank statement Excel* endpoint to download the categorized bank statement Excel file. \n\nBefore using it, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `categorizedBankStatement`." + operationId: download-categorized-bank-statement-excel + x-speakeasy-name-override: download-categorized-bank-statement-excel + responses: + '200': + description: OK + content: + application/octet-stream: + schema: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/creditModel/{reportId}/excel': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportId' + - $ref: '#/components/parameters/maxAge' + get: + tags: + - Financial summary + summary: Download credit model Excel + description: "> **Available as beta release**\n>\n> This endpoint is part of a beta release. Please contact your account manager if you want to enable it.\n\nUse the *Download Credit Model Excel* endpoint to download the credit model Excel file. \n\nBefore using it, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `creditModel`." + operationId: download-credit-model-excel + x-speakeasy-name-override: download-credit-model-excel + responses: + '200': + description: OK + content: + application/octet-stream: + schema: {} + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports': parameters: - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/pageSize' + - $ref: '#/components/parameters/query' + - $ref: '#/components/parameters/orderBy' + get: + tags: + - Manage reports + summary: List reports + description: 'Use the *List reports* endpoint to return details (such as generation''s current status, date of request, and date of generation) about all reports generated for a company. The query parameter can be used to filter the results.' + operationId: list-reports + x-speakeasy-name-override: list-reports + responses: + '200': + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/ReportOperation/definitions/reports' + example: + pageNumber: 1 + pageSize: 4 + totalResults: 15 + _links: + self: + href: /companies/0f591937-4ea9-48c4-847a-fe65fb24bb41/reports + current: + href: /companies/0f591937-4ea9-48c4-847a-fe65fb24bb41/reports?page=1&pageSize=4 + next: + href: /companies/0f591937-4ea9-48c4-847a-fe65fb24bb41/reports?page=2&pageSize=4 + results: + - id: c0d52c82-777f-4309-81a0-d935aea0562b + status: InProgress + type: categorizedBankStatement + requested: '2024-10-15T07:00:00Z' + updated: '2024-10-15T15:31:45Z' + - id: 79ef0451-edbd-4108-82ff-0b991444f1ec + status: Complete + type: categorizedBankStatement + requested: '2024-09-10T05:50:00Z' + updated: '2024-09-11T14:37:12Z' + - id: ae125b45-ed37-4bb4-bb4a-d55383fd56b2 + status: Complete + type: categorizedBankStatement + requested: '2024-09-06T07:47:10Z' + updated: '2024-09-20T14:42:15Z' + - id: ebfaf90c-31fe-407f-a016-bc2b3e60894a + status: Error + type: categorizedBankStatement + requested: '2024-07-15T04:45:14Z' + updated: '2024-07-15T17:41:45Z' + errorMessage: Failed to generate the report because.... + '400': + $ref: '#/components/responses/BadRequest' + '401': + $ref: '#/components/responses/Unauthorized' + '402': + $ref: '#/components/responses/Payment-Required' + '403': + $ref: '#/components/responses/Forbidden' + '404': + $ref: '#/components/responses/Not-Found' + '429': + $ref: '#/components/responses/Too-Many-Requests' + '500': + $ref: '#/components/responses/Internal-Server-Error' + '503': + $ref: '#/components/responses/Service-Unavailable' + '/companies/{companyId}/reports/creditModel/{reportId}/financialSummary': + parameters: + - $ref: '#/components/parameters/companyId' + - $ref: '#/components/parameters/reportId' + get: + tags: + - Financial summary + summary: Get financial summary insights + description: |- + > **Available as beta release** + > + > This endpoint is part of a beta release. Please contact your account manager if you want to enable it. + + Financial summary insights provide high-level indicators about the accuracy and completeness of a business’s financial data. These insights include: + - Closed Books Indicator – An estimate of the most recent accounting period officially closed by a business + - Accounting Score – An evaluation of the quality and completeness of a business’s bookkeeping + + Before accessing this endpoint, you must call the [Generate report](https://docs.codat.io/lending-api#/operations/generate-report) endpoint of type `creditModel`. + + > Please note that missing elements might be disabled for the account. Please contact account manager for more details. + operationId: get-financial-summary + x-speakeasy-name-override: get-financial-summary + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/FinancialSummary' + example: + booksClosedDate: + date: '2025-05-31T00:00:00Z' + reason: + - One or more accounts show a deviation from expected movements for March 2025 + - One of the marketing accounts haven't been booked for February 2025 + - One of the inventory accounts haven't been booked for March 2025 + accountingScore: + score: 90 + reason: + - Balance sheet is unbalanced. + - Negative Tangible Assets on Balance Sheet + - Negative Accounts Receivable on Balance Sheet + '204': + description: No content + '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' +webhooks: + Account categories updated: + post: + requestBody: + description: Triggered when a company's accounts are categorized. + content: + application/json: + schema: + $ref: '#/components/schemas/AccountCategoriesUpdatedWebhook' + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + client.rateLimit.reached: + post: + description: Called when your client’s request count to Codat's API surpasses the allocated quota. + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClientRateLimitWebhook' + examples: + Reached: + value: + id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b + eventType: client.rateLimit.reached + generatedDate: '2024-09-01T00:00:00Z' + payload: + dailyQuota: 12000 + quotaRemaining: 0 + expiryDate: '2024-09-01T12:14:14Z' + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + client.rateLimit.reset: + post: + description: 'Called when your client''s rate limit quota is reset, allowing additional requests to Codat''s API.' + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ClientRateLimitWebhook' + examples: + Reset: + value: + id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b + eventType: client.rateLimit.reset + generatedDate: '2024-09-01T00:00:00Z' + payload: + dailyQuota: 12000 + quotaRemaining: 11993 + expiryDate: '2024-09-01T23:59:99Z' + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + reports.categorizedBankStatement.generate.successful: + post: + description: Called when a categorized bank statement is successfully generated for a company. + requestBody: + content: + application/json: + schema: + $ref: '#/webhooks/reports.creditModel.generate.successful/post/requestBody/content/application~1json/schema' + examples: + Successful: + value: + id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 + eventType: reports.categorizedBankStatement.generate.successful + generatedDate: '2023-05-03T10:00:23.000Z' + payload: + id: bb42ce7e-720a-4ac5-b640-f24f53ff47c8 + referenceCompany: + id: 0498e921-9b53-4396-a412-4f2f5983b0a2 + name: Bank of Dave + description: internal_id_mxO7rLfo + links: + portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary' + tags: + customerRegion: us + uid: 335a086e-8563-4b03-94e3-39544225ecb6 + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + reports.categorizedBankStatement.generate.unsuccessful: + post: + description: Called when a categorized bank statement has failed to be generated for a company. + requestBody: + content: + application/json: + schema: + $ref: '#/webhooks/reports.creditModel.generate.successful/post/requestBody/content/application~1json/schema' + examples: + Unsuccessful: + value: + id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 + eventType: reports.categorizedBankStatement.generate.unsuccessful + generatedDate: '2023-05-03T10:00:23.000Z' + payload: + id: bb42ce7e-720a-4ac5-b640-f24f53ff47c8 + referenceCompany: + id: 0498e921-9b53-4396-a412-4f2f5983b0a2 + name: Bank of Dave + description: internal_id_mxO7rLfo + links: + portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary' + tags: + customerRegion: us + uid: 335a086e-8563-4b03-94e3-39544225ecb6 + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + reports.creditModel.generate.successful: + post: + description: Called when a credit model report is successfully generated. + requestBody: + content: + application/json: + schema: + title: Report generation webhook + type: object + properties: + id: + type: string + format: uuid + example: ba29118f-5406-4e59-b05c-ba307ca38d01 + description: Unique identifier of the event. + eventType: + type: string + description: The type of event. + examples: + - reports.categorizedBankStatement.generate.successful + - reports.creditModel.generate.successful + generatedDate: + $ref: '#/components/schemas/DateTime' + description: The date time in UTC the event was generated in Codat. + payload: + $ref: '#/webhooks/reports.creditModel.generate.successful/post/requestBody/content/application~1json/schema/definitions/ReportGenerationPayload' + definitions: + ReportGenerationPayload: + title: Report generation payload + type: object + properties: + id: + type: string + format: uuid + example: a78e2625-7190-4d94-ae3b-071320451026 + description: Unique identifier of the report. + referenceCompany: + $ref: '#/components/schemas/Company/definitions/companyReference' + examples: + Successful: + value: + id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 + eventType: reports.creditModel.generate.successful + generatedDate: '2023-05-03T10:00:23.000Z' + payload: + id: bb42ce7e-720a-4ac5-b640-f24f53ff47c8 + referenceCompany: + id: 0498e921-9b53-4396-a412-4f2f5983b0a2 + name: Bank of Dave + description: Looking for a loan. + links: + portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary' + tags: + customerRegion: us + uid: 335a086e-8563-4b03-94e3-39544225ecb6 + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. + reports.creditModel.generate.unsuccessful: post: + description: Called when a credit model report has failed to be generated for a company. + requestBody: + content: + application/json: + schema: + $ref: '#/webhooks/reports.creditModel.generate.successful/post/requestBody/content/application~1json/schema' + examples: + Unsuccessful: + value: + id: bae71d36-ff47-420a-b4a6-f8c9ddf41140 + eventType: reports.creditModel.generate.unsuccessful + generatedDate: '2023-05-03T10:00:23.000Z' + payload: + id: bb42ce7e-720a-4ac5-b640-f24f53ff47c8 + referenceCompany: + id: 0498e921-9b53-4396-a412-4f2f5983b0a2 + name: Bank of Dave + description: Looking for a loan. + links: + portal: 'https://app.codat.io/companies/0498e921-9b53-4396-a412-4f2f5983b0a2/summary' + tags: + customerRegion: us + uid: 335a086e-8563-4b03-94e3-39544225ecb6 + responses: + '200': + description: Return a 200 status to indicate that the webhook was received successfully. +components: + schemas: + AccountCategoriesUpdatedWebhook: + title: Account categories updated webhook + description: Webhook request body for the "Account categories updated" event. + x-internal: true + type: object + properties: + ClientId: + title: Client ID + type: string + format: uuid + description: Unique identifier for your client in Codat. + ClientName: + type: string + description: Name of your client in Codat. + CompanyId: + $ref: '#/components/parameters/companyId/schema' + DataConnectionId: + $ref: '#/components/parameters/connectionId/schema' + RuleId: + type: string + format: uuid + description: Unique identifier for the rule. + deprecated: true + RuleType: + type: string + x-stoplight: + id: 34d52a089f08a + description: The type of rule. + AlertId: + type: string + format: uuid + description: Unique identifier of the webhook event. + Message: + type: string + description: A human-readable message about the webhook. + Data: + $ref: '#/components/schemas/AccountCategoriesUpdatedWebhook/definitions/AccountCategoriesUpdatedWebhookData' + definitions: + AccountCategoriesUpdatedWebhookData: + type: object + title: Account categories updated webhook data + properties: + modifiedDate: + $ref: '#/components/schemas/SourceAccountV2/properties/feedStartDate' + description: The date on which the company's account categories were last modified in Codat. + examples: + - ClientId: bae71d36-ff47-420a-b4a6-f8c9ddf41140 + ClientName: Bank of Dave + CompanyId: 8a210b68-6988-11ed-a1eb-0242ac120002 + DataConnectionId: 2e9d2c44-f675-40ba-8049-353bfcb5e171 + RuleId: 70af3071-65d9-4ec3-b3cb-5283e8d55dac + RuleType: Account Categories Updated + AlertId: a9367074-b5c3-42c4-9be4-be129f43577e + Message: Account categories updated for company f1c35bdc-1546-41b9-baf4-3f31135af968. + Data: + modifiedDate: '2019-08-24T14:15:22Z' + AccountingAccount: + title: 'Accounting: Account' + description: "\uFEFF\x3E\x20\x2A\x2A\x4C\x61\x6E\x67\x75\x61\x67\x65\x20\x74\x69\x70\x3A\x2A\x2A\x20\x41\x63\x63\x6F\x75\x6E\x74\x73\x20\x61\x72\x65\x20\x61\x6C\x73\x6F\x20\x72\x65\x66\x65\x72\x72\x65\x64\x20\x74\x6F\x20\x61\x73\x20\x2A\x2A\x63\x68\x61\x72\x74\x20\x6F\x66\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2A\x2A\x2C\x20\x2A\x2A\x6E\x6F\x6D\x69\x6E\x61\x6C\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2A\x2A\x2C\x20\x61\x6E\x64\x20\x2A\x2A\x67\x65\x6E\x65\x72\x61\x6C\x20\x6C\x65\x64\x67\x65\x72\x2A\x2A\x2E\n\n\x23\x23\x20\x4F\x76\x65\x72\x76\x69\x65\x77\n\n\x41\x63\x63\x6F\x75\x6E\x74\x73\x20\x61\x72\x65\x20\x74\x68\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x65\x73\x20\x61\x20\x62\x75\x73\x69\x6E\x65\x73\x73\x20\x75\x73\x65\x73\x20\x74\x6F\x20\x72\x65\x63\x6F\x72\x64\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x74\x72\x61\x6E\x73\x61\x63\x74\x69\x6F\x6E\x73\x2E\x20\x46\x72\x6F\x6D\x20\x74\x68\x65\x20\x41\x63\x63\x6F\x75\x6E\x74\x73\x20\x65\x6E\x64\x70\x6F\x69\x6E\x74\x73\x2C\x20\x79\x6F\x75\x20\x63\x61\x6E\x20\x72\x65\x74\x72\x69\x65\x76\x65\x20\x61\x20\x6C\x69\x73\x74\x20\x6F\x66\x20\x61\x6C\x6C\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x66\x6F\x72\x20\x61\x20\x73\x70\x65\x63\x69\x66\x69\x65\x64\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\n\n\x54\x68\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x65\x73\x20\x66\x6F\x72\x20\x61\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x69\x6E\x63\x6C\x75\x64\x65\x3A\n\x2A\x20\x41\x73\x73\x65\x74\n\x2A\x20\x45\x78\x70\x65\x6E\x73\x65\n\x2A\x20\x49\x6E\x63\x6F\x6D\x65\n\x2A\x20\x4C\x69\x61\x62\x69\x6C\x69\x74\x79\n\x2A\x20\x45\x71\x75\x69\x74\x79\x2E\n\n\x54\x68\x65\x20\x73\x61\x6D\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x6D\x61\x79\x20\x68\x61\x76\x65\x20\x61\x20\x64\x69\x66\x66\x65\x72\x65\x6E\x74\x20\x63\x61\x74\x65\x67\x6F\x72\x79\x20\x62\x61\x73\x65\x64\x20\x6F\x6E\x20\x74\x68\x65\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x20\x69\x74\x20\x69\x73\x20\x75\x73\x65\x64\x20\x69\x6E\x2E\x20\x46\x6F\x72\x20\x65\x78\x61\x6D\x70\x6C\x65\x2C\x20\x61\x20\x63\x75\x72\x72\x65\x6E\x74\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x28\x6B\x6E\x6F\x77\x6E\x20\x61\x73\x20\x63\x68\x65\x63\x6B\x69\x6E\x67\x20\x69\x6E\x20\x74\x68\x65\x20\x55\x53\x29\x20\x73\x68\x6F\x75\x6C\x64\x20\x62\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x7A\x65\x64\x20\x61\x73\x20\x60\x41\x73\x73\x65\x74\x2E\x43\x75\x72\x72\x65\x6E\x74\x60\x20\x66\x6F\x72\x20\x58\x65\x72\x6F\x2C\x20\x61\x6E\x64\x20\x60\x41\x73\x73\x65\x74\x2E\x42\x61\x6E\x6B\x2E\x43\x68\x65\x63\x6B\x69\x6E\x67\x60\x20\x66\x6F\x72\x20\x51\x75\x69\x63\x6B\x42\x6F\x6F\x6B\x73\x20\x4F\x6E\x6C\x69\x6E\x65\x2E\n\n\x41\x74\x20\x74\x68\x65\x20\x73\x61\x6D\x65\x20\x74\x69\x6D\x65\x2C\x20\x65\x61\x63\x68\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x20\x6D\x61\x79\x20\x68\x61\x76\x65\x20\x69\x74\x73\x20\x6F\x77\x6E\x20\x72\x65\x71\x75\x69\x72\x65\x6D\x65\x6E\x74\x73\x20\x74\x6F\x20\x74\x68\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x65\x73\x2E\x20\x46\x6F\x72\x20\x65\x78\x61\x6D\x70\x6C\x65\x2C\x20\x61\x20\x50\x61\x79\x70\x61\x6C\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x69\x6E\x20\x58\x65\x72\x6F\x20\x69\x73\x20\x6F\x66\x20\x74\x68\x65\x20\x60\x41\x73\x73\x65\x74\x2E\x42\x61\x6E\x6B\x60\x20\x63\x61\x74\x65\x67\x6F\x72\x79\x20\x61\x6E\x64\x20\x74\x68\x65\x72\x65\x66\x6F\x72\x65\x20\x72\x65\x71\x75\x69\x72\x65\x73\x20\x61\x64\x64\x69\x74\x69\x6F\x6E\x61\x6C\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x20\x74\x6F\x20\x62\x65\x20\x70\x72\x6F\x76\x69\x64\x65\x64\x2E\n\n\x54\x6F\x20\x64\x65\x74\x65\x72\x6D\x69\x6E\x65\x20\x74\x68\x65\x20\x6C\x69\x73\x74\x20\x6F\x66\x20\x61\x6C\x6C\x6F\x77\x65\x64\x20\x63\x61\x74\x65\x67\x6F\x72\x69\x65\x73\x20\x66\x6F\x72\x20\x61\x20\x73\x70\x65\x63\x69\x66\x69\x63\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x2C\x20\x79\x6F\x75\x20\x63\x61\x6E\x3A\n\x2D\x20\x46\x6F\x6C\x6C\x6F\x77\x20\x6F\x75\x72\x20\x5B\x43\x72\x65\x61\x74\x65\x2C\x20\x75\x70\x64\x61\x74\x65\x2C\x20\x64\x65\x6C\x65\x74\x65\x20\x64\x61\x74\x61\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x75\x73\x69\x6E\x67\x2D\x74\x68\x65\x2D\x61\x70\x69\x2F\x70\x75\x73\x68\x29\x20\x67\x75\x69\x64\x65\x20\x61\x6E\x64\x20\x75\x73\x65\x20\x74\x68\x65\x20\x5B\x47\x65\x74\x20\x63\x72\x65\x61\x74\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x6D\x6F\x64\x65\x6C\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x6F\x70\x65\x72\x61\x74\x69\x6F\x6E\x73\x2F\x67\x65\x74\x2D\x63\x72\x65\x61\x74\x65\x2D\x63\x68\x61\x72\x74\x4F\x66\x41\x63\x63\x6F\x75\x6E\x74\x73\x2D\x6D\x6F\x64\x65\x6C\x29\x2E\n\x2D\x20\x52\x65\x66\x65\x72\x20\x74\x6F\x20\x74\x68\x65\x20\x69\x6E\x74\x65\x67\x72\x61\x74\x69\x6F\x6E\x27\x73\x20\x6F\x77\x6E\x20\x64\x6F\x63\x75\x6D\x65\x6E\x74\x61\x74\x69\x6F\x6E\x2E\n\n\x3E\x20\x2A\x2A\x41\x63\x63\x6F\x75\x6E\x74\x73\x20\x77\x69\x74\x68\x20\x6E\x6F\x20\x63\x61\x74\x65\x67\x6F\x72\x79\x2A\x2A\n\x3E\n\x3E\x20\x49\x66\x20\x61\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x69\x73\x20\x70\x75\x6C\x6C\x65\x64\x20\x66\x72\x6F\x6D\x20\x74\x68\x65\x20\x63\x68\x61\x72\x74\x20\x6F\x66\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x61\x6E\x64\x20\x69\x74\x73\x20\x6E\x6F\x6D\x69\x6E\x61\x6C\x20\x63\x6F\x64\x65\x20\x64\x6F\x65\x73\x20\x6E\x6F\x74\x20\x6C\x69\x65\x20\x77\x69\x74\x68\x69\x6E\x20\x74\x68\x65\x20\x63\x61\x74\x65\x67\x6F\x72\x79\x20\x6C\x61\x79\x6F\x75\x74\x20\x66\x6F\x72\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x27\x73\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x2C\x20\x74\x68\x65\x6E\x20\x74\x68\x65\x20\x2A\x2A\x74\x79\x70\x65\x2A\x2A\x20\x69\x73\x20\x60\x55\x6E\x6B\x6E\x6F\x77\x6E\x60\x2E\x20\x54\x68\x65\x20\x2A\x2A\x66\x75\x6C\x6C\x79\x51\x75\x61\x6C\x69\x66\x69\x65\x64\x43\x61\x74\x65\x67\x6F\x72\x79\x2A\x2A\x20\x61\x6E\x64\x20\x2A\x2A\x66\x75\x6C\x6C\x79\x51\x75\x61\x6C\x69\x66\x69\x65\x64\x4E\x61\x6D\x65\x2A\x2A\x20\x66\x69\x65\x6C\x64\x73\x20\x72\x65\x74\x75\x72\x6E\x20\x60\x6E\x75\x6C\x6C\x60\x2E\n\x3E\n\x3E\x20\x54\x68\x69\x73\x20\x61\x70\x70\x72\x6F\x61\x63\x68\x20\x67\x69\x76\x65\x73\x20\x61\x20\x74\x72\x75\x65\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x61\x74\x69\x6F\x6E\x20\x6F\x66\x20\x74\x68\x65\x20\x63\x6F\x6D\x70\x61\x6E\x79\x27\x73\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x77\x68\x69\x6C\x73\x74\x20\x70\x72\x65\x76\x65\x6E\x74\x69\x6E\x67\x20\x64\x69\x73\x74\x6F\x72\x74\x69\x6E\x67\x20\x66\x69\x6E\x61\x6E\x63\x69\x61\x6C\x73\x20\x73\x75\x63\x68\x20\x61\x73\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x27\x73\x20\x70\x72\x6F\x66\x69\x74\x20\x61\x6E\x64\x20\x6C\x6F\x73\x73\x20\x61\x6E\x64\x20\x62\x61\x6C\x61\x6E\x63\x65\x20\x73\x68\x65\x65\x74\x20\x72\x65\x70\x6F\x72\x74\x73\x2E" + allOf: + - properties: + id: + type: string + description: 'Identifier for the account, unique for the company.' + example: 1b6266d1-1e44-46c5-8eb5-a8f98e03124e + - $ref: '#/components/schemas/AccountingAccount/definitions/accountPrototype' + - properties: + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + accountPrototype: + title: Account prototype + type: object + properties: + nominalCode: + type: string + nullable: true + description: Reference given to each nominal account for a business. It ensures money is allocated to the correct account. This code isn't a unique identifier in the Codat system. + example: '610' + name: + type: string + nullable: true + description: Name of the account. + example: Accounts Receivable + description: + type: string + nullable: true + description: Description for the account. + example: Invoices the business has issued but has not yet collected payment on. + fullyQualifiedCategory: + type: string + nullable: true + description: "Full category of the account. \r\n\r\nFor example, `Liability.Current` or `Income.Revenue`. To determine a list of possible categories for each integration, see our examples, follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide, or refer to the integration's own documentation." + example: Asset.Current + fullyQualifiedName: + type: string + nullable: true + description: |- + Full name of the account, for example: + - `Cash On Hand` + - `Rents Held In Trust` + - `Fixed Asset` + examples: + - Cash On Hand + - Fixed Asset + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + currentBalance: + type: number + format: decimal + nullable: true + description: Current balance in the account. + example: 0 + type: + $ref: '#/components/schemas/AccountingAccount/definitions/accountType' + status: + $ref: '#/components/schemas/AccountingAccount/definitions/accountStatus' + isBankAccount: + type: boolean + description: Confirms whether the account is a bank account or not. + validDatatypeLinks: + type: array + nullable: true + description: 'The validDatatypeLinks can be used to determine whether an account can be correctly mapped to another object; for example, accounts with a `type` of `income` might only support being used on an Invoice and Direct Income. For more information, see [Valid Data Type Links](/lending-api#/schemas/ValidDataTypeLinks).' + items: + title: Valid data type links + description: "When querying Codat's data model, some data types return `validDatatypeLinks` metadata in the JSON response. This indicates where that object can be used as a reference—a _valid link_—when creating or updating other data.\n\nFor example, `validDatatypeLinks` might indicate the following references:\n\n- Which tax rates are valid to use on the line item of a bill.\n- Which items can be used when creating an invoice. \n\nYou can use `validDatatypeLinks` to present your SMB customers with only valid choices when selecting objects from a list, for example.\n\n## `validDatatypeLinks` example\n\nThe following example uses the `Accounting.Accounts` data type. It shows that, on the linked integration, this account is valid as the account on a payment or bill payment; and as the account referenced on the line item of a direct income or direct cost. Because there is no valid link to Invoices or Bills, using this account on those data types will result in an error.\n\n```json validDatatypeLinks for an account\n{\n \"id\": \"bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4\",\n \"nominalCode\": \"090\",\n \"name\": \"Business Bank Account\",\n #...\n \"validDatatypeLinks\": [\n {\n \"property\": \"Id\",\n \"links\": [\n \"Payment.AccountRef.Id\",\n \"BillPayment.AccountRef.Id\",\n \"DirectIncome.LineItems.AccountRef.Id\",\n \"DirectCost.LineItems.AccountRef.Id\"\n ]\n }\n ]\n }\n```\n\n\n\n## Support for `validDatatypeLinks`\n\nCodat currently supports `validDatatypeLinks` for some data types on our Xero, QuickBooks Online, QuickBooks Desktop, Exact (NL), and Sage Business Cloud integrations. \n\nIf you'd like us to extend support to more data types or integrations, suggest or vote for this on our Product Roadmap." + type: object + properties: + property: + type: string + nullable: true + description: The property from the account that can be linked. + links: + type: array + nullable: true + description: Supported `dataTypes` that the record can be linked to. + items: + type: string + supplementalData: + $ref: '#/components/schemas/SupplementalData' + accountRef: + title: Account reference + type: object + description: 'Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account.' + properties: + id: + type: string + description: '''id'' from the Accounts data type.' + name: + type: string + description: '''name'' from the Accounts data type.' + accountType: + title: Account type + enum: + - Unknown + - Asset + - Expense + - Income + - Liability + - Equity + type: string + description: Type of account + example: Asset + accountStatus: + title: Account status + enum: + - Unknown + - Active + - Archived + - Pending + type: string + description: Status of the account + example: Active + type: object + AccountingAccounts: + title: 'Accounting: Accounts' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingAccount' + - $ref: '#/components/schemas/PagingInfo' + AccountingAccountTransaction: + title: 'Accounting: Account transaction' + description: |- + > **Language tip:** In Codat, account transactions represent all transactions posted to a bank account within an accounting software. For bank transactions posted within a banking platform, refer to [Banking transactions](https://docs.codat.io/lending-api#/operations/list-all-banking-transactions). + + ## Overview + + In Codat’s data model, account transactions represent bank activity within an accounting software. All transactions that go through a bank account are recorded as account transactions. + + Account transactions are created as a result of different business activities, for example: + + * Payments: for example, receiving money for payment against an invoice. + * Bill payments: for example, spending money for a payment against a bill. + * Direct costs: for example, withdrawing money from a bank account, either for cash purposes or to make a payment. + * Direct incomes: for example, selling an item directly to a contact and receiving payment at point of sale. + * Transfers: for example, transferring money between two bank accounts. + + Account transactions is the parent data type of [payments](https://docs.codat.io/lending-api#/schemas/Payment), [bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment), [direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost), [direct incomes](https://docs.codat.io/lending-api#/schemas/DirectIncome), and [transfers](https://docs.codat.io/lending-api#/schemas/Transfer). + type: object + allOf: + - type: object + properties: + id: + type: string + description: Identifier of the direct cost (unique to the company). + transactionId: + type: string + nullable: true + description: Identifier of the transaction (unique to the company). + note: + type: string + nullable: true + description: 'Additional information about the account transaction, if available.' + bankAccountRef: + $ref: '#/components/schemas/AccountingBankAccount/definitions/bankAccountRef' + description: Reference to the bank account the account transaction is recorded against. + date: + $ref: '#/components/schemas/DateTime' + description: The date the account transaction was recorded in the platform. + status: + enum: + - Unknown + - Unreconciled + - Reconciled + - Void + type: string + description: The status of the account transaction. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lines: + type: array + nullable: true + description: Array of account transaction lines. + items: + $ref: '#/components/schemas/AccountingAccountTransaction/definitions/accountTransactionLine' + totalAmount: + type: number + format: decimal + description: 'Total amount of the account transactions, inclusive of tax.' + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + accountTransactionLine: + type: object + properties: + description: + type: string + nullable: true + description: Description of the account transaction. + recordRef: + $ref: '#/components/schemas/AccountingAccountTransaction/definitions/accountTransactionLineRecordRef' + amount: + type: number + format: decimal + description: Amount in the bill payment currency. + accountTransactionLineRecordRef: + type: object + title: Record reference + description: Links an account transaction line to the underlying record that created it. + properties: + id: + type: string + description: '''id'' of the underlying record or data type.' + dataType: + type: string + description: Name of underlying data type. + enum: + - bankTransactions + - billCreditNotes + - billPayments + - bills + - creditNotes + - directCosts + - directIncomes + - invoices + - journalEntries + - payments + - transfers + example: transfers + AccountingAccountTransactions: + title: 'Accounting: Account transactions' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingAccountTransaction' + - $ref: '#/components/schemas/PagingInfo' + AccountingAddress: + title: 'Accounting: Address' + x-internal: true + type: object + properties: + type: + $ref: '#/components/schemas/AccountingAddress/definitions/accountingAddressType' + line1: + type: string + nullable: true + description: Line 1 of the customer address. + line2: + type: string + nullable: true + description: Line 2 of the customer address. + city: + type: string + nullable: true + description: City of the customer address. + region: + type: string + nullable: true + description: Region of the customer address. + country: + type: string + nullable: true + description: Country of the customer address. + postalCode: + type: string + nullable: true + description: Postal code or zip code. + required: + - type + definitions: + accountingAddressType: + description: The type of the address + type: string + enum: + - Unknown + - Billing + - Delivery + AccountingAgedCreditorReport: + title: 'Accounting: Aged creditors report' + description: "The Aged Creditors report shows the total balance owed by a business to its suppliers over time.\n\nYou can generate it for a company based on recently synced data from your customers' accounting software. The report is available in the **Reports** tab in the Codat portal.\n\nTotal assets or liabilities are grouped into 30-day periods for each supplier, up to the current date. You can adjust the report date, period length, and number of periods to show on each report. The data can be grouped by customer or currency.\n\n> It is not guaranteed that write-offs are included in the Aged Creditors report.\n\n## Underlying data\n\nThe Aged Creditors report is generated from a set of required data types: [Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier), [Bills](https://docs.codat.io/lending-api#/schemas/Bill), [Bill credit notes](https://docs.codat.io/lending-api#/schemas/BillCreditNote), and [Bill payments](https://docs.codat.io/lending-api#/schemas/BillPayment).\n\nTo generate the report, the underlying data types must have been synced within 24 hours of each other. Otherwise an error is displayed when you try to run the report. Sync the required data types by clicking the link in the error, and then run the report again.\n\n> The Aged Creditor report runs based on the **issue dates** of the underlying data types rather than the due date.\n\n## Accessing the Aged Creditors report in Portal\n\nApart from returning the report via the API as JSON and query, you can also return the Aged Creditors report in the Codat portal.\n\n1. In the navigation bar, click **Companies**.\n2. Click the name of the company you want to generate the report for. The company's data page is displayed.\n3. Click the **Accounting** tab then click **Reports**.\n4. Select **Aged Creditors**.\n5. _(Optional)_ Edit the default reporting parameters.\n a. You can change the report date in the **Date** box. By default, the report includes transactions that occurred up to, but not including, today's date. To include transactions for today, enter tomorrow's date. \n b. In the **Period Length Days** box, select the default period length for each column (the default is 30 days).\n b. In the **Number of Periods** box, enter the number of periods to show as columns in the report (the default is 4 periods).\n6. To run the report, click **Load aged creditors**.\n7. The report is generated and displayed at the bottom of the page.\n\nThe report will be grouped per supplier and depending on the periods requested. The details indicates whether the amounts owed come from outstanding bills or bill credit notes." + type: object + properties: + generated: + $ref: '#/components/schemas/DateTime' + description: Date and time the report was generated. + reportDate: + $ref: '#/components/schemas/DateTime' + description: Date the report is generated up to. + data: + type: array + description: Array of aged creditor. + items: + $ref: '#/components/schemas/AccountingAgedCreditorReport/definitions/agedCreditor' + examples: + - generated: '2022-10-23T00:00:00Z' + reportDate: '2022-10-23T00:00:00Z' + data: + - customerId: f594cefb-7750-4c3a-bab2-b5322026dee9 + customerName: John Doe + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2022-10-01T00:00:00Z' + toDate: '2022-10-31T00:00:00Z' + amount: 1547.5 + details: + - name: Bills + amount: 1547.5 + definitions: + agedCreditor: + title: Aged creditor + type: object + properties: + supplierId: + type: string + description: Supplier ID of the aged creditor. + example: f594cefb-7750-4c3a-bab2-b5322026dee9 + supplierName: + type: string + description: Supplier name of the aged creditor. + example: John Doe + agedCurrencyOutstanding: + type: array + description: Array of aged creditors by currency. + items: + $ref: '#/components/schemas/AgedCurrencyOutstanding' + AccountingAgedDebtorReport: + type: object + title: 'Accounting: Aged debtors report' + description: "The Aged Debtors report shows the total outstanding balance due from customers to the business over time. \n\nYou can generate it for a company based on recently synced data from your customers' accounting software. The report is available in the **Reports** tab in the Codat portal.\n\nTotal assets or liabilities are grouped into 30-day periods for each customer, up to the current date. You can adjust the report date, period length, and number of periods to show on each report. The data can be grouped by customer or currency.\n\n> It is not guaranteed that write-offs are included in the Aged Debtors report.\n\n## Underlying data\n\nThe Aged Debtors report is generated from a set of required data types: [Customers](https://docs.codat.io/lending-api#/schemas/Customer), [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice), [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote), and [Payments](https://docs.codat.io/lending-api#/schemas/Payment).\n\nTo generate the report, the underlying data types must have been synced within 24 hours of each other. Otherwise an error is displayed when you try to run the report. Sync the required data types by clicking the link in the error, and then run the report again.\n\n> The Aged Debtors report runs based on the **issue dates** of the underlying data types rather than the due date.\n\n## Accessing the Aged Debtors report in Portal\n\nApart from returning the report via the API as JSON and query, you can also return the Aged Debtors report in the Codat portal.\n\n1. In the navigation bar, click **Companies**.\n2. Click the name of the company you want to generate the report for. The company's data page is displayed.\n3. Click the **Accounting** tab then click **Reports**.\n4. Select **Aged Debtors**.\n5. _(Optional)_ Edit the default reporting parameters.\n a. You can change the report date in the **Date** box. By default, the report includes transactions that occurred up to, but not including, today's date. To include transactions for today, enter tomorrow's date. \n b. In the **Period Length Days** box, select the default period length for each column (the default is 30 days).\n b. In the **Number of Periods** box, enter the number of periods to show as columns in the report (the default is 4 periods).\n6. To run the report, click **Load aged debtors**.\n7. The report is generated and displayed at the bottom of the page.\n\nThe report will be grouped per supplier and depending on the periods requested. The details indicates whether the amounts owed come from outstanding invoices or credit notes." + properties: + generated: + $ref: '#/components/schemas/DateTime' + description: Date and time the report was generated. + reportDate: + $ref: '#/components/schemas/DateTime' + description: Date the report is generated up to. + data: + type: array + description: Array of aged debtors. + items: + $ref: '#/components/schemas/AccountingAgedDebtorReport/definitions/agedDebtor' + definitions: + agedDebtor: + title: Aged debtor + type: object + properties: + customerId: + type: string + description: Customer ID of the aged debtor. + example: f594cefb-7750-4c3a-bab2-b5322026dee9 + customerName: + type: string + description: Customer name of the aged debtor. + example: John Doe + agedCurrencyOutstanding: + type: array + description: Array of aged debtors by currency. + items: + $ref: '#/components/schemas/AgedCurrencyOutstanding' + examples: + - generated: '2022-10-23T00:00:00Z' + reportDate: '2022-10-23T00:00:00Z' + data: + - customerId: f594cefb-7750-4c3a-bab2-b5322026dee9 + customerName: John Doe + agedCurrencyOutstanding: + - currency: GBP + agedOutstandingAmounts: + - fromDate: '2022-10-01T00:00:00Z' + toDate: '2022-10-31T00:00:00Z' + amount: 1547.5 + details: + - name: Invoices + amount: 1547.5 + AccountingAttachment: + title: 'Accounting: Attachment' + description: "The Codat API supports pulling and pushing of file attachments for invoices, bills, direct costs, and direct incomes.\n\n> **Retrieving attachments**\n> \n> If a company is authorized, you can query the Codat API to read, download, and upload attachments without requiring a fresh sync of data.\n\nUnlike other data types, Codat doesn't support [sync settings](https://docs.codat.io/knowledge-base/advanced-sync-settings) for attachments.\n\nNote that different integrations have different requirements to file size and extension of attachments.\n\n| Integration | File size | File extension |\n|-------------------|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| Xero | 4 MB | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF, ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX, ZIP |\n| QuickBooks Online | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML |\n| NetSuite | 100 MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP |\n| Dynamics 365 Business Central | 350 MB | Dynamics do not explicitly outline which file types are supported but they do state here that \"You can attach any type of file, such as text, image, or video files\". |\n" + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the attachment, unique for the company in the accounting software.' + name: + type: string + nullable: true + description: Name of the attachment file. + contentType: + type: string + nullable: true + description: "File type of the attachment. This is represented by appending the file type to the [IETF standard file naming requirements](https://tools.ietf.org/html/rfc6838). For example, for a jpeg file the output is **image/jpeg**.\n\nSupported file types vary per platform. " + dateCreated: + $ref: '#/components/schemas/DateTime' + fileSize: + type: integer + format: int32 + nullable: true + description: 'File size in bytes. For example, if this reads **46153**, then the file size is 46kb.' + includeWhenSent: + type: boolean + description: 'If `true`, then the attachment is included with the associated invoice, bill or direct costs when it is printed, emailed, or sent to a customer, if the underlying accounting software allows this.' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + examples: [] + definitions: + attachments: + title: Attachments + type: object + properties: + attachments: + description: An array of attachments related to the record. + type: array + items: + $ref: '#/components/schemas/AccountingAttachment' + nullable: true + AccountingBalanceSheet: + title: 'Accounting: Balance sheet' + description: |- + ## Overview + + The balance sheet is a snapshot of a company's accounts at a single point in time that provides a statement of the assets, liabilities and equity of an organization. It gives interested parties an idea of the company's financial position, in addition to displaying what the company owns and owes. + + > **Balance sheet or profit and loss report?** + > + > A profit and loss report summarises the total revenue, expenses, and profit or loss during a specified time period. A balance sheet report shows the financial position of a company at a specific moment in time. + + **Structure of this report** + This report will reflect the structure and line descriptions that the business has set in their own accounting software. + + **History** + By default, Codat pulls (up to) 24 months of balance sheets for a company. You can adjust this to fetch more history, where available, by updating the `monthsToSync` value for `balanceSheet` on the [data type settings endpoint](https://docs.codat.io/lending-api#/operations/update-sync-settings). + + **Want to pull this in a standardised structure?** + Our [Enhanced Financials](https://docs.codat.io/lending/features/financial-statements-overview) endpoints provide the same report under standardized headings, allowing you to pull it in the same format for all of your business customers. + type: object + additionalProperties: false + properties: + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the balance sheet. + reports: + type: array + description: An array of balance sheet reports. + items: + $ref: '#/components/schemas/AccountingBalanceSheet/definitions/balanceSheet' + mostRecentAvailableMonth: + $ref: '#/components/schemas/DateTime' + nullable: true + description: Most recent available monthly report data. + earliestAvailableMonth: + $ref: '#/components/schemas/DateTime' + nullable: true + description: Earliest available monthly report data. + required: + - reports + definitions: + balanceSheet: + type: object + properties: + date: + $ref: '#/components/schemas/DateTime' + description: Point in time when a snapshot of a company's financial position is taken. + assets: + $ref: '#/components/schemas/ReportLine' + description: 'ReportLines for assets. For example, fixed and current assets.' + liabilities: + $ref: '#/components/schemas/ReportLine' + description: 'ReportLines for liabilities. For example, current liabilities.' + netAssets: + type: number + format: decimal + description: Value of net assets for a company in their base currency. + equity: + $ref: '#/components/schemas/ReportLine' + description: 'ReportLines for equities. For example, retained and current year earnings. See below.' + required: + - netAssets + AccountingBankAccount: + 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/lending-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/AccountingBankAccount/definitions/bankAccountPrototype' + - properties: + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + 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: + $ref: '#/components/schemas/AccountingBankAccountType' + 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/AccountingBankAccount/definitions/bankAccountStatus' + bankAccountCreateResponse: + title: Create bank account response + allOf: + - properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingBankAccount' + - 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/AccountingBankAccount' + - $ref: '#/components/schemas/PagingInfo' + bankAccountStatus: + title: Account status + enum: + - Unknown + - Active + - Archived + - Pending + type: string + description: Status of the bank account. + example: Active + AccountingBankAccounts: + x-internal: true + title: 'Accounting: Bank accounts' + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingBankAccount' + - $ref: '#/components/schemas/PagingInfo' + AccountingBankAccountType: + 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." + AccountingBankTransaction: + title: 'Accounting: Bank account transaction' + description: "> **Accessing Bank Accounts through Banking API**\n> \n> This datatype was originally used for accessing bank account data both in accounting integrations and open banking aggregators. \n>\n> To view bank account data through the Banking API, please refer to the new [Banking: Transaction](https://docs.codat.io/lending-api#/operations/list-transactions) data type.\n\n## Overview\n\nTransactional banking data for a specific company and account.\n\nBank transactions include the:\n* Amount of the transaction.\n* Current account balance.\n* Transaction type, for example, credit, debit, or transfer." + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the bank transaction, unique to the company in the accounting software.' + accountId: + type: string + nullable: true + description: Unique identifier to the `accountId` the bank transactions originates from. + clearedOnDate: + $ref: '#/components/schemas/DateTime' + description: + type: string + nullable: true + description: Description of the bank transaction. + reconciled: + type: boolean + description: '`True` if the bank transaction has been [reconciled](https://www.xero.com/uk/guides/what-is-bank-reconciliation/) in the accounting software.' + amount: + type: number + format: decimal + description: The amount transacted in the bank transaction. + balance: + type: number + format: decimal + description: The remaining balance in the account with ID `accountId`. + transactionType: + $ref: '#/components/schemas/AccountingBankTransaction/definitions/bankTransactionType' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + bankTransactionType: + title: Bank transaction type + description: Type of transaction for the bank statement line. + type: string + enum: + - Unknown + - Credit + - Debit + - Int + - Div + - Fee + - SerChg + - Dep + - Atm + - Pos + - Xfer + - Check + - Payment + - Cash + - DirectDep + - DirectDebit + - RepeatPmt + - Other + AccountingBankTransactions: + title: 'Accounting: Accounting bank transactions' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingBankTransaction' + - $ref: '#/components/schemas/PagingInfo' + AccountingBill: + title: 'Accounting: Bill' + description: |- + > **Invoices or bills?** + > + > We distinguish between invoices where the company *owes money* vs. *is owed money*. If the company has received an invoice, and owes money to someone else (accounts payable) we call this a Bill. + > + > See [Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) for the accounts receivable equivalent of bills. + + ## Overview + + In Codat, a bill contains details of: + * When the bill was recorded in the accounting system. + * How much the bill is for and the currency of the amount. + * Who the bill was received from — the *supplier*. + * What the bill is for — the *line items*. + + Some accounting software give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's *expenses*. + + You can find these types of transactions in our [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) data model. + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the bill, unique for the company in the accounting software.' + reference: + type: string + nullable: true + description: User-friendly reference for the bill. + supplierRef: + $ref: '#/components/schemas/AccountingSupplier/definitions/supplierRef' + purchaseOrderRefs: + type: array + nullable: true + items: + title: Purchase order Reference + type: object + additionalProperties: false + properties: + id: + type: string + description: 'Identifier for the purchase order, unique for the company in the accounting software.' + purchaseOrderNumber: + type: string + nullable: true + description: 'Friendly reference for the purchase order, commonly generated by the accounting software.' + issueDate: + allOf: + - description: Date of the bill as recorded in the accounting software. + - $ref: '#/components/schemas/DateTime' + dueDate: + allOf: + - description: Date the supplier is due to be paid. + - $ref: '#/components/schemas/DateTime' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + nullable: true + description: Array of Bill line items. + items: + $ref: '#/components/schemas/AccountingBill/definitions/billLineItem' + withholdingTax: + type: array + nullable: true + items: + type: object + properties: + name: + minLength: 1 + type: string + description: Name assigned to withheld tax. + amount: + type: number + format: decimal + description: Amount of tax withheld. + required: + - amount + - name + status: + $ref: '#/components/schemas/AccountingBill/definitions/billStatus' + subTotal: + type: number + format: decimal + description: 'Total amount of the bill, excluding any taxes.' + taxAmount: + type: number + format: decimal + description: Amount of tax on the bill. + totalAmount: + type: number + format: decimal + description: 'Amount of the bill, including tax.' + amountDue: + type: number + format: decimal + nullable: true + description: Amount outstanding on the bill. + note: + type: string + nullable: true + description: 'Any private, company notes about the bill, such as payment information.' + paymentAllocations: + type: array + nullable: true + description: An array of payment allocations. + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - issueDate + - status + - subTotal + - taxAmount + - totalAmount + definitions: + billStatus: + description: Current state of the bill. + type: string + enum: + - Unknown + - Open + - PartiallyPaid + - Paid + - Void + - Draft + billLineItem: + title: Bill line item + type: object + properties: + lineNumber: + type: string + nullable: true + description: The bill line's number. + description: + type: string + nullable: true + description: Friendly name of the goods or services received. + unitAmount: + type: number + format: decimal + description: Price of each unit of goods or services. + quantity: + type: number + format: decimal + description: Number of units of goods or services received. + unitOfMeasurement: + type: string + nullable: true + description: 'The measurement which defines a unit for this item (e.g. ''kilogram'', ''litre'').' + discountAmount: + type: number + format: decimal + nullable: true + description: |- + Numerical value of any discounts applied. + + Do not use to apply discounts in Oracle NetSuite—see Oracle NetSuite integration reference. + subTotal: + type: number + format: decimal + nullable: true + description: 'Amount of the line, inclusive of discounts but exclusive of tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: Amount of tax for the line. + totalAmount: + type: number + format: decimal + nullable: true + description: 'Total amount of the line, including tax.' + discountPercentage: + type: number + format: decimal + nullable: true + description: Percentage rate of any discount applied to the bill. + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Reference to the account to which the line item is linked. + nullable: true + taxRateRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/taxRateRef' + description: Reference to the tax rate to which the line item is linked. + itemRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/itemRef' + description: 'Reference to the product, service type, or inventory item to which the line item is linked.' + purchaseOrderLineRef: + allOf: + - type: object + x-internal: true + title: Record line reference + description: "Links the current record line to the underlying record line that created it. \n\nFor example, if a bill is generated from a purchase order, this property allows you to connect the bill line item to the purchase order line item in our data model. " + properties: + id: + type: string + description: '''id'' of the underlying record.' + dataType: + type: string + description: Allowed name of the 'dataType'. + enum: + - purchaseOrders + - bills + lineNumber: + type: string + description: Line number of the underlying record. + - description: Reference to the purchase order line this line was generated from. + trackingCategoryRefs: + type: array + nullable: true + description: Collection of categories against which this item is tracked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + tracking: + $ref: '#/components/schemas/AccountsPayableTracking' + isDirectCost: + type: boolean + description: The bill is a direct cost if `True`. + AccountingBillCreditNote: + title: 'Accounting: Bill credit note' + description: "> **Bill credit notes or credit notes?**\n> \n> In Codat, bill credit notes represent accounts payable only. For accounts receivable, see [Credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote).\n\n## Overview\n\nA bill credit note is issued by a supplier for the purpose of recording credit. For example, if a supplier was unable to fulfil an order that was placed by a business, or delivered damaged goods, they would issue a bill credit note. A bill credit note reduces the amount a business owes to the supplier. It can be refunded to the business or used to pay off future bills.\n\nIn the Codat API, a bill credit note is an accounts payable record issued by a [supplier](https://docs.codat.io/lending-api#/schemas/Supplier). \n\nA bill credit note includes details of:\n* The original and remaining credit.\n* Any allocations of the credit against other records, such as [bills](https://docs.codat.io/lending-api#/schemas/Bill).\n* The supplier that issued the bill credit note." + type: object + allOf: + - type: object + properties: + id: + type: string + description: Identifier for the bill credit note that is unique to a company in the accounting software. + example: 1509398f-98e2-436d-8a5d-c042e0c74ffc + billCreditNoteNumber: + type: string + nullable: true + description: Friendly reference for the bill credit note. + example: 91fe2a83-e161-4c21-929d-c5c10c4b07e5 + supplierRef: + $ref: '#/components/schemas/AccountingSupplier/definitions/supplierRef' + withholdingTax: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingBill/allOf/0/properties/withholdingTax/items' + totalAmount: + type: number + format: decimal + description: 'Total amount of credit that has been applied to the business'' account with the supplier, including discounts and tax.' + example: 805.78 + totalDiscount: + type: number + format: decimal + description: Total value of any discounts applied. + example: 0 + subTotal: + type: number + format: decimal + description: 'Total amount of the bill credit note, including discounts but excluding tax.' + example: 805.78 + totalTaxAmount: + type: number + format: decimal + description: Amount of tax included in the bill credit note. + example: 0 + discountPercentage: + type: number + format: decimal + description: Percentage rate of any discount applied to the bill credit note. + example: 0 + remainingCredit: + type: number + format: decimal + description: Amount of the bill credit note that is still outstanding. + example: 0 + status: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteStatus' + issueDate: + $ref: '#/components/schemas/DateTime' + description: Date the bill credit note was issued by the supplier. + example: '2022-03-15T00:00:00' + allocatedOnDate: + $ref: '#/components/schemas/DateTime' + nullable: true + description: Date the bill credit note was fully refunded or allocated. + example: '2022-09-15T16:35:00' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the bill credit note. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + nullable: true + description: 'An array of line ' + items: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem' + paymentAllocations: + nullable: true + type: array + description: An array of payment allocations. + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + createdFromRefs: + nullable: true + type: array + description: An array of records the credit note was created from. + items: + $ref: '#/components/schemas/AccountingRecordRef' + note: + type: string + nullable: true + description: Any additional information about the bill credit note. + example: 'Bill Credit Note with 1 line items, totaling 805.78' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - totalAmount + - totalDiscount + - subTotal + - totalTaxAmount + - discountPercentage + - status + definitions: + billCreditNoteStatus: + type: string + description: Current state of the bill credit note + enum: + - Unknown + - Draft + - Submitted + - Paid + - Void + - PartiallyPaid + example: Paid + billCreditNoteLineItem: + type: object + properties: + description: + type: string + nullable: true + description: 'Friendly name of each line item. For example, the goods or service for which credit has been received.' + unitAmount: + type: number + format: decimal + description: Unit price of the goods or service. + quantity: + type: number + format: decimal + description: Number of units of the goods or service for which credit has been received. + unitOfMeasurement: + type: string + nullable: true + description: 'The measurement which defines a unit for this item (e.g. ''kilogram'', ''litre'').' + discountAmount: + type: number + format: decimal + nullable: true + description: Value of any discounts applied. + subTotal: + type: number + format: decimal + nullable: true + description: 'Amount of credit associated with the line item, including discounts but excluding tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: Amount of tax associated with the line item. + totalAmount: + type: number + format: decimal + nullable: true + description: 'Total amount of the line item, including discounts and tax.' + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + discountPercentage: + type: number + format: decimal + nullable: true + description: Percentage rate of any discount applied to the line item. + taxRateRef: + title: Tax rate reference + type: object + description: |- + Data types that reference a tax rate, for example invoice and bill line items, use a taxRateRef that includes the ID and name of the linked tax rate. + + Found on: + + - Bill line items + - Bill Credit Note line items + - Credit Note line items + - Direct incomes line items + - Invoice line items + - Items + properties: + id: + type: string + description: Unique identifier for the tax rate in the accounting software. + name: + type: string + description: Name of the tax rate in the accounting software. + effectiveTaxRate: + type: number + format: decimal + description: Applicable tax rate. + itemRef: + description: Reference to the item the line is linked to. + title: Item reference + type: object + properties: + id: + minLength: 1 + type: string + description: Unique identifier for the item in the accounting software. + name: + type: string + nullable: true + description: Name of the item in the accounting software. + required: + - id + createdFromLineRef: + $ref: '#/components/schemas/AccountingBill/definitions/billLineItem/properties/purchaseOrderLineRef/allOf/0' + description: Reference to the line of the item that the current line was created from. + trackingCategoryRefs: + type: array + nullable: true + deprecated: true + description: Reference to the tracking categories to which the line item is linked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + tracking: + $ref: '#/components/schemas/AccountsPayableTracking' + required: + - unitAmount + - quantity + examples: + - id: 6a0e9dfb-87b0-47d3-aaaf-9753ae9e757d + billCreditNoteNumber: '14763237' + totalAmount: 693 + remainingCredit: 693 + status: Submitted + issueDate: '2019-02-18T16:03:07.268Z' + note: Track separately + currency: USD + lineItems: + - description: AcmeMagnet + unitAmount: 25 + discountAmount: 0 + quantity: 4 + subTotal: 100 + taxAmount: 10 + totalAmount: 110 + itemRef: + id: '3' + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + accountRef: + id: 3f267b10-757d-44c0-bef9-20f70cc8fbe3 + trackingCategoryRefs: + - id: department_1 + name: ACMERockets + - id: costcode_2 + name: ACM2-ACMESigns + createdFromLineRef: + - id: '8462' + dataType: bill + lineNumber: 1 + - description: ACMEDisintegratingPistol + unitAmount: 25 + discountAmount: 0 + quantity: 3 + subTotal: 75 + taxAmount: 7.5 + totalAmount: 82.5 + itemRef: + id: 3abf0883-03f7-44c6-bc15-1372522d25e1 + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + accountRef: + id: 3f267b10-757d-44c0-bef9-20f70cc8fbe3 + - description: ACMEWhippedCreamDispenser + unitAmount: 52 + discountAmount: 0 + quantity: 6 + subTotal: 312 + taxAmount: 31.2 + totalAmount: 343.2 + itemRef: + id: 3691f3d9-0ff7-4358-8a93-bed31c1b4b03 + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + accountRef: + id: 3f267b10-757d-44c0-bef9-20f70cc8fbe3 + - description: ACMEJetPropelledPogoStick + unitAmount: 130 + discountAmount: 0 + quantity: 1 + subTotal: 130 + taxAmount: 27.3 + totalAmount: 157.3 + itemRef: + id: 075410d4-7edc-4936-ba52-9e1e43cbe300 + taxRateRef: + id: d606732b-db18-44d7-823b-7f15f42c32ea + accountRef: + id: 3f267b10-757d-44c0-bef9-20f70cc8fbe3 + supplierRef: + id: 67C6A7A1-5E84-4AC4-B950-24A114E379D0 + supplierName: Chin's Gas and Oil + createdFromLineRef: + id: '8462' + dataType: bills + line: 1 + AccountingBillCreditNotes: + title: 'Accounting: Bill credit notes' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingBillCreditNote' + - $ref: '#/components/schemas/PagingInfo' + AccountingBillPayment: + title: 'Accounting: Bill payment' + description: "> **Bill payments or payments?** \n> \n> We distinguish between transactions where the company received money vs. paid money. If the transaction represents a company spending money (accounts payable) we call this a Bill payment.\n>\n> See [payments](https://docs.codat.io/lending-api#/schemas/Payment) for the accounts receivable equivalent of Bill payments, which covers [invoices](https://docs.codat.io/lending-api#/schemas/Invoice) and [credit notes](https://docs.codat.io/lending-api#/schemas/CreditNote).\n\n## Overview\n\nBill payments include all accounts payable transaction data ([bills](https://docs.codat.io/lending-api#/schemas/Bill) and [credit notes against bills](https://docs.codat.io/lending-api#/schemas/BillCreditNote)).\n\nA bill payment in Codat usually represents an allocation of money within any customer accounts payable account. This includes, but is not strictly limited to:\n\n- A payment made against a bill — for example, a credit card payment, cheque payment, or cash payment.\n- An allocation of a supplier's credit note to a bill or perhaps a refund.\n- A bill payment made directly to an accounts payable account. This could be an overpayment or a prepayment, or a refund of a payment made directly to an accounts payable account.\n\nDepending on the bill payments which are allowed by the underlying accounting software, some of these types may be combined. Please see the example data section for samples of what these cases look like.\n\nIn Codat, a bill payment contains details of:\n\n- When the bill payment was recorded in the accounting system.\n- How much it is for and in the currency.\n- Who the payment has been paid to, the _supplier_.\n- The types of bill payments, the _line items_. \n\nSome accounting software give a separate name to purchases where the payment is made immediately, such as something bought with a credit card or online payment. One example of this would be QuickBooks Online's _expenses_. You can find these types of transactions in our [Direct costs](https://docs.codat.io/lending-api#/schemas/DirectCost) data model.\n\nBill payments is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).\n\n---\n\n## Bill payment types\n\n### Payment of a bill\n\nA payment paying a single bill should have the following properties:\n\n- A `totalAmount` indicating the amount of the bill that was paid. This is always positive.\n- A `lines` array containing one element with the following properties:\n - An `amount` equal to the `totalAmount` above.\n - A `links` array containing one element with the following properties:\n - A `type` indicating the type of link, in this case a `Bill`.\n - An `id` containing the ID of the bill that was paid.\n - An amount of `-totalAmount` (negative `totalAmount`), indicating that the entirety of the paid amount is allocated to the bill.\n\n### Payment of multiple bills\n\nIt is possible for one payment to pay multiple bills. This can be represented using two possible formats, depending on how the supplier keeps their books:\n\n1. The payment has multiple entries in its **lines** array, one for each bill that is paid. Each line will follow the above example for paying a bill, and the rules detailed in the data model.\n2. The payment has a line with multiple links to each bill. This occurs when the proportion of the original payment allocated to each bill is not available.\n\nEach line is the same as those described above, with the **amount** indicating how much of the payment is allocated to the bill. The **amount** on the lines sum to the **totalAmount** on the payment.\n\n> Pushing batch payments to Xero\n> \n> When pushing a single bill payment to Xero to pay multiple bills, only the first format is supported—multiple entries in the payment **lines** array.\n\n### Payments and refunds on account\n\nA payment on account, that is a payment that doesn’t pay a specific bill, has one entry in its lines array.\n\nThe line has the following properties:\n\n- A **totalAmount** indicating the amount paid by a supplier or refunded to them by a company. A payment to the supplier is always negative. A refund is always positive.\n- A **links** array containing one element with the following properties:\n - A **type** indicating the type of link. For a payment this is `PaymentOnAccount`. For a refund this is `Refund`.\n - The **id** containing the ID of the supplier.\n - An amount for the link is `0` **totalAmount** or the amount of the payment or refund.\n\nIt is possible to have a payment that is part on account and part allocated to a bill. Each line should follow the examples above.\n\n### Using a credit note to pay a bill\n\nThe payment of a bill using a credit note has one entry in its `lines` array. This **line** has the following properties:\n\n- An **amount** indicating the amount of money moved, which in this case is `0`, as the credit note and bill allocation must balance each other.\n- A **links** array containing two elements:\n - The first link has:\n - A **type** indicating the type of link, in this case a `Bill`.\n - An **id** containing the ID of the bill that was paid.\n - The second link has:\n - A **type** indicating the type of link, in this case a `CreditNote`.\n - An **id** containing the ID of the credit note used by this payment.\n\nThe **amount** field on the **line** equals the **totalAmount** on the payment.\n\n### Refunding a credit note\n\nA bill payment refunding a credit note has one entry in its **lines** array. This line has the following properties:\n\n- An **amount** indicating the amount of the credit note that was refunded. This is always negative, indicating that it is a refund.\n- A **links** array containing one element with the following properties:\n - A **type** indicating the type of `link`, in this case a `CreditNote`.\n - An **id** containing the ID of the credit note that was refunded.\n\nThe **totalAmount** field on the payment equals the line's **amount** field. These are both negative, as this is money leaving accounts payable.\n\n### Refunding a payment\n\nIf a payment is refunded, for example, when a company overpaid a bill and the overpayment is returned, there are two payment records: \n\n- One for the incoming overpayment.\n- Another for the outgoing refund.\n\nThe payment issuing the refund is identified by the fact that the **totalAmount** is negative. This payment has one entry in its lines array that have the following properties:\n\n- An **amount** indicating the amount that was refunded. This is always negative.\n- A **links** array containing one element with the following properties:\n - A **type** indicating the type of a the link, in this case a `BillPayment`.\n - An **id** containing the ID of the payment that was refunded.\n\nThe **amount** field on the line equals the **totalAmount** on the payment and is negative as this is money leaving accounts payable.\n\nThe payment that was refunded can be identified as it has a line where the `amount` on its `line` is positive and the type of the link is `Refund`. This payment may have several entries in its **lines** array if it was partly used to pay an bill. For example, a £1,050 payment paying a £1,000 bill with a refund of £50 has two lines: \n\n- One for £1,000 linked to the bill that was paid\n- Another for £50 linked to the payment that refunded the over payment. This link is of type `Refund` but the ID corresponds to a bill payment.\n\nThe line linked to the bill payment has the following properties:\n\n- An **amount** indicating the amount that was refunded. This is positive as its money that was added to accounts payable, but is balanced out by the negative amount of the refund.\n- A **links** array containing one element with the following properties:\n - A **type** indicating the type of the link, in this case a `Refund`.\n - An **id** containing the ID of the payment that refunded this line.\n\n> Linked payments\n> \n> Not all accounting software support linked payments in this way. In these platforms you may see a payment on account and a refund on account.\n\n## Foreign currencies\n\nThere are two types of currency rate that are detailed in the bill payments data type: \n\nPayment currency rate: \n\n- Base currency of the accounts payable account.\n- Foreign currency of the bill payment.\n\nPayment line link currency rate: \n\n- Base currency of the item that the link represents.\n- Foreign currency of the payment.\n\nThese two rates allow the calculation of currency loss or gain for any of the transactions affected by the payment lines. The second rate is used when a bill payment is applied to an item in a currency that does not match either:\n\n- The base currency for the accounts payable account. \n- The currency of the item.\n" + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the bill payment, unique for the company in the accounting software.' + example: 3d5a8e00-d108-4045-8823-7f342676cffa + supplierRef: + allOf: + - $ref: '#/components/schemas/AccountingSupplier/definitions/supplierRef' + - description: Supplier against which the payment is recorded in the accounting software. + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Account the payment is linked to in the accounting software. + totalAmount: + type: number + format: decimal + description: Amount of the payment in the payment currency. This value never changes and represents the amount of money that is paid into the supplier's account. + example: 1329.54 + currency: + allOf: + - $ref: '#/components/schemas/SourceAccount/properties/currency' + - description: ISO currency code in which the bill payment is recorded in the accounting software. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + date: + allOf: + - $ref: '#/components/schemas/DateTime' + - description: Date the bill payment was recorded in the accounting software. + note: + type: string + nullable: true + description: Additional information associated with the payment. + example: Bill Payment against bill c13e37b6-dfaa-4894-b3be-9fe97bda9f44 + paymentMethodRef: + allOf: + - $ref: '#/components/schemas/PaymentMethodRef' + - description: The Payment Method to which the payment is linked in the accounting software. + lines: + type: array + nullable: true + description: An array of bill payment lines. + items: + $ref: '#/components/schemas/AccountingBillPayment/definitions/billPaymentLine' + reference: + type: string + nullable: true + description: Additional information associated with the payment. + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - date + definitions: + billPaymentLine: + type: object + properties: + amount: + type: number + format: decimal + description: Amount in the bill payment currency. + links: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingBillPayment/definitions/billPaymentLineLink' + allocatedOnDate: + $ref: '#/components/schemas/DateTime' + description: AllocatedOnDate must be specified and be later than the issue date of the bill. + required: + - amount + billPaymentLineLink: + type: object + properties: + type: + $ref: '#/components/schemas/AccountingBillPayment/definitions/billPaymentLineLinkType' + id: + type: string + nullable: true + description: Unique identifier of the transaction represented by the link. + amount: + type: number + format: decimal + nullable: true + description: |- + Amount by which the balance of the linked entity is altered, in the currency of the linked entity. + + - A negative link amount reduces the outstanding amount on the accounts payable account. + - A positive link amount increases the outstanding amount on the accounts payable account. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + required: + - type + billPaymentLineLinkType: + description: Types of links to bill payment lines. + type: string + enum: + - Unknown + - Unlinked + - Bill + - Other + - CreditNote + - BillPayment + - PaymentOnAccount + - Refund + - ManualJournal + - Discount + examples: + - totalAmount: 1000 + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + - totalAmount: 0 + lines: + - amount: 0 + links: + - type: Bill + id: x + amount: -1000 + - type: CreditNote + id: 'y' + amount: 1000 + - totalAmount: 2000 + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + - amount: 1000 + links: + - type: PaymentOnAccount + id: 'y' + amount: -1000 + - totalAmount: -1000 + lines: + - amount: -1000 + links: + - type: CreditNote + id: 'y' + amount: 1000 + - totalAmount: -1000 + lines: + - amount: -1000 + links: + - type: PaymentOnAccount + id: 'y' + amount: 1000 + - totalAmount: 250 + lines: + - amount: 0 + links: + - type: Bill + id: x + amount: -750 + - type: CreditNote + id: 'y' + amount: 750 + - amount: 250 + links: + - type: Bill + id: x + amount: -250 + - totalAmount: 1000 + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + modifiedDate: '2022-10-23T00:00:00Z' + sourceModifiedDate: '2022-10-23T00:00:00Z' + - totalAmount: 2000 + lines: + - amount: 0 + links: + - type: Bill + id: x + amount: -1000 + - type: CreditNote + id: 'y' + amount: 1000 + - amount: 0 + links: + - type: Bill + id: x + amount: -1000 + - type: CreditNote + id: z + amount: 1000 + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + - amount: 1000 + links: + - type: PaymentOnAccount + id: customer-001 + amount: -1000 + - totalAmount: 0 + lines: + - amount: 0 + links: + - type: Bill + id: w + amount: -1000 + - type: Bill + id: x + amount: -1000 + - type: CreditNote + id: 'y' + amount: 1000 + - type: CreditNote + id: z + amount: 1000 + - totalAmount: 1000 + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + modifiedDate: '2022-10-23T00:00:00Z' + sourceModifiedDate: '2022-10-23T00:00:00Z' + - id: '001' + totalAmount: 5000 + date: '1901-01-01' + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + - amount: 4000 + links: + - type: PaymentOnAccount + id: 'y' + amount: -4000 + - id: '001' + totalAmount: 5000 + date: '1901-01-01' + lines: + - amount: 1000 + links: + - type: Bill + id: x + amount: -1000 + - amount: 1000 + links: + - type: Bill + id: 'y' + amount: -1000 + - amount: 3000 + links: + - type: PaymentOnAccount + id: 'y' + amount: -3000 + - totalAmount: 500 + lines: + - amount: 500 + links: + - type: Bill + id: a + amount: -1000 + - type: Bill + id: b + amount: -1000 + - type: CreditNote + id: 'y' + amount: 750 + - type: CreditNote + id: z + amount: 750 + AccountingBillPayments: + title: 'Accounting: Bill payments' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingBillPayment' + - $ref: '#/components/schemas/PagingInfo' + AccountingBills: + title: 'Accounting: Bills' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingBill' + - $ref: '#/components/schemas/PagingInfo' + AccountingCashFlowStatement: + title: 'Accounting: Cash flow statement' + description: "> **Operating activities only** \n> \n> Currently, the cash flow statement shows cash that flows into and out of the company from operating activities *only*. Operating activities generate cash from the sale of goods or services.\n\n## Overview\n\nA cash flow statement is a financial report that records all cash that is received or spent by a company during a given period. It gives you a clearer picture of the company’s performance, and their ability to pay creditors and finance growth.\n\n> **Cash flow statement or balance sheet?**\n> \n> Look at the cash flow statement to understand a company's ability to pay its bills. Although the balance sheet may show healthy earnings at a specific point in time, the cash flow statement allows you to see whether the company is meeting its financial commitments, such as paying creditors or its employees." + type: object + properties: + reports: + description: Array of cash flow statements. + type: array + items: + $ref: '#/components/schemas/AccountingCashFlowStatement/definitions/cashFlowStatement' + reportBasis: + $ref: '#/components/schemas/AccountingCashFlowStatement/definitions/reportBasis' + reportInput: + $ref: '#/components/schemas/AccountingCashFlowStatement/definitions/reportInput' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of all values in the cash flow statement. + mostRecentAvailableMonth: + $ref: '#/components/schemas/DateTime' + nullable: true + earliestAvailableMonth: + $ref: '#/components/schemas/DateTime' + nullable: true + required: + - reports + - reportBasis + - reportInput + definitions: + reportBasis: + title: Report basis + description: 'Accounting method used when aggregating the report data. In this case, `Cash`.' + type: string + enum: + - Unknown + - Accrual + - Cash + reportInput: + description: Accounting method used to prepare the cash flow statement. + type: string + enum: + - Unknown + - Indirect + - Direct + cashFlowStatement: + title: Cash flow statement + type: object + properties: + fromDate: + $ref: '#/components/schemas/DateTime' + description: Start date for the reporting period. + toDate: + $ref: '#/components/schemas/DateTime' + description: End date for the reporting period. + cashReceipts: + $ref: '#/components/schemas/ReportLine' + description: ReportLines for cash receipts from the sale of goods. + cashPayments: + $ref: '#/components/schemas/ReportLine' + description: ReportLines for cash payments to suppliers for the purchase of goods or services. + AccountingCompanyInfo: + title: 'Accounting: Company information' + description: "Company info provides standard details about a linked company such as their address, phone number, and company registration.\n\n> **Company information or companies?**\n> \n> Company information is standard information that is held in the accounting software about a company. `Companies` is an endpoint that lists businesses in the Codat system that have linked and shared their data sources." + type: object + properties: + companyName: + type: string + nullable: true + description: Name of the linked company. + accountingPlatformRef: + type: string + nullable: true + description: Identifier or reference for the company in the accounting software. + companyLegalName: + type: string + nullable: true + description: Registered legal name of the linked company. + addresses: + type: array + nullable: true + description: An array of Addresses. + items: + $ref: '#/components/schemas/AccountingAddress' + phoneNumbers: + type: array + nullable: true + description: An array of phone numbers. + items: + $ref: '#/components/schemas/PhoneNumber' + webLinks: + type: array + nullable: true + description: An array of weblinks. + items: + $ref: '#/components/schemas/WebLink' + ledgerLockDate: + $ref: '#/components/schemas/DateTime' + description: 'If set in the accounting software, the date (in the ISO 8601 date/time format) after which accounting transactions cannot be edited. Commonly used when books are closed at year-end.' + registrationNumber: + type: string + nullable: true + description: Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House. + taxNumber: + type: string + nullable: true + description: Company tax number. + financialYearStartDate: + $ref: '#/components/schemas/DateTime' + description: Start date of the financial year for the company. + baseCurrency: + type: string + nullable: true + description: Currency set in the accounting software of the linked company. Used by the currency rate. + sourceUrls: + type: object + additionalProperties: + type: string + nullable: true + nullable: true + description: |- + URL addresses for the accounting source. + + For example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero). + createdDate: + $ref: '#/components/schemas/DateTime' + description: Date the linked company was created in the accounting software. + supplementalData: + $ref: '#/components/schemas/SupplementalData' + examples: + - companyName: ACME Corporation + accountingPlatformRef: 4444e827-401b-4925-92cb-d79086bf3b6b + companyLegalName: ACME Corporation Ltd. + addresses: + - type: Billing + line1: Warner House + line2: 98 Theobald's Road + city: London + region: '' + country: United Kingdom + postalcode: WC1X 8WB + - type: Unknown + line1: 123 Sierra Way + line2: '' + city: San Pablo + region: CA + country: '' + postalCode: '87999' + phoneNumbers: + - number: 010 1234 5678 + type: Landline + webLinks: + - type: Website + url: 'https://www.wbsl.com/' + ledgerLockDate: '2019-03-04T12:08:01.881Z' + registrationNumber: '1234567890' + taxNumber: GB 123456789 + financialYearStartDate: '2019-04-01T00:00:00Z' + baseCurrency: USD + sourceUrls: + url1: 'https://go.xero.com/organisationlogin/default.aspx?shortcode=!rxs0Q' + url2: 'https://reporting.xero.com/!rxs0Q' + createdDate: '2020-02-03T16:42:02Z' + AccountingCreateAccountResponse: + title: 'Accounting: Create account response' x-internal: true - tags: - - Bank accounts - summary: Create bank account - parameters: - - $ref: '#/components/parameters/timeoutInMinutes' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BankAccounts/allOf/0/properties/results/items/definitions/bankAccountPrototype' - examples: {} - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/BankAccounts/allOf/0/properties/results/items/definitions/bankAccountCreateResponse' - examples: {} - '400': - $ref: '#/components/responses/BadRequest' - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - description: "The *Create bank account* endpoint creates a new [bank account](https://docs.codat.io/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': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - post: - tags: - - Source accounts - summary: Create source accounts + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingAccount' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreateBankAccountResponse: + title: 'Accounting: Create bank account response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingBankAccount' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreateBankTransactions: + title: 'Accounting: Create bank account transactions' + type: object + properties: + accountId: + type: string + description: Unique identifier for a bank account. + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - '7110701885' + - EILBDVJVNUAGVKRQ + - Checking 0202 + transactions: + type: array + items: + $ref: '#/components/schemas/AccountingCreateBankTransactions/definitions/CreateBankAccountTransaction' + definitions: + CreateBankAccountTransaction: + title: Bank account transaction + type: object + properties: + id: + type: string + description: 'Identifier for the bank account transaction, unique for the company in the accounting software.' + amount: + type: number + format: decimal + description: The amount transacted in the bank transaction. + date: + $ref: '#/components/schemas/DateTime' + description: + nullable: false + type: string + description: Description of the bank transaction. + balance: + type: number + format: decimal + description: The remaining balance in the account with ID `accountId`. + AccountingCreateBankTransactionsResponse: + title: 'Accounting: Create/update bank transaction response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingCreateBankTransactions' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreateDirectCostResponse: + title: 'Accounting: Create direct cost response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingDirectCost' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreatePaymentResponse: + title: 'Accounting: Create payment response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingPayment' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreateSupplierResponse: + title: 'Accounting: Create supplier response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingSupplier' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreateTransferResponse: + title: 'Accounting: Create transfer response' + x-internal: true + allOf: + - type: object + properties: + data: + allOf: + - $ref: '#/components/schemas/AccountingTransfer' + - deprecated: true + - $ref: '#/components/schemas/PushOperation' + AccountingCreditNote: + title: 'Accounting: Credit note' + description: "## Overview\n\nThink of a credit note as a voucher issued to a customer. It is a reduction that can be applied against one or multiple invoices. A credit note can either reduce the amount owed or cancel out an invoice entirely.\n\nIn the Codat system a credit note is issued to a [customer's](https://docs.codat.io/lending-api#/schemas/Customer) accounts receivable. \n\nIt contains details of:\n* The amount of credit remaining and its status.\n* Payment allocations against the payments type, in this case an invoice.\n* Which customers the credit notes have been issued to." + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the credit note, unique to the company in the accounting software.' + creditNoteNumber: + type: string + nullable: true + description: Friendly reference for the credit note. + customerRef: + $ref: '#/components/schemas/AccountingCustomer/definitions/accountingCustomerRef' + description: Reference to the customer the credit note has been issued to. + withholdingTax: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingBill/allOf/0/properties/withholdingTax/items' + totalAmount: + type: number + format: decimal + description: Total amount of credit that has been applied to the customer's accounts receivable + totalDiscount: + type: number + format: decimal + description: Any discounts applied to the credit note amount. + subTotal: + type: number + format: decimal + description: 'Value of the credit note, including discounts and excluding tax.' + additionalTaxAmount: + type: number + format: decimal + description: Additional tax amount applied to credit note. + additionalTaxPercentage: + type: number + format: decimal + description: Percentage rate of any additional tax applied to the credit note. + totalTaxAmount: + type: number + format: decimal + description: Any tax applied to the credit note amount. + discountPercentage: + type: number + format: decimal + description: Percentage rate (from 0 to 100) of discounts applied to the credit note. + remainingCredit: + type: number + format: decimal + description: Unused balance of totalAmount originally raised. + status: + $ref: '#/components/schemas/AccountingCreditNote/definitions/creditNoteStatus' + description: Current state of the credit note. + issueDate: + $ref: '#/components/schemas/DateTime' + description: Date of the credit note as recorded in the accounting system. + allocatedOnDate: + $ref: '#/components/schemas/DateTime' + description: Date on which the credit note was fully allocated. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the credit note. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingCreditNote/definitions/creditNoteLineItem' + paymentAllocations: + type: array + nullable: true + description: An array of payment allocations. + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + note: + type: string + nullable: true + description: 'Any additional information about the credit note. Where possible, Codat links to a data field in the accounting software that is publicly available. This means that the contents of the note field are included when a credit note is emailed from the accounting software to the customer.' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - totalAmount + - totalDiscount + - subTotal + - totalTaxAmount + - discountPercentage + - remainingCredit + - status + definitions: + creditNoteStatus: + title: Credit note status + description: Current state of the credit note. + type: string + enum: + - Unknown + - Draft + - Submitted + - Paid + - Void + - PartiallyPaid + creditNoteLineItem: + type: object + properties: + description: + type: string + nullable: true + description: 'Friendly name of each line item. For example, the goods or service for which credit has been issued.' + unitAmount: + type: number + format: decimal + description: Unit price of the goods or service. + quantity: + type: number + format: decimal + description: Number of units of the goods or service for which credit has been issued. + discountAmount: + type: number + format: decimal + nullable: true + description: Value of any discounts applied. + subTotal: + type: number + format: decimal + nullable: true + description: 'Amount of credit associated with the line item, including discounts but excluding tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: Amount of tax associated with the line item. + totalAmount: + type: number + format: decimal + nullable: true + description: 'Total amount of the line item, including discounts and tax.' + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Reference to the account to which the line item is linked. + discountPercentage: + type: number + format: decimal + nullable: true + description: Percentage rate of any discount applied to the line item. + taxRateRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/taxRateRef' + description: Reference to the tax rate to which the line item is linked. + itemRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/itemRef' + description: Reference to the item the line is linked to. + trackingCategoryRefs: + type: array + nullable: true + deprecated: true + description: Reference to the tracking categories to which the line item is linked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + tracking: + $ref: '#/components/schemas/AccountsReceivableTracking' + isDirectIncome: + type: boolean + description: The credit note is a direct income if `True`. + required: + - unitAmount + - quantity + examples: + - - id: 0316bd24-8a01-4a3a-a0e5-a73f14ebcbec + creditNoteNumber: '5239277' + customerRef: + id: b5511228-b9ef-4713-91b1-ad2cf60eadb1 + companyName: Tool Hire Company + totalAmount: 550 + totalDiscount: 0 + subTotal: 0 + totalTaxAmount: 0 + discountPercentage: 0 + remainingCredit: 550 + status: Submitted + issueDate: '2018-03-28T21:28:58.249Z' + allocatedOnDate: null + note: More information available on request. + currency: USD + currencyRate: null + lineItems: + - description: Anvil10000Lb + unitAmount: 50 + quantity: 10 + discountAmount: 0 + subTotal: 500 + taxAmount: 50 + totalAmount: 550 + accountRef: + id: 3f267b10-757d-44c0-bef9-20f70cc8fbe3 + name: null + discountPercentage: null + taxRateRef: + id: 6c88aff3-7cb9-4980-a3d3-443e72e02498 + name: null + itemRef: + id: '1' + name: null + paymentAllocations: [] + modifiedDate: null + sourceModifiedDate: null + AccountingCreditNotes: + title: 'Accounting: Credit notes' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingCreditNote' + - $ref: '#/components/schemas/PagingInfo' + AccountingCustomer: + title: 'Accounting: Customer' + description: | + ## Overview + + A customer is a person or organisation that buys goods or services. From the Customers endpoints, you can retrieve a [list of all the customers of a company](https://api.codat.io/swagger/index.html#/Customers/get_companies__companyId__data_customers). + + Customers' data links to accounts receivable [invoices](https://docs.codat.io/lending-api#/schemas/Invoice). + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the customer, unique to the company in the accounting software.' + customerName: + type: string + nullable: true + description: 'Name of the customer as recorded in the accounting system, typically the company name.' + contactName: + type: string + nullable: true + description: Name of the main contact for the identified customer. + emailAddress: + type: string + nullable: true + description: Email address the customer can be contacted by. + defaultCurrency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Default currency the transactional data of the customer is recorded in. + phone: + type: string + nullable: true + description: Phone number the customer can be contacted by. + addresses: + type: array + nullable: true + description: An array of Addresses. + items: + $ref: '#/components/schemas/AccountingAddress' + contacts: + type: array + nullable: true + description: An array of Contacts. + items: + $ref: '#/components/schemas/AccountingCustomer/definitions/contact' + registrationNumber: + type: string + nullable: true + description: 'Company number. In the UK, this is typically the Companies House company registration number.' + taxNumber: + type: string + nullable: true + description: Company tax number. + status: + $ref: '#/components/schemas/AccountingCustomer/definitions/customerStatus' + description: Current state of the customer. + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - status + definitions: + accountingCustomerRef: + type: object + properties: + id: + minLength: 1 + type: string + description: '`id` from the Customers data type' + companyName: + type: string + nullable: true + description: '`customerName` from the Customer data type' + required: + - id + customerStatus: + description: Status of customer. + type: string + enum: + - Unknown + - Active + - Archived + contact: + type: object + properties: + name: + type: string + nullable: true + description: Name of a contact for a customer. + email: + type: string + nullable: true + description: Email of a contact for a customer. + phone: + type: array + nullable: true + description: An array of Phone numbers. + items: + $ref: '#/components/schemas/PhoneNumber' + address: + $ref: '#/components/schemas/AccountingAddress' + description: An object of Address information. + status: + $ref: '#/components/schemas/AccountingCustomer/definitions/customerStatus' + modifiedDate: + $ref: '#/components/schemas/DateTime' + required: + - status + AccountingCustomers: + title: 'Accounting: Customers' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingCustomer' + - $ref: '#/components/schemas/PagingInfo' + AccountingDirectCost: + title: 'Accounting: Direct cost' 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. + > **Language tip:** Direct costs may also be referred to as **Spend transactions**, **Spend money transactions**, or **Payments** in various accounting software. - > ### 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' - responses: - '201': - 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' - '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' - '409': - description: Conflict - content: - application/json: - schema: - type: array - items: - oneOf: - - $ref: '#/components/schemas/SourceAccountV2BatchCreateResponse' - - $ref: '#/components/schemas/SourceAccountBatchCreateResponse' - - $ref: '#/components/schemas/SourceAccountBatchErrorResponse' - '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 - 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. + ## Overview + + Direct costs are money that leave the business without impacting Accounts Payable, and refunds associated with such transactions. + + Direct costs include: + * Purchasing an item and paying it off at the point of the purchase + * Receiving cash from a refunded item if the refund is made by the supplier + + Direct costs is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction). + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier of the direct cost, unique for the company.' + - $ref: '#/components/schemas/AccountingDirectCost/definitions/directCostPrototype' + - properties: + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + directCostPrototype: + type: object + properties: + reference: + type: string + nullable: true + description: User-friendly reference for the direct cost. + note: + type: string + nullable: true + description: A note attached to the direct cost. + contactRef: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine/properties/contactRef' + description: A customer or supplier associated with the direct cost. + issueDate: + $ref: '#/components/schemas/DateTime' + description: Date of the direct cost as recorded in the accounting software.Date of the direct cost as recorded in the accounting software. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the direct cost. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + description: An array of line items. + items: + $ref: '#/components/schemas/AccountingDirectCost/definitions/directCostLineItem' + paymentAllocations: + type: array + description: An array of payment allocations. + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + subTotal: + type: number + format: decimal + description: 'The total amount of the direct costs, excluding any taxes.' + taxAmount: + type: number + format: decimal + description: The total amount of tax on the direct costs. + totalAmount: + type: number + format: decimal + description: 'The amount of the direct costs, inclusive of tax.' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + required: + - issueDate + - currency + - lineItems + - paymentAllocations + - subTotal + - taxAmount + - totalAmount + directCostLineItem: + type: object + properties: + description: + type: string + nullable: true + description: Friendly name of the goods or services. + unitAmount: + type: number + format: decimal + description: |- + Price of each unit of goods or services. + Note: If the platform does not provide this information, the unit amount will be mapped to the total amount. + quantity: + type: number + format: decimal + description: |- + Number of units of goods or services received. + + Note: If the platform does not provide this information, the quantity will be mapped as 1. + discountAmount: + type: number + format: decimal + nullable: true + description: Discount amount for the line before tax. + discountPercentage: + type: number + format: decimal + nullable: true + description: Discount percentage for the line before tax. + subTotal: + type: number + format: decimal + nullable: true + description: 'Amount of the line, inclusive of discounts but exclusive of tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: Amount of tax for the line. + totalAmount: + type: number + format: decimal + nullable: true + description: 'Total amount of the line, including tax.' + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Reference to the account to which the line item is linked. + taxRateRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/taxRateRef' + description: Reference to the tax rate to which the the line item is linked. + itemRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/itemRef' + description: 'Reference to the product, service type, or inventory item to which the direct cost is linked.' + trackingCategoryRefs: + type: array + nullable: true + deprecated: true + description: Collection of categories against which this direct cost is tracked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + tracking: + $ref: '#/components/schemas/AccountingDirectCost/definitions/tracking' + required: + - unitAmount + - quantity + tracking: + title: Invoiceable tracking + required: + - recordRefs + type: object + properties: + recordRefs: + type: array + items: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine/properties/tracking/definitions/trackingRecordRef' + invoiceTo: + $ref: '#/components/schemas/AccountingRecordRef' + additionalProperties: false + invoiceTo: + type: object + title: Invoice to + description: Links to the customer the direct cost is associated. + properties: + id: + type: string + description: '''id'' of the underlying record or data type.' + dataType: + type: string + description: Name of underlying data type. + enum: + - customers + example: customers + AccountingDirectCosts: + title: 'Accounting: Direct costs' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingDirectCost' + - $ref: '#/components/schemas/PagingInfo' + AccountingDirectIncome: + title: 'Accounting: Direct income' + description: "> **Language tip:** Direct incomes may also be referred to as **Receive transactions**, **Receive money transactions**, **Sales receipts**, or **Cash sales** in various accounting software.\n\n## Overview\n\nDirect incomes are incomes received directly from the business' operations. For example, cash sales of items to a customer, referral commissions, and service fee refunds are considered direct incomes made at the point of sale.\n\nDirect incomes include: \n\n- Selling an item directly to a contact, and receiving payment at the point of the sale.\n- Refunding an item sold at the point of sale in cash to a contact.\n\nDirect incomes is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).\n" + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier of the direct income, unique for the company.' + reference: + type: string + nullable: true + description: User-friendly reference for the direct income. + note: + type: string + nullable: true + description: An optional note on the direct income that can be used to assign the direct income with a reference ID in your application. + contactRef: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine/properties/contactRef' + description: A customer or supplier associated with the direct income. + issueDate: + $ref: '#/components/schemas/DateTime' + description: The date of the direct income as recorded in the accounting software. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency of the direct income. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + description: An array of line items. + items: + $ref: '#/components/schemas/AccountingDirectIncome/definitions/directIncomeLineItem' + paymentAllocations: + type: array + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + subTotal: + type: number + format: decimal + description: 'The total amount of the direct incomes, excluding any taxes.' + taxAmount: + type: number + format: decimal + description: The total amount of tax on the direct incomes. + totalAmount: + type: number + format: decimal + description: 'The amount of the direct incomes, inclusive of tax.' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - issueDate + - currency + - lineItems + - paymentAllocations + - subTotal + - taxAmount + - totalAmount + definitions: + directIncomeLineItem: + type: object + properties: + description: + type: string + nullable: true + description: A user-friendly name of the goods or services. + unitAmount: + type: number + format: decimal + description: |- + The price of each unit of goods or services. + Note: If the platform does not provide this information, the unit amount will be mapped to the total amount. + quantity: + type: number + format: decimal + description: |- + The number of units of goods or services received. + + Note: If the platform does not provide this information, the quantity will be mapped as 1. + discountAmount: + type: number + format: decimal + nullable: true + description: Discount amount for the line before tax. + discountPercentage: + type: number + format: decimal + nullable: true + description: Discount percentage for the line before tax. + subTotal: + type: number + format: decimal + nullable: true + description: 'The amount of the line, inclusive of discounts, but exclusive of tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: |- + The amount of tax for the line. + Note: If the platform does not provide this information, the quantity will be mapped as 0.00. + totalAmount: + type: number + format: decimal + nullable: true + description: 'The total amount of the line, including tax.' + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Reference to the account to which the line item is linked. + taxRateRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/taxRateRef' + description: Reference to the tax rate to which the line item is linked. + itemRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/itemRef' + description: 'Reference to the product, service type, or inventory item to which the direct cost is linked.' + trackingCategoryRefs: + type: array + nullable: true + description: An array of categories against which this direct cost is tracked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + required: + - unitAmount + - quantity + AccountingDirectIncomes: + title: 'Accounting: Direct incomes' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingDirectIncome' + - $ref: '#/components/schemas/PagingInfo' + AccountingInvoice: + title: 'Accounting: Invoice' + description: "> **Invoices or bills?**\n>\n> We distinguish between invoices where the company *owes money* vs. *is owed money*. If the company issued an invoice, and is owed money (accounts receivable) we call this an Invoice.\n>\n> See [Bills](https://docs.codat.io/lending-api#/schemas/Bill) for the accounts payable equivalent of bills.\n\n## Overview\n\nAn invoice is an itemized record of goods sold or services provided to a [customer](https://docs.codat.io/lending-api#/schemas/Customer).\n\nIn Codat, an invoice contains details of:\n\n- The timeline of the invoice—when it was raised, marked as paid, last edited, and so on.\n- How much the invoice is for, what portion of the invoice is tax or discounts, and what currency the amounts are represented in. \n- Who the invoice has been raised to; the _customer_.\n- The breakdown of what the invoice is for; the _line items_.\n- Any [payments](https://docs.codat.io/lending-api#/schemas/Payment) assigned to the invoice; the _payment allocations_.\n\n> **Invoice PDF downloads** \n>\n> You can download a PDF version of an invoice for supported integrations.\n> \n> The filename will be invoice-{number}.pdf.\n\n> **Referencing an invoice in Sage 50 and ClearBooks**\n>\n> In Sage 50 and ClearBooks, you may prefer to use the **invoiceNumber** to identify an invoice rather than the invoice **id**. Each time a draft invoice is submitted or printed, the draft **id** becomes void and a submitted invoice with a new **id** exists in its place. In both platforms, the **invoiceNumber** should remain the same." + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the invoice, unique to the company in the accounting software.' + invoiceNumber: + type: string + nullable: true + description: 'Friendly reference for the invoice. If available, this appears in the file name of invoice attachments.' + customerRef: + $ref: '#/components/schemas/AccountingCustomer/definitions/accountingCustomerRef' + description: Reference to the customer the invoice has been issued to. + salesOrderRefs: + type: array + nullable: true + description: List of references to related Sales orders. + items: + title: Sales order reference + type: object + properties: + id: + type: string + description: Unique identifier to a record in `dataType`. + dataType: + type: string + description: The underlying data type associated to the reference `id`. + enum: + - salesOrders + issueDate: + $ref: '#/components/schemas/DateTime' + description: Date of the invoice as recorded in the accounting system. + dueDate: + $ref: '#/components/schemas/DateTime' + description: Date the customer is due to be paid by. + paidOnDate: + $ref: '#/components/schemas/DateTime' + description: 'Date the invoice was marked as paid in the accounting system. If this field is not available from the accounting software, it is calculated by Codat using associated payments.' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the invoice. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + lineItems: + type: array + nullable: true + description: An array of line items. + items: + $ref: '#/components/schemas/AccountingInvoice/definitions/invoiceLineItem' + paymentAllocations: + type: array + nullable: true + description: An array of payment allocations. + items: + $ref: '#/components/schemas/AccountingPaymentAllocation' + withholdingTax: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingBill/allOf/0/properties/withholdingTax/items' + totalDiscount: + type: number + format: decimal + nullable: true + description: Numerical value of discounts applied to the invoice. + subTotal: + type: number + format: decimal + nullable: true + description: Total amount of the invoice excluding any taxes. + additionalTaxAmount: + type: number + format: decimal + description: Additional tax amount applied to invoice. + additionalTaxPercentage: + type: number + format: decimal + description: Percentage rate of any additional tax applied to the invoice. + totalTaxAmount: + type: number + format: decimal + description: Amount of tax on the invoice. + totalAmount: + type: number + format: decimal + description: 'Amount of the invoice, inclusive of tax.' + amountDue: + type: number + format: decimal + description: Amount outstanding on the invoice. + discountPercentage: + type: number + format: decimal + nullable: true + description: 'Percentage rate (from 0 to 100) of discounts applied to the invoice. For example: A 5% discount will return a value of `5`, not `0.05`.' + status: + $ref: '#/components/schemas/AccountingInvoice/definitions/invoiceStatus' + note: + type: string + nullable: true + description: 'Any additional information about the invoice. Where possible, Codat links to a data field in the accounting software that is publicly available. This means that the contents of the note field are included when an invoice is emailed from the accounting software to the customer.' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - issueDate + - totalTaxAmount + - totalAmount + - amountDue + - status + definitions: + invoiceLineItem: + type: object + properties: + description: + type: string + nullable: true + description: Friendly name of the goods or services provided. + unitAmount: + type: number + format: decimal + description: Price of each unit of goods or services. + quantity: + type: number + format: decimal + description: Number of units of goods or services provided. + discountAmount: + type: number + format: decimal + nullable: true + description: Numerical value of any discounts applied. + subTotal: + type: number + format: decimal + nullable: true + description: 'Amount of the line, inclusive of discounts but exclusive of tax.' + taxAmount: + type: number + format: decimal + nullable: true + description: Amount of tax for the line. + totalAmount: + type: number + format: decimal + nullable: true + description: 'Total amount of the line, including tax. When pushing invoices to Xero, the total amount is exclusive of tax to allow automatic calculations if a tax rate or tax amount is not specified.' + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Reference to the account to which the line item is linked. + discountPercentage: + type: number + format: decimal + nullable: true + description: Percentage rate (from 0 to 100) of any discounts applied to the unit amount. + taxRateRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/taxRateRef' + description: Reference to the tax rate to which the line item is linked. + itemRef: + $ref: '#/components/schemas/AccountingBillCreditNote/definitions/billCreditNoteLineItem/properties/itemRef' + description: Reference to the item the line is linked to. + trackingCategoryRefs: + type: array + nullable: true + description: Reference to the tracking categories to which the line item is linked. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + tracking: + $ref: '#/components/schemas/AccountsReceivableTracking' + isDirectIncome: + type: boolean + description: The invoice is a direct income if `True`. + required: + - unitAmount + - quantity + invoiceStatus: + type: string + enum: + - Unknown + - Draft + - Submitted + - PartiallyPaid + - Paid + - Void + description: |- + Current state of the invoice: - > ### 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 - requestBody: - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/SourceAccountV2/definitions/sourceAccountV2Prototype' - - $ref: '#/components/schemas/SourceAccount/definitions/sourceAccountPrototype' - 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: - value: - id: acc-002 - accountName: account-081 - sortCode: '123456' - accountType: Credit - accountNumber: '12345670' - currency: GBP - balance: 99.99 - modifiedDate: '2023-01-09T14:14:14.1057478Z' - responses: - '200': - description: Success - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/SourceAccountV2' - - $ref: '#/components/schemas/SourceAccount' - 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' - get: - 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 - responses: - '200': - description: Success - content: - application/json: - schema: - oneOf: - - $ref: '#/components/schemas/SourceAccountV2/definitions/sourceAccounts' - - $ref: '#/components/schemas/SourceAccount/definitions/sourceAccounts' - examples: {} - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - '/companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts/{accountId}': - patch: - 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' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/SourceAccount' - examples: {} - responses: - '200': - description: Success - content: - application/json: - x-speakeasy-usage-example: true - schema: - $ref: '#/components/schemas/SourceAccount' - 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' - delete: - tags: - - Source accounts - summary: Delete source account + - `Draft` - Invoice hasn't been submitted to the supplier. It may be in a pending state or is scheduled for future submission, for example by email. + - `Submitted` - Invoice is no longer a draft. It has been processed and, or, sent to the customer. In this state, it will impact the ledger. It also has no payments made against it, meaning `amountDue` will usually equal `totalAmount` (unless tax is witheld). + - `PartiallyPaid` - The balance paid against the invoice is positive, but less than the total invoice amount, meaning `0 < amountDue < totalAmount`. + - `Paid` - Invoice is paid in full. This includes if the invoice has been credited or overpaid, meaning `amountDue == 0`. + - `Void` - An invoice can become Void when it's deleted, refunded, written off, or cancelled. A voided invoice may still be PartiallyPaid, and so all outstanding amounts on voided invoices are removed from the accounts receivable account. + AccountingInvoices: + title: 'Accounting: Invoices' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingInvoice' + - $ref: '#/components/schemas/PagingInfo' + AccountingJournal: + title: 'Accounting: Journal' description: | - The _Delete source account_ endpoint enables you to remove a source account. + > **Language tip:** For line items, or individual transactions, of a company's financial documents, refer to the [Journal entries](https://docs.codat.io/lending-api#/schemas/JournalEntry) data type - 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' - 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' - '/companies/{companyId}/connections/{connectionId}/connectionInfo/bankFeedAccounts/credentials': - post: - 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: {} - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/BankAccountCredentials' - '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: - tags: - - Source accounts - summary: Delete all source account credentials - x-speakeasy-name-override: delete-credentials + ## Overview + + In accounting software, journals are used to record all the financial transactions of a company. Each transaction in a journal is represented by a separate [journal entry](https://docs.codat.io/lending-api#/schemas/JournalEntry). These entries are used to create the general ledger, which is then used to create the financial statements of a business. + + When a company records all their transactions in a single journal, it can become large and difficult to maintain and track. This is why large companies often use multiple journals (also known as subjournals) to categorize and manage journal entries. + + Such journals can be divided into two categories: + + - Special journals: journals used to record specific types of transactions; for example, a purchases journal, a sales journal, or a cash management journal. + - General journals: journals used to record transactions that fall outside the scope of the special journals. + + Multiple journals or subjournals are used in the following Codat integrations: + + - [Sage Intacct](https://docs.codat.io/integrations/accounting/sage-intacct/accounting-sage-intacct) (mandatory) + - [Exact Online](https://docs.codat.io/integrations/accounting/exact-online/accounting-exact-online) (mandatory) + - [Oracle NetSuite](https://docs.codat.io/integrations/accounting/netsuite/accounting-netsuite) (optional) + + > When pushing journal entries to an accounting software that doesn’t support multiple journals (multi-book accounting), the entries will be linked to the platform-generic journal. The Journals data type will only include one object. + type: object + allOf: + - type: object + properties: + id: + type: string + description: Journal ID. + - $ref: '#/components/schemas/AccountingJournal/definitions/journalPrototype' + - properties: + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + journalPrototype: + type: object + properties: + journalCode: + type: string + nullable: true + description: Native journal number or code. + name: + type: string + nullable: true + description: |- + Journal name. + The maximum length for a journal name is 256 characters. All characters above that number will be truncated. + type: + type: string + nullable: true + description: The type of the journal. + parentId: + type: string + nullable: true + description: |- + Parent journal ID. + If the journal is a parent journal, this value is not present. + hasChildren: + type: boolean + description: 'If the journal has child journals, this value is true. If it doesn’t, it is false.' + createdOn: + $ref: '#/components/schemas/DateTime' + description: Journal creation date. + status: + $ref: '#/components/schemas/AccountingJournal/definitions/journalStatus' + journalRef: + title: Journal reference + type: object + additionalProperties: false + description: Links journal entries to the relevant journal in accounting integrations that use multi-book accounting (multiple journals). + properties: + id: + minLength: 1 + type: string + description: GUID of the underlying journal. + name: + type: string + maxLength: 256 + nullable: true + description: Name of journal + required: + - id + journalStatus: + type: string + description: Current journal status. + enum: + - Unknown + - Active + - Archived + AccountingJournalEntries: + title: 'Accounting: Journal entries' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingJournalEntry' + - $ref: '#/components/schemas/PagingInfo' + AccountingJournalEntry: + title: 'Accounting: Journal entry' + description: "> **Language tip:** For the top-level record of a company's financial transactions, refer to the [Journals](https://docs.codat.io/lending-api#/schemas/Journal) data type\n\n## Overview\n\nA journal entry report shows the entries made in a company's general ledger, or [accounts](https://docs.codat.io/lending-api#/schemas/Account), when transactions are approved. The journal line items for each journal entry should balance.\n\nA journal entry line item is a single transaction line on the journal entry. For example: \n\n- When a journal entry is recording a receipt of cash, the credit to accounts receivable and the debit to cash are separate line items. \n- When a company needs to recognise revenue from an annual contract on a monthly basis, on receipt of cash for month one, they make a debit to deferred income and a credit to revenue.\n\nIn Codat a journal entry contains details of:\n\n- The date on which the entry was created and posted.\n- Itemised lines, including amounts and currency.\n- A reference to the associated accounts.\n- A reference to the underlying record. For example, the invoice, bill, or other data type that triggered the posting of the journal entry to the general ledger. \n\n> **Pushing journal entries** \n> Codat only supports journal entries in the base currency of the company that are pushed into accounts denominated in the same base currency." + type: object + allOf: + - type: object + properties: + id: + type: string + description: Unique identifier of the journal entry for the company in the accounting software. + description: + type: string + nullable: true + description: Optional description of the journal entry. + postedOn: + $ref: '#/components/schemas/DateTime' + description: |- + Date on which the journal entry was posted to the accounting software, and had an impact on the general ledger. This may be different from the creation date. + + For example, a user creates a journal entry on Monday and saves it as draft, which has no impact on the general ledger. On Thursday, they return to the entry and post it. + + The **createdOn** date shows as Monday. + The **postedOn** date shows as Thursday. + Journal entries can also be backdated, so the **postedOn** date may be earlier than the **createdOn** date. + createdOn: + $ref: '#/components/schemas/DateTime' + description: Date on which the journal was created in the accounting software. + updatedOn: + $ref: '#/components/schemas/DateTime' + description: Date on which the journal was last updated in the accounting software. + journalRef: + $ref: '#/components/schemas/AccountingJournal/definitions/journalRef' + journalLines: + type: array + nullable: true + description: An array of journal lines. + items: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine' + recordRef: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalEntryRecordRef' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + journalLine: + type: object + properties: + description: + type: string + nullable: true + description: Description of the journal line item. + netAmount: + type: number + format: decimal + description: 'Amount for the journal line. Debit entries are considered positive, and credit entries are considered negative.' + transactionAmount: + type: number + format: decimal + description: The amount in the original transaction currency. + currency: + type: string + nullable: true + description: Currency for the journal line item. + transactionCurrency: + type: string + nullable: true + description: Currency of the original transaction. + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + tracking: + description: 'List of record refs associated with the tracking information for the line (eg to a Tracking Category, or customer etc.)' + title: Tracking + type: object + properties: + recordRefs: + type: array + items: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine/properties/tracking/definitions/trackingRecordRef' + nullable: true + definitions: + trackingRecordRef: + type: object + title: Record reference + description: Links to the customer or tracking category. + properties: + id: + type: string + description: '''id'' of the underlying record or data type.' + dataType: + type: string + description: Name of underlying data type. + enum: + - customers + - suppliers + - trackingCategories + example: trackingCategories + contactRef: + title: Contact reference + type: object + properties: + id: + minLength: 1 + type: string + description: Unique identifier for a customer or supplier. + dataType: + type: string + nullable: true + description: Allowed name of the 'dataType'. + enum: + - customers + - suppliers + required: + - id + required: + - netAmount + journalEntryRecordRef: + type: object + title: Record reference + description: Links a journal entry to the underlying record that created it. + properties: + id: + type: string + description: '''id'' of the underlying record or data type.' + dataType: + type: string + description: Name of underlying data type. + enum: + - bankTransactions + - billCreditNotes + - billPayments + - bills + - creditNotes + - directCosts + - directIncomes + - invoices + - journalEntries + - payments + - transfers + example: transfers + AccountingJournals: + title: 'Accounting: Journals' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingJournal' + - $ref: '#/components/schemas/PagingInfo' + AccountingPayment: + title: 'Accounting: Payment' + description: "\uFEFF\x3E\x20\x2A\x2A\x50\x61\x79\x6D\x65\x6E\x74\x73\x20\x6F\x72\x20\x62\x69\x6C\x6C\x20\x70\x61\x79\x6D\x65\x6E\x74\x73\x3F\x2A\x2A\n\x3E\n\x3E\x20\x20\x49\x6E\x20\x43\x6F\x64\x61\x74\x2C\x20\x70\x61\x79\x6D\x65\x6E\x74\x73\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x20\x6F\x6E\x6C\x79\x2E\x20\x46\x6F\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x70\x61\x79\x61\x62\x6C\x65\x2C\x20\x73\x65\x65\x20\x5B\x62\x69\x6C\x6C\x20\x70\x61\x79\x6D\x65\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\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x42\x69\x6C\x6C\x50\x61\x79\x6D\x65\x6E\x74\x29\x2E\x20\x54\x68\x65\x73\x65\x20\x69\x6E\x63\x6C\x75\x64\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\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x42\x69\x6C\x6C\x29\x20\x61\x6E\x64\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x73\x20\x61\x67\x61\x69\x6E\x73\x74\x20\x62\x69\x6C\x6C\x73\x2E\n\n\x23\x23\x20\x4F\x76\x65\x72\x76\x69\x65\x77\n\n\x50\x61\x79\x6D\x65\x6E\x74\x73\x20\x69\x6E\x63\x6C\x75\x64\x65\x20\x61\x6C\x6C\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x20\x74\x72\x61\x6E\x73\x61\x63\x74\x69\x6F\x6E\x20\x64\x61\x74\x61\x2E\x20\x54\x68\x69\x73\x20\x69\x6E\x63\x6C\x75\x64\x65\x73\x20\x5B\x69\x6E\x76\x6F\x69\x63\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\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x49\x6E\x76\x6F\x69\x63\x65\x29\x20\x61\x6E\x64\x20\x5B\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\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\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\x29\x2E\n\n\x41\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x69\x6E\x20\x43\x6F\x64\x61\x74\x20\x75\x73\x75\x61\x6C\x6C\x79\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x6E\x20\x61\x6C\x6C\x6F\x63\x61\x74\x69\x6F\x6E\x20\x6F\x66\x20\x6D\x6F\x6E\x65\x79\x20\x77\x69\x74\x68\x69\x6E\x20\x61\x6E\x79\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x2E\x20\x54\x68\x69\x73\x20\x69\x6E\x63\x6C\x75\x64\x65\x73\x2C\x20\x62\x75\x74\x20\x69\x73\x20\x6E\x6F\x74\x20\x73\x74\x72\x69\x63\x74\x6C\x79\x20\x6C\x69\x6D\x69\x74\x65\x64\x20\x74\x6F\x3A\n\n\x2D\x20\x41\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6D\x61\x64\x65\x20\x61\x67\x61\x69\x6E\x73\x74\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\x2C\x20\x6C\x69\x6B\x65\x20\x61\x20\x63\x72\x65\x64\x69\x74\x20\x63\x61\x72\x64\x2C\x20\x63\x68\x65\x71\x75\x65\x2C\x20\x6F\x72\x20\x63\x61\x73\x68\x20\x70\x61\x79\x6D\x65\x6E\x74\x2E\n\x2D\x20\x41\x6E\x20\x61\x6C\x6C\x6F\x63\x61\x74\x69\x6F\x6E\x20\x6F\x66\x20\x61\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x27\x73\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x2C\x20\x65\x69\x74\x68\x65\x72\x20\x74\x6F\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x6F\x72\x20\x6D\x61\x79\x62\x65\x20\x61\x20\x72\x65\x66\x75\x6E\x64\x2E\n\x2D\x20\x41\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6D\x61\x64\x65\x20\x64\x69\x72\x65\x63\x74\x6C\x79\x20\x74\x6F\x20\x74\x68\x61\x74\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x2E\x20\x54\x68\x69\x73\x20\x6D\x69\x67\x68\x74\x20\x62\x65\x20\x61\x6E\x20\x6F\x76\x65\x72\x70\x61\x79\x6D\x65\x6E\x74\x20\x6F\x72\x20\x61\x20\x70\x72\x65\x70\x61\x79\x6D\x65\x6E\x74\x2E\x20\x49\x74\x20\x6D\x69\x67\x68\x74\x20\x61\x6C\x73\x6F\x20\x62\x65\x20\x74\x68\x65\x20\x72\x65\x66\x75\x6E\x64\x20\x6F\x66\x20\x61\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6D\x61\x64\x65\x20\x64\x69\x72\x65\x63\x74\x6C\x79\x20\x74\x6F\x20\x61\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x2E\n\n\x44\x65\x70\x65\x6E\x64\x69\x6E\x67\x20\x6F\x6E\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x73\x20\x61\x6C\x6C\x6F\x77\x65\x64\x20\x62\x79\x20\x74\x68\x65\x20\x75\x6E\x64\x65\x72\x6C\x79\x69\x6E\x67\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x73\x6F\x66\x74\x77\x61\x72\x65\x2C\x20\x73\x6F\x6D\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x74\x79\x70\x65\x73\x20\x6D\x61\x79\x20\x62\x65\x20\x63\x6F\x6D\x62\x69\x6E\x65\x64\x2E\x20\x50\x6C\x65\x61\x73\x65\x20\x73\x65\x65\x20\x74\x68\x65\x20\x65\x78\x61\x6D\x70\x6C\x65\x20\x66\x6F\x72\x20\x6D\x6F\x72\x65\x20\x64\x65\x74\x61\x69\x6C\x73\x2E\n\n\x49\x6E\x20\x43\x6F\x64\x61\x74\x2C\x20\x61\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x63\x6F\x6E\x74\x61\x69\x6E\x73\x20\x64\x65\x74\x61\x69\x6C\x73\x20\x6F\x66\x3A\n\n\x2D\x20\x57\x68\x65\x6E\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x77\x61\x73\x20\x72\x65\x63\x6F\x72\x64\x65\x64\x20\x69\x6E\x20\x74\x68\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x73\x79\x73\x74\x65\x6D\x2E\n\x2D\x20\x48\x6F\x77\x20\x6D\x75\x63\x68\x20\x69\x74\x20\x69\x73\x20\x66\x6F\x72\x20\x61\x6E\x64\x20\x69\x6E\x20\x77\x68\x61\x74\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x74\x68\x61\x74\x20\x61\x6D\x6F\x75\x6E\x74\x20\x69\x73\x20\x69\x6E\x2E\n\x2D\x20\x57\x68\x6F\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x77\x61\x73\x20\x5F\x70\x61\x69\x64\x20\x62\x79\x5F\x20\u2013\x20\x74\x68\x65\x20\x5F\x63\x75\x73\x74\x6F\x6D\x65\x72\x5F\x2E\n\x2D\x20\x54\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6D\x65\x74\x68\x6F\x64\x20\x75\x73\x65\x64\x2E\n\x2D\x20\x54\x68\x65\x20\x62\x72\x65\x61\x6B\x64\x6F\x77\x6E\x20\x6F\x66\x20\x74\x68\x65\x20\x74\x79\x70\x65\x73\x20\x6F\x66\x20\x70\x61\x79\x6D\x65\x6E\x74\x73\x20\u2013\x20\x74\x68\x65\x20\x5F\x6C\x69\x6E\x65\x20\x69\x74\x65\x6D\x73\x5F\x2E\n\n\x50\x61\x79\x6D\x65\x6E\x74\x73\x20\x69\x73\x20\x61\x20\x63\x68\x69\x6C\x64\x20\x64\x61\x74\x61\x20\x74\x79\x70\x65\x20\x6F\x66\x20\x5B\x61\x63\x63\x6F\x75\x6E\x74\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\x6C\x65\x6E\x64\x69\x6E\x67\x2D\x61\x70\x69\x23\x2F\x73\x63\x68\x65\x6D\x61\x73\x2F\x41\x63\x63\x6F\x75\x6E\x74\x54\x72\x61\x6E\x73\x61\x63\x74\x69\x6F\x6E\x29\x2E\n\n\x23\x23\x20\x50\x61\x79\x6D\x65\x6E\x74\x20\x74\x79\x70\x65\x73\n\n\x23\x23\x20\x50\x61\x79\x6D\x65\x6E\x74\x20\x6F\x66\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\n\n\x41\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x70\x61\x79\x69\x6E\x67\x20\x61\x20\x73\x69\x6E\x67\x6C\x65\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x68\x61\x73\x20\x6F\x6E\x65\x20\x65\x6E\x74\x72\x79\x20\x69\x6E\x20\x69\x74\x73\x20\x60\x6C\x69\x6E\x65\x73\x60\x20\x61\x72\x72\x61\x79\x2E\x20\x54\x68\x69\x73\x20\x2A\x2A\x6C\x69\x6E\x65\x2A\x2A\x20\x68\x61\x73\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x3A\n\n\x2D\x20\x41\x6E\x20\x5F\x61\x6D\x6F\x75\x6E\x74\x5F\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x61\x6D\x6F\x75\x6E\x74\x20\x6F\x66\x20\x74\x68\x65\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x74\x68\x61\x74\x20\x77\x61\x73\x20\x70\x61\x69\x64\x2E\x20\x54\x68\x69\x73\x20\x69\x73\x20\x61\x6C\x77\x61\x79\x73\x20\x70\x6F\x73\x69\x74\x69\x76\x65\x2E\n\x2D\x20\x41\x20\x2A\x2A\x6C\x69\x6E\x6B\x73\x2A\x2A\x20\x61\x72\x72\x61\x79\x20\x63\x6F\x6E\x74\x61\x69\x6E\x69\x6E\x67\x20\x6F\x6E\x65\x20\x65\x6C\x65\x6D\x65\x6E\x74\x20\x77\x69\x74\x68\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x3A\n\x20\x20\x20\x20\x2D\x20\x41\x20\x2A\x2A\x74\x79\x70\x65\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x74\x79\x70\x65\x20\x6F\x66\x20\x2A\x2A\x6C\x69\x6E\x6B\x2A\x2A\x2C\x20\x69\x6E\x20\x74\x68\x69\x73\x20\x63\x61\x73\x65\x20\x61\x6E\x20\x60\x49\x6E\x76\x6F\x69\x63\x65\x60\x2E\n\x20\x20\x20\x20\x2D\x20\x41\x6E\x20\x2A\x2A\x69\x64\x2A\x2A\x20\x74\x68\x61\x74\x20\x63\x6F\x6E\x74\x61\x69\x6E\x73\x20\x74\x68\x65\x20\x49\x44\x20\x6F\x66\x20\x74\x68\x65\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x74\x68\x61\x74\x20\x77\x61\x73\x20\x70\x61\x69\x64\x2E\n\x20\x20\x20\x20\x2D\x20\x41\x6E\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x66\x6F\x72\x20\x74\x68\x65\x20\x6C\x69\x6E\x6B\x2E\x20\x54\x68\x65\x20\x73\x75\x6D\x20\x6F\x66\x20\x74\x68\x65\x20\x2A\x2A\x6C\x69\x6E\x65\x2E\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x61\x6E\x64\x20\x74\x68\x65\x20\x2A\x2A\x6C\x69\x6E\x6B\x73\x2E\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x6D\x75\x73\x74\x20\x65\x71\x75\x61\x6C\x20\x60\x30\x60\x2E\n\n\x54\x68\x65\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x66\x69\x65\x6C\x64\x20\x6F\x6E\x20\x74\x68\x65\x20\x2A\x2A\x6C\x69\x6E\x65\x2A\x2A\x20\x65\x71\x75\x61\x6C\x73\x20\x74\x68\x65\x20\x2A\x2A\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x6F\x6E\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x2E\n\n\x23\x23\x20\x50\x61\x79\x6D\x65\x6E\x74\x20\x6F\x66\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x69\x6E\x76\x6F\x69\x63\x65\x73\n\n\x41\x20\x73\x69\x6E\x67\x6C\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x63\x61\x6E\x20\x70\x61\x79\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x69\x6E\x76\x6F\x69\x63\x65\x73\x2E\x20\x54\x68\x69\x73\x20\x63\x61\x6E\x20\x62\x65\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x65\x64\x20\x69\x6E\x20\x6F\x6E\x65\x20\x6F\x66\x20\x74\x77\x6F\x20\x66\x6F\x72\x6D\x61\x74\x73\x20\x64\x65\x70\x65\x6E\x64\x69\x6E\x67\x20\x6F\x6E\x20\x68\x6F\x77\x20\x74\x68\x65\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x20\x6B\x65\x65\x70\x73\x20\x74\x68\x65\x69\x72\x20\x62\x6F\x6F\x6B\x73\x3A\n\n\x2D\x20\x54\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x68\x61\x73\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x65\x6E\x74\x72\x69\x65\x73\x20\x69\x6E\x20\x69\x74\x73\x20\x2A\x2A\x6C\x69\x6E\x65\x73\x2A\x2A\x20\x61\x72\x72\x61\x79\x2C\x20\x6F\x6E\x65\x20\x66\x6F\x72\x20\x65\x61\x63\x68\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x74\x68\x61\x74\x20\x69\x73\x20\x70\x61\x69\x64\x2E\x20\x45\x61\x63\x68\x20\x6C\x69\x6E\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x73\x20\x74\x68\x65\x20\x65\x78\x61\x6D\x70\x6C\x65\x20\x61\x6E\x64\x20\x72\x75\x6C\x65\x73\x20\x64\x65\x73\x63\x72\x69\x62\x65\x64\x20\x69\x6E\x20\x5B\x50\x61\x79\x6D\x65\x6E\x74\x20\x6F\x66\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\x5D\x28\x23\x70\x61\x79\x6D\x65\x6E\x74\x2D\x6F\x66\x2D\x61\x6E\x2D\x69\x6E\x76\x6F\x69\x63\x65\x29\x2E\n\x2D\x20\x54\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x68\x61\x73\x20\x61\x20\x6C\x69\x6E\x65\x20\x77\x69\x74\x68\x20\x6D\x75\x6C\x74\x69\x70\x6C\x65\x20\x6C\x69\x6E\x6B\x73\x20\x74\x6F\x20\x65\x61\x63\x68\x20\x69\x6E\x76\x6F\x69\x63\x65\x2E\x20\x54\x68\x69\x73\x20\x6F\x63\x63\x75\x72\x73\x20\x77\x68\x65\x6E\x20\x74\x68\x65\x20\x70\x72\x6F\x70\x6F\x72\x74\x69\x6F\x6E\x20\x6F\x66\x20\x74\x68\x65\x20\x6F\x72\x69\x67\x69\x6E\x61\x6C\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x61\x6C\x6C\x6F\x63\x61\x74\x65\x64\x20\x74\x6F\x20\x65\x61\x63\x68\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x69\x73\x20\x6E\x6F\x74\x20\x61\x76\x61\x69\x6C\x61\x62\x6C\x65\x2E\n\n\x45\x61\x63\x68\x20\x2A\x2A\x6C\x69\x6E\x65\x2A\x2A\x20\x68\x61\x73\x20\x74\x68\x65\x20\x73\x61\x6D\x65\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x20\x61\x73\x20\x74\x68\x6F\x73\x65\x20\x64\x65\x73\x63\x72\x69\x62\x65\x64\x20\x69\x6E\x20\x5B\x50\x61\x79\x6D\x65\x6E\x74\x20\x6F\x66\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\x5D\x28\x23\x70\x61\x79\x6D\x65\x6E\x74\x2D\x6F\x66\x2D\x61\x6E\x2D\x69\x6E\x76\x6F\x69\x63\x65\x29\x2C\x20\x77\x69\x74\x68\x20\x74\x68\x65\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x69\x6E\x64\x69\x63\x61\x74\x69\x6E\x67\x20\x68\x6F\x77\x20\x6D\x75\x63\x68\x20\x6F\x66\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x77\x61\x73\x20\x61\x6C\x6C\x6F\x63\x61\x74\x65\x64\x20\x74\x6F\x20\x74\x68\x65\x20\x69\x6E\x76\x6F\x69\x63\x65\x2E\x20\x54\x68\x65\x20\x73\x75\x6D\x20\x6F\x66\x20\x6C\x69\x6E\x65\x20\x61\x6D\x6F\x75\x6E\x74\x73\x20\x65\x71\x75\x61\x6C\x73\x20\x74\x68\x65\x20\x2A\x2A\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x6F\x6E\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x2E\n\n\x23\x23\x20\x50\x61\x79\x6D\x65\x6E\x74\x73\x20\x61\x6E\x64\x20\x72\x65\x66\x75\x6E\x64\x73\x20\x6F\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\n\n\x41\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6F\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x2C\x20\x74\x68\x61\x74\x20\x69\x73\x20\x61\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x74\x68\x61\x74\x20\x64\x6F\x65\x73\x6E\u2019\x74\x20\x70\x61\x79\x20\x61\x20\x73\x70\x65\x63\x69\x66\x69\x63\x20\x69\x6E\x76\x6F\x69\x63\x65\x2C\x20\x68\x61\x73\x20\x6F\x6E\x65\x20\x65\x6E\x74\x72\x79\x20\x69\x6E\x20\x69\x74\x73\x20\x6C\x69\x6E\x65\x73\x20\x61\x72\x72\x61\x79\x2E\x20\x54\x68\x65\x20\x2A\x2A\x6C\x69\x6E\x65\x2A\x2A\x20\x68\x61\x73\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x3A\n\n\x2D\x20\x41\x20\x2A\x2A\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x61\x6D\x6F\x75\x6E\x74\x20\x70\x61\x69\x64\x20\x62\x79\x20\x61\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x20\x6F\x72\x20\x72\x65\x66\x75\x6E\x64\x65\x64\x20\x74\x6F\x20\x74\x68\x65\x6D\x20\x62\x79\x20\x61\x20\x63\x6F\x6D\x70\x61\x6E\x79\x2E\x20\x41\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x74\x6F\x20\x74\x68\x65\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x20\x69\x73\x20\x61\x6C\x77\x61\x79\x73\x20\x6E\x65\x67\x61\x74\x69\x76\x65\x2E\x20\x41\x20\x72\x65\x66\x75\x6E\x64\x20\x69\x73\x20\x61\x6C\x77\x61\x79\x73\x20\x70\x6F\x73\x69\x74\x69\x76\x65\x2E\n\x2D\x20\x41\x20\x2A\x2A\x6C\x69\x6E\x6B\x73\x2A\x2A\x20\x61\x72\x72\x61\x79\x20\x63\x6F\x6E\x74\x61\x69\x6E\x69\x6E\x67\x20\x6F\x6E\x65\x20\x65\x6C\x65\x6D\x65\x6E\x74\x20\x77\x69\x74\x68\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x3A\n\x2D\x20\x41\x20\x2A\x2A\x74\x79\x70\x65\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x74\x79\x70\x65\x20\x6F\x66\x20\x6C\x69\x6E\x6B\x2E\x20\x46\x6F\x72\x20\x61\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x74\x68\x69\x73\x20\x69\x73\x20\x60\x50\x61\x79\x6D\x65\x6E\x74\x4F\x6E\x41\x63\x63\x6F\x75\x6E\x74\x60\x2E\x20\x46\x6F\x72\x20\x61\x20\x72\x65\x66\x75\x6E\x64\x20\x74\x68\x69\x73\x20\x69\x73\x20\x60\x52\x65\x66\x75\x6E\x64\x60\x2E\n\x2D\x20\x54\x68\x65\x20\x2A\x2A\x69\x64\x2A\x2A\x20\x63\x6F\x6E\x74\x61\x69\x6E\x69\x6E\x67\x20\x74\x68\x65\x20\x49\x44\x20\x6F\x66\x20\x74\x68\x65\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x2E\n\x2D\x20\x54\x68\x65\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x66\x6F\x72\x20\x74\x68\x65\x20\x6C\x69\x6E\x6B\x20\x69\x73\x20\x60\x30\x60\x20\u2013\x20\x74\x68\x65\x20\x2A\x2A\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x5F\x6F\x72\x5F\x20\x74\x68\x65\x20\x61\x6D\x6F\x75\x6E\x74\x20\x6F\x66\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6F\x72\x20\x72\x65\x66\x75\x6E\x64\x2E\n\n\x49\x74\x20\x69\x73\x20\x70\x6F\x73\x73\x69\x62\x6C\x65\x20\x74\x6F\x20\x68\x61\x76\x65\x20\x61\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x74\x68\x61\x74\x20\x69\x73\x20\x70\x61\x72\x74\x20\x5F\x6F\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x5F\x20\x61\x6E\x64\x20\x70\x61\x72\x74\x20\x5F\x61\x6C\x6C\x6F\x63\x61\x74\x65\x64\x5F\x20\x74\x6F\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\x2E\x20\x45\x61\x63\x68\x20\x6C\x69\x6E\x65\x20\x73\x68\x6F\x75\x6C\x64\x20\x66\x6F\x6C\x6C\x6F\x77\x20\x74\x68\x65\x20\x65\x78\x61\x6D\x70\x6C\x65\x73\x20\x61\x62\x6F\x76\x65\x2E\n\n\x23\x23\x20\x55\x73\x69\x6E\x67\x20\x61\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x20\x74\x6F\x20\x70\x61\x79\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\n\n\x54\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6F\x66\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x75\x73\x69\x6E\x67\x20\x61\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x20\x68\x61\x73\x20\x6F\x6E\x65\x20\x65\x6E\x74\x72\x79\x20\x69\x6E\x20\x69\x74\x73\x20\x2A\x2A\x6C\x69\x6E\x65\x73\x2A\x2A\x20\x61\x72\x72\x61\x79\x2E\x20\x54\x68\x69\x73\x20\x2A\x2A\x6C\x69\x6E\x65\x2A\x2A\x20\x68\x61\x73\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x3A\n\n\x2D\x20\x41\x6E\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x61\x6D\x6F\x75\x6E\x74\x20\x6F\x66\x20\x6D\x6F\x6E\x65\x79\x20\x6D\x6F\x76\x65\x64\x2C\x20\x77\x68\x69\x63\x68\x20\x69\x6E\x20\x74\x68\x69\x73\x20\x63\x61\x73\x65\x20\x69\x73\x20\x60\x30\x60\x2C\x20\x61\x73\x20\x74\x68\x65\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x20\x61\x6E\x64\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x61\x6C\x6C\x6F\x63\x61\x74\x69\x6F\x6E\x20\x6D\x75\x73\x74\x20\x62\x61\x6C\x61\x6E\x63\x65\x20\x65\x61\x63\x68\x20\x6F\x74\x68\x65\x72\x2E\n\x2D\x20\x41\x20\x2A\x2A\x6C\x69\x6E\x6B\x73\x2A\x2A\x20\x61\x72\x72\x61\x79\x20\x63\x6F\x6E\x74\x61\x69\x6E\x69\x6E\x67\x20\x74\x77\x6F\x20\x65\x6C\x65\x6D\x65\x6E\x74\x73\x3A\n\x20\x20\x20\x20\x2D\x20\x54\x68\x65\x20\x66\x69\x72\x73\x74\x20\x2A\x2A\x6C\x69\x6E\x6B\x2A\x2A\x20\x68\x61\x73\x3A\n\x20\x20\x20\x20\x20\x20\x20\x20\x2D\x20\x41\x20\x2A\x2A\x74\x79\x70\x65\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x74\x79\x70\x65\x20\x6F\x66\x20\x2A\x2A\x6C\x69\x6E\x6B\x2A\x2A\x2C\x20\x69\x6E\x20\x74\x68\x69\x73\x20\x63\x61\x73\x65\x20\x61\x6E\x20\x60\x49\x6E\x76\x6F\x69\x63\x65\x60\x2E\n\x20\x20\x20\x20\x20\x20\x20\x20\x2D\x20\x41\x6E\x20\x2A\x2A\x69\x64\x2A\x2A\x20\x74\x68\x61\x74\x20\x63\x6F\x6E\x74\x61\x69\x6E\x73\x20\x74\x68\x65\x20\x49\x44\x20\x6F\x66\x20\x74\x68\x65\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x74\x68\x61\x74\x20\x77\x61\x73\x20\x70\x61\x69\x64\x2E\n\x20\x20\x20\x20\x2D\x20\x54\x68\x65\x20\x73\x65\x63\x6F\x6E\x64\x20\x2A\x2A\x6C\x69\x6E\x6B\x2A\x2A\x20\x68\x61\x73\x3A\n\x20\x20\x20\x20\x20\x20\x20\x20\x2D\x20\x41\x20\x2A\x2A\x74\x79\x70\x65\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x74\x79\x70\x65\x20\x6F\x66\x20\x2A\x2A\x6C\x69\x6E\x6B\x2A\x2A\x2C\x20\x69\x6E\x20\x74\x68\x69\x73\x20\x63\x61\x73\x65\x20\x61\x20\x60\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\x60\x2E\n\x20\x20\x20\x20\x20\x20\x20\x20\x2D\x20\x41\x6E\x20\x2A\x2A\x69\x64\x2A\x2A\x20\x74\x68\x61\x74\x20\x63\x6F\x6E\x74\x61\x69\x6E\x73\x20\x74\x68\x65\x20\x49\x44\x20\x6F\x66\x20\x74\x68\x65\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x20\x75\x73\x65\x64\x20\x62\x79\x20\x74\x68\x69\x73\x20\x70\x61\x79\x6D\x65\x6E\x74\x2E\n\n\x54\x68\x65\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x66\x69\x65\x6C\x64\x20\x6F\x6E\x20\x74\x68\x65\x20\x2A\x2A\x6C\x69\x6E\x65\x2A\x2A\x20\x65\x71\x75\x61\x6C\x73\x20\x74\x68\x65\x20\x2A\x2A\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x6F\x6E\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x2E\n\n\x23\x23\x20\x52\x65\x66\x75\x6E\x64\x69\x6E\x67\x20\x61\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\n\n\x41\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x72\x65\x66\x75\x6E\x64\x69\x6E\x67\x20\x61\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x20\x68\x61\x73\x20\x6F\x6E\x65\x20\x65\x6E\x74\x72\x79\x20\x69\x6E\x20\x69\x74\x73\x20\x2A\x2A\x6C\x69\x6E\x65\x73\x2A\x2A\x20\x61\x72\x72\x61\x79\x2E\x20\x54\x68\x69\x73\x20\x2A\x2A\x6C\x69\x6E\x65\x2A\x2A\x20\x68\x61\x73\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x3A\n\n\x2D\x20\x41\x6E\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x61\x6D\x6F\x75\x6E\x74\x20\x6F\x66\x20\x74\x68\x65\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x20\x74\x68\x61\x74\x20\x77\x61\x73\x20\x72\x65\x66\x75\x6E\x64\x65\x64\x2E\x20\x54\x68\x69\x73\x20\x69\x73\x20\x61\x6C\x77\x61\x79\x73\x20\x6E\x65\x67\x61\x74\x69\x76\x65\x20\x66\x6F\x72\x20\x61\x20\x72\x65\x66\x75\x6E\x64\x2E\n\x2D\x20\x41\x20\x2A\x2A\x6C\x69\x6E\x6B\x73\x2A\x2A\x20\x61\x72\x72\x61\x79\x20\x74\x68\x61\x74\x20\x63\x6F\x6E\x74\x61\x69\x6E\x73\x20\x6F\x6E\x65\x20\x65\x6C\x65\x6D\x65\x6E\x74\x20\x77\x69\x74\x68\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x3A\n\x20\x20\x20\x20\x2D\x20\x41\x20\x2A\x2A\x74\x79\x70\x65\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x74\x79\x70\x65\x20\x6F\x66\x20\x2A\x2A\x6C\x69\x6E\x6B\x2A\x2A\x2C\x20\x69\x6E\x20\x74\x68\x69\x73\x20\x63\x61\x73\x65\x20\x61\x20\x60\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\x60\x2E\n\x20\x20\x20\x20\x2D\x20\x41\x6E\x20\x2A\x2A\x69\x64\x2A\x2A\x20\x74\x68\x61\x74\x20\x63\x6F\x6E\x74\x61\x69\x6E\x73\x20\x74\x68\x65\x20\x49\x44\x20\x6F\x66\x20\x74\x68\x65\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x20\x74\x68\x61\x74\x20\x77\x61\x73\x20\x72\x65\x66\x75\x6E\x64\x65\x64\x2E\n\n\x54\x68\x65\x20\x2A\x2A\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x66\x69\x65\x6C\x64\x20\x6F\x6E\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x65\x71\x75\x61\x6C\x73\x20\x74\x68\x65\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x66\x69\x65\x6C\x64\x20\x6F\x66\x20\x74\x68\x65\x20\x2A\x2A\x6C\x69\x6E\x65\x2A\x2A\x2E\x20\x54\x68\x65\x73\x65\x20\x61\x72\x65\x20\x62\x6F\x74\x68\x20\x6E\x65\x67\x61\x74\x69\x76\x65\x2C\x20\x61\x73\x20\x74\x68\x69\x73\x20\x69\x73\x20\x6D\x6F\x6E\x65\x79\x20\x6C\x65\x61\x76\x69\x6E\x67\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x2E\n\n\x23\x23\x20\x52\x65\x66\x75\x6E\x64\x69\x6E\x67\x20\x61\x20\x70\x61\x79\x6D\x65\x6E\x74\n\n\x49\x66\x20\x61\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x69\x73\x20\x72\x65\x66\x75\x6E\x64\x65\x64\x2C\x20\x66\x6F\x72\x20\x65\x78\x61\x6D\x70\x6C\x65\x2C\x20\x69\x66\x20\x61\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x20\x6F\x76\x65\x72\x70\x61\x69\x64\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x61\x6E\x64\x20\x74\x68\x65\x20\x6F\x76\x65\x72\x70\x61\x79\x6D\x65\x6E\x74\x20\x69\x73\x20\x72\x65\x74\x75\x72\x6E\x65\x64\x20\x74\x6F\x20\x74\x68\x65\x20\x63\x75\x73\x74\x6F\x6D\x65\x72\x2C\x20\x74\x68\x65\x72\x65\x20\x61\x72\x65\x20\x74\x77\x6F\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x72\x65\x63\x6F\x72\x64\x73\x3A\n\n\x2D\x20\x4F\x6E\x65\x20\x66\x6F\x72\x20\x74\x68\x65\x20\x69\x6E\x63\x6F\x6D\x69\x6E\x67\x20\x6F\x76\x65\x72\x20\x70\x61\x79\x6D\x65\x6E\x74\x2E\n\x2D\x20\x41\x6E\x6F\x74\x68\x65\x72\x20\x66\x6F\x72\x20\x74\x68\x65\x20\x6F\x75\x74\x67\x6F\x69\x6E\x67\x20\x72\x65\x66\x75\x6E\x64\x2E\n\n\x54\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x69\x73\x73\x75\x69\x6E\x67\x20\x74\x68\x65\x20\x72\x65\x66\x75\x6E\x64\x20\x68\x61\x73\x20\x61\x20\x6E\x65\x67\x61\x74\x69\x76\x65\x20\x2A\x2A\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\x2A\x2A\x2E\x20\x54\x68\x69\x73\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x61\x6C\x73\x6F\x20\x68\x61\x73\x20\x6F\x6E\x65\x20\x65\x6E\x74\x72\x79\x20\x69\x6E\x20\x69\x74\x73\x20\x6C\x69\x6E\x65\x73\x20\x61\x72\x72\x61\x79\x20\x77\x69\x74\x68\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x3A\n\n\x2D\x20\x41\x6E\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x61\x6D\x6F\x75\x6E\x74\x20\x74\x68\x61\x74\x20\x77\x61\x73\x20\x72\x65\x66\x75\x6E\x64\x65\x64\x2E\x20\x54\x68\x69\x73\x20\x69\x73\x20\x61\x6C\x77\x61\x79\x73\x20\x6E\x65\x67\x61\x74\x69\x76\x65\x2E\n\x2D\x20\x41\x20\x2A\x2A\x6C\x69\x6E\x6B\x73\x2A\x2A\x20\x61\x72\x72\x61\x79\x20\x74\x68\x61\x74\x20\x63\x6F\x6E\x74\x61\x69\x6E\x73\x20\x6F\x6E\x65\x20\x65\x6C\x65\x6D\x65\x6E\x74\x20\x77\x69\x74\x68\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x3A\n\x20\x20\x20\x20\x2D\x20\x41\x20\x2A\x2A\x74\x79\x70\x65\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x74\x79\x70\x65\x20\x6F\x66\x20\x2A\x2A\x6C\x69\x6E\x6B\x2A\x2A\x2C\x20\x69\x6E\x20\x74\x68\x69\x73\x20\x63\x61\x73\x65\x20\x61\x20\x60\x50\x61\x79\x6D\x65\x6E\x74\x60\x2E\n\x20\x20\x20\x20\x2D\x20\x41\x6E\x20\x2A\x2A\x69\x64\x2A\x2A\x20\x74\x68\x61\x74\x20\x63\x6F\x6E\x74\x61\x69\x6E\x73\x20\x74\x68\x65\x20\x49\x44\x20\x6F\x66\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x74\x68\x61\x74\x20\x77\x61\x73\x20\x72\x65\x66\x75\x6E\x64\x65\x64\x2E\n\n\x54\x68\x65\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x66\x69\x65\x6C\x64\x20\x6F\x6E\x20\x74\x68\x65\x20\x2A\x2A\x6C\x69\x6E\x65\x2A\x2A\x20\x65\x71\x75\x61\x6C\x73\x20\x74\x68\x65\x20\x2A\x2A\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x6F\x6E\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x61\x6E\x64\x20\x69\x73\x20\x6E\x65\x67\x61\x74\x69\x76\x65\x2C\x20\x61\x73\x20\x74\x68\x69\x73\x20\x69\x73\x20\x6D\x6F\x6E\x65\x79\x20\x6C\x65\x61\x76\x69\x6E\x67\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x2E\n\n\x54\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x74\x68\x61\x74\x20\x77\x61\x73\x20\x72\x65\x66\x75\x6E\x64\x65\x64\x20\x68\x61\x73\x20\x61\x20\x6C\x69\x6E\x65\x20\x77\x68\x65\x72\x65\x20\x74\x68\x65\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x69\x73\x20\x70\x6F\x73\x69\x74\x69\x76\x65\x20\x61\x6E\x64\x20\x74\x68\x65\x20\x74\x79\x70\x65\x20\x6F\x66\x20\x74\x68\x65\x20\x6C\x69\x6E\x6B\x20\x69\x73\x20\x60\x52\x65\x66\x75\x6E\x64\x60\x2E\x20\x54\x68\x69\x73\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6D\x61\x79\x20\x68\x61\x76\x65\x20\x73\x65\x76\x65\x72\x61\x6C\x20\x65\x6E\x74\x72\x69\x65\x73\x20\x69\x6E\x20\x69\x74\x73\x20\x2A\x2A\x6C\x69\x6E\x65\x73\x2A\x2A\x20\x61\x72\x72\x61\x79\x20\x69\x66\x20\x69\x74\x20\x77\x61\x73\x20\x75\x73\x65\x64\x20\x74\x6F\x20\x70\x61\x72\x74\x6C\x79\x20\x70\x61\x79\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\x2E\n\n\x46\x6F\x72\x20\x65\x78\x61\x6D\x70\x6C\x65\x3A\x20\x41\x20\xA3\x31\x2C\x30\x35\x30\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6F\x6E\x20\x61\x20\xA3\x31\x2C\x30\x30\x30\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x77\x69\x74\x68\x20\x61\x20\x72\x65\x66\x75\x6E\x64\x20\x6F\x66\x20\xA3\x35\x30\x20\x68\x61\x73\x20\x74\x77\x6F\x20\x6C\x69\x6E\x65\x73\x3A\n\n\x2D\x20\x4F\x6E\x65\x20\x66\x6F\x72\x20\xA3\x31\x2C\x30\x30\x30\x20\x6C\x69\x6E\x6B\x65\x64\x20\x74\x6F\x20\x74\x68\x65\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x74\x68\x61\x74\x20\x77\x61\x73\x20\x70\x61\x69\x64\x2E\n\x2D\x20\x41\x6E\x6F\x74\x68\x65\x72\x20\x66\x6F\x72\x20\xA3\x35\x30\x20\x6C\x69\x6E\x6B\x65\x64\x20\x74\x6F\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x74\x68\x61\x74\x20\x72\x65\x66\x75\x6E\x64\x65\x64\x20\x74\x68\x65\x20\x6F\x76\x65\x72\x70\x61\x79\x6D\x65\x6E\x74\x20\x77\x69\x74\x68\x20\x61\x2A\x2A\x20\x74\x79\x70\x65\x2A\x2A\x20\x6F\x66\x20\x60\x52\x65\x66\x75\x6E\x64\x60\x20\x61\x6E\x64\x20\x61\x6E\x20\x49\x44\x20\x74\x68\x61\x74\x20\x63\x6F\x72\x72\x65\x73\x70\x6F\x6E\x64\x73\x20\x74\x6F\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x2E\n\n\x54\x68\x65\x20\x2A\x2A\x6C\x69\x6E\x65\x2A\x2A\x20\x6C\x69\x6E\x6B\x65\x64\x20\x74\x6F\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x68\x61\x73\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x3A\n\n\x2D\x20\x41\x6E\x20\x2A\x2A\x61\x6D\x6F\x75\x6E\x74\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x61\x6D\x6F\x75\x6E\x74\x20\x74\x68\x61\x74\x20\x77\x61\x73\x20\x72\x65\x66\x75\x6E\x64\x65\x64\x2E\x20\x54\x68\x69\x73\x20\x69\x73\x20\x70\x6F\x73\x69\x74\x69\x76\x65\x20\x61\x73\x20\x69\x74\x73\x20\x6D\x6F\x6E\x65\x79\x20\x74\x68\x61\x74\x20\x77\x61\x73\x20\x61\x64\x64\x65\x64\x20\x74\x6F\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x2E\x20\x49\x74\x27\x73\x20\x62\x61\x6C\x61\x6E\x63\x65\x64\x20\x6F\x75\x74\x20\x62\x79\x20\x74\x68\x65\x20\x6E\x65\x67\x61\x74\x69\x76\x65\x20\x61\x6D\x6F\x75\x6E\x74\x20\x6F\x66\x20\x74\x68\x65\x20\x72\x65\x66\x75\x6E\x64\x2E\n\x2D\x20\x41\x20\x2A\x2A\x6C\x69\x6E\x6B\x73\x2A\x2A\x20\x61\x72\x72\x61\x79\x20\x63\x6F\x6E\x74\x61\x69\x6E\x69\x6E\x67\x20\x6F\x6E\x65\x20\x65\x6C\x65\x6D\x65\x6E\x74\x20\x77\x69\x74\x68\x20\x74\x68\x65\x20\x66\x6F\x6C\x6C\x6F\x77\x69\x6E\x67\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x3A\n\x20\x20\x20\x20\x2D\x20\x41\x20\x2A\x2A\x74\x79\x70\x65\x2A\x2A\x20\x74\x68\x61\x74\x20\x69\x6E\x64\x69\x63\x61\x74\x65\x73\x20\x74\x68\x65\x20\x74\x79\x70\x65\x20\x6F\x66\x20\x2A\x2A\x6C\x69\x6E\x6B\x2A\x2A\x2C\x20\x69\x6E\x20\x74\x68\x69\x73\x20\x63\x61\x73\x65\x20\x61\x20\x60\x52\x65\x66\x75\x6E\x64\x60\x2E\n\x20\x20\x20\x20\x2D\x20\x41\x6E\x20\x2A\x2A\x69\x64\x2A\x2A\x20\x74\x68\x61\x74\x20\x63\x6F\x6E\x74\x61\x69\x6E\x73\x20\x74\x68\x65\x20\x49\x44\x20\x6F\x66\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x74\x68\x61\x74\x20\x72\x65\x66\x75\x6E\x64\x65\x64\x20\x74\x68\x69\x73\x20\x6C\x69\x6E\x65\x2E\n\n\x3E\x20\x2A\x2A\x53\x75\x70\x70\x6F\x72\x74\x20\x66\x6F\x72\x20\x6C\x69\x6E\x6B\x65\x64\x20\x70\x61\x79\x6D\x65\x6E\x74\x73\x2A\x2A\n\x3E\n\x3E\x20\x4E\x6F\x74\x20\x61\x6C\x6C\x20\x61\x63\x63\x6F\x75\x6E\x74\x69\x6E\x67\x20\x73\x6F\x66\x74\x77\x61\x72\x65\x20\x73\x75\x70\x70\x6F\x72\x74\x20\x6C\x69\x6E\x6B\x69\x6E\x67\x20\x70\x61\x79\x6D\x65\x6E\x74\x73\x20\x69\x6E\x20\x74\x68\x69\x73\x20\x77\x61\x79\x2E\x20\x49\x6E\x20\x73\x6F\x6D\x65\x20\x70\x6C\x61\x74\x66\x6F\x72\x6D\x73\x2C\x20\x79\x6F\x75\x20\x6D\x61\x79\x20\x73\x65\x65\x20\x61\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6F\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x61\x6E\x64\x20\x61\x20\x72\x65\x66\x75\x6E\x64\x20\x6F\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x2E\n\n\x23\x23\x20\x46\x6F\x72\x65\x69\x67\x6E\x20\x63\x75\x72\x72\x65\x6E\x63\x69\x65\x73\n\n\x54\x68\x65\x72\x65\x20\x61\x72\x65\x20\x74\x77\x6F\x20\x74\x79\x70\x65\x73\x20\x6F\x66\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x72\x61\x74\x65\x20\x74\x68\x61\x74\x20\x61\x72\x65\x20\x69\x6E\x63\x6C\x75\x64\x65\x64\x20\x69\x6E\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x73\x20\x64\x61\x74\x61\x20\x74\x79\x70\x65\x3A\n\n\x50\x61\x79\x6D\x65\x6E\x74\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x72\x61\x74\x65\x3A\n\n\x2D\x20\x42\x61\x73\x65\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x6F\x66\x20\x74\x68\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x2E\n\x2D\x20\x46\x6F\x72\x65\x69\x67\x6E\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x6F\x66\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x2E\n\n\x50\x61\x79\x6D\x65\x6E\x74\x20\x6C\x69\x6E\x65\x20\x6C\x69\x6E\x6B\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x72\x61\x74\x65\x3A\n\n\x2D\x20\x42\x61\x73\x65\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x6F\x66\x20\x74\x68\x65\x20\x69\x74\x65\x6D\x20\x74\x68\x65\x20\x6C\x69\x6E\x6B\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x2E\n\x2D\x20\x46\x6F\x72\x65\x69\x67\x6E\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x6F\x66\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x2E\n\n\x54\x68\x65\x73\x65\x20\x74\x77\x6F\x20\x72\x61\x74\x65\x73\x20\x61\x6C\x6C\x6F\x77\x20\x74\x68\x65\x20\x63\x61\x6C\x63\x75\x6C\x61\x74\x69\x6F\x6E\x20\x6F\x66\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x6C\x6F\x73\x73\x20\x6F\x72\x20\x67\x61\x69\x6E\x20\x66\x6F\x72\x20\x61\x6E\x79\x20\x6F\x66\x20\x74\x68\x65\x20\x74\x72\x61\x6E\x73\x61\x63\x74\x69\x6F\x6E\x73\x20\x61\x66\x66\x65\x63\x74\x65\x64\x20\x62\x79\x20\x74\x68\x65\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6C\x69\x6E\x65\x73\x2E\x20\x54\x68\x65\x20\x73\x65\x63\x6F\x6E\x64\x20\x72\x61\x74\x65\x20\x69\x73\x20\x75\x73\x65\x64\x20\x77\x68\x65\x6E\x20\x61\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x69\x73\x20\x61\x70\x70\x6C\x69\x65\x64\x20\x74\x6F\x20\x61\x6E\x20\x69\x74\x65\x6D\x20\x69\x6E\x20\x61\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x74\x68\x61\x74\x20\x64\x6F\x65\x73\x6E\x27\x74\x20\x6D\x61\x74\x63\x68\x20\x65\x69\x74\x68\x65\x72\x3A\n\n\x2D\x20\x54\x68\x65\x20\x62\x61\x73\x65\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x66\x6F\x72\x20\x74\x68\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\x2E\n\x2D\x20\x54\x68\x65\x20\x63\x75\x72\x72\x65\x6E\x63\x79\x20\x6F\x66\x20\x74\x68\x65\x20\x69\x74\x65\x6D\x2E\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x43\x75\x72\x72\x65\x6E\x63\x79\x20\x72\x61\x74\x65\x20\x65\x78\x61\x6D\x70\x6C\x65\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x3A\x20\"\x31\x32\x33\"\x2C\n\x20\x20\x20\x20\x20\x20\"\x6E\x6F\x74\x65\"\x3A\x20\"\"\x2C\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x39\x39\x2E\x39\x39\x2C\n\x20\x20\x20\x20\x20\x20\"\x63\x75\x72\x72\x65\x6E\x63\x79\"\x3A\x20\"\x47\x42\x50\"\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x39\x39\x2E\x39\x39\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x3A\x20\"\x31\x37\x38\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x2D\x35\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x63\x75\x72\x72\x65\x6E\x63\x79\x52\x61\x74\x65\"\x3A\x20\x20\x31\x2E\x39\x39\x39\x38\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x23\x23\x20\x45\x78\x61\x6D\x70\x6C\x65\x20\x64\x61\x74\x61\n\n\x3E\x20\x2A\x2A\x4F\x62\x6A\x65\x63\x74\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x2A\x2A\n\x3E\n\x3E\x20\x46\x6F\x72\x20\x74\x68\x65\x20\x73\x61\x6B\x65\x20\x6F\x66\x20\x62\x72\x65\x76\x69\x74\x79\x2C\x20\x74\x68\x65\x20\x65\x78\x61\x6D\x70\x6C\x65\x73\x20\x68\x65\x72\x65\x20\x6D\x61\x79\x20\x6F\x6D\x69\x74\x20\x70\x72\x6F\x70\x65\x72\x74\x69\x65\x73\x20\x66\x72\x6F\x6D\x20\x6F\x62\x6A\x65\x63\x74\x73\x2E\x20\x46\x6F\x72\x20\x74\x68\x65\x20\x66\x75\x6C\x6C\x20\x6F\x62\x6A\x65\x63\x74\x20\x64\x65\x66\x69\x6E\x69\x74\x69\x6F\x6E\x2C\x20\x73\x65\x65\x20\x5B\x50\x61\x79\x6D\x65\x6E\x74\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x61\x70\x69\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x73\x77\x61\x67\x67\x65\x72\x2F\x69\x6E\x64\x65\x78\x2E\x68\x74\x6D\x6C\x23\x2F\x50\x61\x79\x6D\x65\x6E\x74\x73\x29\x2E\n\n\x23\x23\x20\x53\x69\x6D\x70\x6C\x65\x20\x65\x78\x61\x6D\x70\x6C\x65\x73\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x50\x61\x79\x6D\x65\x6E\x74\x20\x66\x6F\x72\x20\x69\x6E\x76\x6F\x69\x63\x65\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x41\x6C\x6C\x6F\x63\x61\x74\x69\x6F\x6E\x20\x6F\x66\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x50\x61\x79\x6D\x65\x6E\x74\x20\x6F\x66\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x61\x6E\x64\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6F\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x32\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x50\x61\x79\x6D\x65\x6E\x74\x4F\x6E\x41\x63\x63\x6F\x75\x6E\x74\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x52\x65\x66\x75\x6E\x64\x20\x6F\x66\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x2D\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x52\x65\x66\x75\x6E\x64\x20\x6F\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x2D\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x50\x61\x79\x6D\x65\x6E\x74\x4F\x6E\x41\x63\x63\x6F\x75\x6E\x74\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x4C\x69\x6E\x6B\x65\x64\x20\x72\x65\x66\x75\x6E\x64\x20\x6F\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x73\x20\x72\x65\x63\x65\x69\x76\x61\x62\x6C\x65\x20\x61\x63\x63\x6F\x75\x6E\x74\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x70\x61\x79\x6D\x65\x6E\x74\x2D\x30\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x52\x65\x66\x75\x6E\x64\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x72\x65\x66\x75\x6E\x64\x2D\x30\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x72\x65\x66\x75\x6E\x64\x2D\x30\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x2D\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x50\x61\x79\x6D\x65\x6E\x74\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x70\x61\x79\x6D\x65\x6E\x74\x2D\x30\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x55\x73\x69\x6E\x67\x20\x61\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x20\x61\x6E\x64\x20\x63\x61\x73\x68\x20\x74\x6F\x20\x70\x61\x79\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x32\x35\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x2D\x37\x35\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\x20\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x3A\x20\"\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x37\x35\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x32\x35\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x2D\x32\x35\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x23\x23\x20\x43\x6F\x6D\x70\x6C\x65\x78\x20\x65\x78\x61\x6D\x70\x6C\x65\x73\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x55\x73\x65\x20\x74\x77\x6F\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x73\x20\x61\x6E\x64\x20\x31\x30\x30\x30\x20\x69\x6E\x20\x74\x6F\x20\"\x62\x61\x6E\x6B\"\x20\x28\x63\x61\x73\x68\x2C\x20\x63\x68\x65\x71\x75\x65\x20\x65\x74\x63\x2E\x29\x20\x74\x6F\x20\x70\x61\x79\x20\x69\x6E\x76\x6F\x69\x63\x65\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x7A\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x50\x61\x79\x20\x61\x6E\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x77\x69\x74\x68\x20\x74\x77\x6F\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x73\x20\x61\x6E\x64\x20\x63\x61\x73\x68\x2C\x20\x77\x69\x74\x68\x20\x31\x30\x30\x30\x20\x6C\x65\x66\x74\x20\x27\x6F\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x27\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x32\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x7A\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x50\x61\x79\x6D\x65\x6E\x74\x4F\x6E\x41\x63\x63\x6F\x75\x6E\x74\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x63\x75\x73\x74\x6F\x6D\x65\x72\x2D\x30\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x54\x77\x6F\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x73\x20\x70\x61\x79\x20\x74\x77\x6F\x20\x69\x6E\x76\x6F\x69\x63\x65\x73\x20\x77\x69\x74\x68\x20\x6E\x6F\x20\x61\x6C\x6C\x6F\x63\x61\x74\x69\x6F\x6E\x20\x61\x6D\x6F\x75\x6E\x74\x20\x73\x70\x65\x63\x69\x66\x69\x65\x64\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x77\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x7A\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x54\x77\x6F\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x73\x20\x61\x6E\x64\x20\x63\x61\x73\x68\x20\x70\x61\x79\x20\x74\x68\x72\x65\x65\x20\x69\x6E\x76\x6F\x69\x63\x65\x73\x20\x77\x69\x74\x68\x20\x6E\x6F\x20\x61\x6C\x6C\x6F\x63\x61\x74\x69\x6F\x6E\x20\x61\x6D\x6F\x75\x6E\x74\x20\x73\x70\x65\x63\x69\x66\x69\x65\x64\x2C\x20\x61\x6E\x64\x20\x72\x65\x66\x75\x6E\x64\x20\x63\x61\x73\x68\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x32\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x77\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x75\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x7A\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x52\x65\x66\x75\x6E\x64\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x72\x65\x66\x75\x6E\x64\x2D\x30\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x72\x65\x66\x75\x6E\x64\x2D\x30\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x2D\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x50\x61\x79\x6D\x65\x6E\x74\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x70\x61\x79\x6D\x65\x6E\x74\x2D\x30\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x49\x6E\x20\x74\x68\x69\x73\x20\x65\x78\x61\x6D\x70\x6C\x65\x2C\x20\x61\x20\x70\x61\x79\x6D\x65\x6E\x74\x20\x6F\x6E\x20\x61\x63\x63\x6F\x75\x6E\x74\x20\x69\x73\x20\x75\x73\x65\x64\x20\x74\x6F\x20\x70\x61\x79\x20\x74\x68\x65\x20\x73\x61\x6D\x65\x20\x69\x6E\x76\x6F\x69\x63\x65\x20\x69\x6E\x20\x4A\x61\x6E\x75\x61\x72\x79\x20\x61\x6E\x64\x20\x61\x67\x61\x69\x6E\x20\x69\x6E\x20\x46\x65\x62\x72\x75\x61\x72\x79\x2E\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x4A\x61\x6E\x75\x61\x72\x79\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x3A\x20\"\x30\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x35\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x64\x61\x74\x65\"\x20\x3A\x20\"\x31\x39\x30\x31\x2D\x30\x31\x2D\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\x2D\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x34\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x50\x61\x79\x6D\x65\x6E\x74\x4F\x6E\x41\x63\x63\x6F\x75\x6E\x74\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x50\x61\x79\x6D\x65\x6E\x74\x4F\x6E\x41\x63\x63\x6F\x75\x6E\x74\x2D\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x34\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x46\x65\x62\x72\x75\x61\x72\x79\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x3A\x20\"\x30\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x35\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x64\x61\x74\x65\"\x20\x3A\x20\"\x31\x39\x30\x31\x2D\x30\x32\x2D\x30\x31\"\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\x2D\x78\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x31\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\x2D\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x33\x30\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x20\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x20\x3A\x20\"\x50\x61\x79\x6D\x65\x6E\x74\x4F\x6E\x41\x63\x63\x6F\x75\x6E\x74\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x20\x3A\x20\"\x50\x61\x79\x6D\x65\x6E\x74\x4F\x6E\x41\x63\x63\x6F\x75\x6E\x74\x2D\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x20\x3A\x20\x2D\x33\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60\n\n\n\n\x20\x20\x60\x60\x60\x6A\x73\x6F\x6E\x20\x74\x69\x74\x6C\x65\x3D\"\x54\x77\x6F\x20\x63\x72\x65\x64\x69\x74\x20\x6E\x6F\x74\x65\x73\x20\x61\x6E\x64\x20\x73\x6F\x6D\x65\x20\x63\x61\x73\x68\x20\x70\x61\x79\x20\x74\x77\x6F\x20\x69\x6E\x76\x6F\x69\x63\x65\x73\x20\x77\x69\x74\x68\x20\x6E\x6F\x20\x61\x6C\x6C\x6F\x63\x61\x74\x69\x6F\x6E\x73\x20\x73\x70\x65\x63\x69\x66\x69\x65\x64\"\n\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\"\x74\x6F\x74\x61\x6C\x41\x6D\x6F\x75\x6E\x74\"\x3A\x20\x35\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x65\x73\"\x3A\x20\x5B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x35\x30\x30\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x6C\x69\x6E\x6B\x73\"\x3A\x20\x5B\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x3A\x20\"\x61\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x3A\x20\"\x49\x6E\x76\x6F\x69\x63\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x3A\x20\"\x62\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x2D\x31\x30\x30\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\x20\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x3A\x20\"\x79\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x37\x35\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\x2C\x7B\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x74\x79\x70\x65\"\x3A\x20\"\x43\x72\x65\x64\x69\x74\x4E\x6F\x74\x65\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x69\x64\"\x3A\x20\"\x7A\"\x2C\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\"\x61\x6D\x6F\x75\x6E\x74\"\x3A\x20\x37\x35\x30\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x20\x20\x20\x20\x20\x20\x20\x20\x7D\n\x20\x20\x20\x20\x20\x20\x5D\n\x20\x20\x7D\n\x20\x20\x60\x60\x60" + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the payment, unique to the company in the accounting software.' + customerRef: + $ref: '#/components/schemas/AccountingCustomer/definitions/accountingCustomerRef' + description: Customer the payment is recorded against in the accounting software. + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: Account the payment is recorded against in the accounting software. + paymentMethodRef: + $ref: '#/components/schemas/PaymentMethodRef' + description: The Payment Method to which the payment is linked in the accounting software. + totalAmount: + type: number + format: decimal + description: Amount of the payment in the payment currency. This value should never change and represents the amount of money paid into the customer's account. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: ISO currency code recorded for the payment in the accounting software. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + date: + $ref: '#/components/schemas/DateTime' + description: Date the payment was recorded in the accounting software. + note: + type: string + nullable: true + description: Any additional information associated with the payment. + lines: + type: array + nullable: true + description: An array of payment lines. + items: + $ref: '#/components/schemas/AccountingPayment/definitions/paymentLine' + reference: + type: string + nullable: true + description: Friendly reference for the payment. + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - date + definitions: + paymentLine: + title: Payment Line + type: object + properties: + amount: + type: number + format: decimal + description: Amount in the payment currency. + links: + type: array + nullable: true + items: + $ref: '#/components/schemas/AccountingPayment/definitions/paymentLineLink' + allocatedOnDate: + $ref: '#/components/schemas/DateTime' + description: The date the payment was allocated. + required: + - amount + paymentLineLink: + title: Payment Line Link + type: object + additionalProperties: false + properties: + type: + $ref: '#/components/schemas/AccountingPayment/definitions/paymentLinkType' + id: + type: string + description: Unique identifier of the transaction represented by the link. + amount: + type: number + format: decimal + nullable: true + description: "Amount by which the balance of the linked entity is altered, in the currency of the linked entity. \nA negative link amount _reduces_ the outstanding amount on the accounts receivable account. \nA positive link amount _increases_ the outstanding amount on the accounts receivable account." + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + required: + - type + paymentLinkType: + title: Payment Link Type + type: string + enum: + - Unknown + - Unlinked + - Invoice + - CreditNote + - Other + - Refund + - Payment + - PaymentOnAccount + - ManualJournal + - Discount + description: "Types of payment line links, either: \n`Unknown` \n`Unlinked` - Not used \n`Invoice` - ID refers to the invoice \n`CreditNote` - ID refers to the credit note \n`Refund` - ID refers to the sibling payment \n`Payment` - ID refers to the sibling payment \n`PaymentOnAccount` - ID refers to the customer \n`Other` - ID refers to the customer \n`Manual Journal` \n`Discount` - ID refers to the payment" + AccountingPaymentAllocation: + title: 'Accounting: Payment allocation' + type: object + properties: + payment: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment' + allocation: + type: object + properties: + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency of the transaction. + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + allocatedOnDate: + $ref: '#/components/schemas/DateTime' + description: The date the payment was allocated. + totalAmount: + type: number + format: decimal + description: The total amount that has been allocated. + required: + - payment + - allocation + definitions: + paymentAllocationPayment: + type: object + properties: + id: + type: string + description: Identifier of the allocated payment. + note: + type: string + nullable: true + description: Notes attached to the allocated payment. + reference: + type: string + nullable: true + description: Reference to the allocated payment. + accountRef: + $ref: '#/components/schemas/AccountingAccount/definitions/accountRef' + description: The account that the allocated payment is made from or to. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency the payment has been made in. + currencyRate: + title: Currency rate + type: number + format: decimal + nullable: true + description: "Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.\n\nCurrency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. \n\nIt is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.\n\nWhere the currency rate is provided by the underlying accounting software, it will be available from Codat with the same precision (up to a maximum of 9 decimal places). \n\nFor accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.\n\n## Examples with base currency of GBP\n\n| Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (GBP) |\n| :--------------- | :------------- | :------------ | :------------------------- |\n| **USD** | $20 | 0.781 | £15.62 |\n| **EUR** | €20 | 0.885 | £17.70 |\n| **RUB** | ₽20 | 0.011 | £0.22 |\n\n## Examples with base currency of USD\n\n| Foreign Currency | Foreign Amount | Currency Rate | Base Currency Amount (USD) |\n| :--------------- | :------------- | :------------ | :------------------------- |\n| **GBP** | £20 | 1.277 | $25.54 |\n| **EUR** | €20 | 1.134 | $22.68 |\n| **RUB** | ₽20 | 0.015 | $0.30 |\n\n\n### Integration-specific details\n\n| Integration | Scenario | System behavior |\n|-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, specify a currencyRate in the request body. |" + paidOnDate: + $ref: '#/components/schemas/DateTime' + description: The date the payment was paid. + totalAmount: + type: number + format: decimal + description: Total amount that was paid. + AccountingPaymentMethod: + title: 'Accounting: Payment method' 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. + ## Overview - 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' - 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' - '/companies/{companyId}/connections/{connectionId}/bankFeedAccounts/mapping': - 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 - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/BankFeedMapping/definitions/bankFeedMappings' - examples: - Example: - 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 - '401': - $ref: '#/components/responses/Unauthorized' - '402': - $ref: '#/components/responses/Payment-Required' - '403': - $ref: '#/components/responses/Forbidden' - '404': - $ref: '#/components/responses/Not-Found' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' - post: - 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 - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BankFeedAccountMapping' + A Payment Method represents the payment method(s) used to pay a Bill. Payment Methods are referenced on [Bill Payments](https://docs.codat.io/lending-api#/schemas/BillPayment) and [Payments](https://docs.codat.io/lending-api#/schemas/Payment). + type: object + allOf: + - type: object + properties: + id: + type: string + description: Unique identifier for the payment method. + name: + type: string + nullable: true + description: Name of the payment method. + type: + $ref: '#/components/schemas/AccountingPaymentMethod/definitions/paymentMethodType' + status: + $ref: '#/components/schemas/CommercePaymentMethod/allOf/1/properties/status' + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + paymentMethodType: + description: Method of payment. + type: string + enum: + - Unknown + - Cash + - Check + - CreditCard + - DebitCard + - BankTransfer + - Other + AccountingPayments: + title: 'Accounting: Payments' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingPayment' + - $ref: '#/components/schemas/PagingInfo' + AccountingProfitAndLossReport: + title: 'Accounting: Profit and loss report' + description: "> **Language tip:** Profit and loss statement is also referred to as **income statement** under US GAAP (Generally Accepted Accounting Principles).\n\n## Overview\n\nThe purpose of a profit and loss report is to present the financial performance of a company over a specified time period.\n\nA profit and loss report shows a company's total income and expenses for a specified period of time and whether a profit or loss has been made.\n\n> **Profit and loss or balance sheet?** \n> Profit and loss reports summarise the total revenue, expenses, and profit or loss over a specified time period. A balance sheet report presents all assets, liability, and equity for a given date.\n\n\n**Structure of this report** \nThis report will reflect the structure and line descriptions that the business has set in their own accounting software.\n\n**History** \nBy default, Codat pulls (up to) 24 months of profit and loss history for a company. You can adjust this to fetch more history, where available, by updating the `monthsToSync` value for `profitAndLoss` on the [data type settings endpoint](https://docs.codat.io/lending-api#/operations/post-profile-syncSettings).\n\n**Want to pull this in a standardised structure?** \nOur [Enhanced Financials](https://docs.codat.io/lending/features/financial-statements-overview) endpoints provide the same report under standardized headings, allowing you to pull it in the same format for all of your business customers." + type: object + properties: + reports: + type: array + description: An array of profit and loss reports. + items: + $ref: '#/components/schemas/AccountingProfitAndLossReport/definitions/profitAndLossReport' + reportBasis: + $ref: '#/components/schemas/AccountingProfitAndLossReport/definitions/reportBasis' + currency: + type: string + description: Base currency of the company in which the profit and loss report is presented. + mostRecentAvailableMonth: + $ref: '#/components/schemas/DateTime' + description: Most recent available monthly report data. + earliestAvailableMonth: + $ref: '#/components/schemas/DateTime' + description: Earliest available monthly report data. + required: + - reports + - reportBasis + definitions: + reportBasis: + enum: + - Unknown + - Accrual + - Cash + type: string + description: The basis of a report. + profitAndLossReport: + type: object + additionalProperties: false + properties: + fromDate: + $ref: '#/components/schemas/DateTime' + description: Date from which the report data begins. + toDate: + $ref: '#/components/schemas/DateTime' + description: Date on which the report data ends. + income: + $ref: '#/components/schemas/ReportLine' + description: ReportLine items for income in the given date range. + costOfSales: + $ref: '#/components/schemas/ReportLine' + description: ReportLine items for cost of sales in the given date range. + grossProfit: + type: number + format: decimal + description: Gross profit of the company in the given date range. + expenses: + $ref: '#/components/schemas/ReportLine' + description: ReportLine items for expenses in the given date range. + netOperatingProfit: + type: number + format: decimal + description: Net operating profit of the company in the given date range. + otherExpenses: + $ref: '#/components/schemas/ReportLine' + description: ReportLine items for other expenses in the given date range. + otherIncome: + $ref: '#/components/schemas/ReportLine' + description: ReportLine items for other income in the given date range. + netOtherIncome: + type: number + format: decimal + description: Net other income of the company in the given date range. + netProfit: + type: number + format: decimal + description: Net profit of the company in the given date range. + required: + - grossProfit + - netOperatingProfit + - netOtherIncome + - netProfit + AccountingRecordRef: + type: object + x-internal: true + title: Record reference + description: "Links the current record to the underlying record or data type that created it. \n\nFor example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. " + properties: + id: + type: string + description: '''id'' of the underlying record or data type.' + dataType: + type: string + description: Allowed name of the 'dataType'. + examples: + - journalEntry + - invoice + - accountTransaction + - transfer + AccountingSupplier: + title: 'Accounting: Supplier' + description: |- + ## Overview + + From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers for a company](https://docs.codat.io/lending-api#/operations/list-suppliers). Suppliers' data links to accounts payable [bills](https://docs.codat.io/lending-api#/schemas/Bill). + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'Identifier for the supplier, unique to the company in the accounting software.' + supplierName: + type: string + nullable: true + description: 'Name of the supplier as recorded in the accounting system, typically the company name.' + contactName: + type: string + nullable: true + description: Name of the main contact for the supplier. + emailAddress: + type: string + nullable: true + description: Email address that the supplier may be contacted on. + phone: + type: string + nullable: true + description: Phone number that the supplier may be contacted on. examples: - Example: - value: - sourceAccountId: acc-002 - targetAccountId: account-081 - responses: - '200': - description: Success + - +44 25691 154789 + - (877) 492-8687 + - 01224 658 999 + addresses: + type: array + nullable: true + description: An array of Addresses. + items: + $ref: '#/components/schemas/AccountingAddress' + registrationNumber: + type: string + nullable: true + description: 'Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House.' + taxNumber: + type: string + nullable: true + description: Supplier's company tax number. + status: + $ref: '#/components/schemas/AccountingSupplier/definitions/supplierStatus' + defaultCurrency: + type: string + nullable: true + description: Default currency the supplier's transactional data is recorded in. + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - status + definitions: + supplierRef: + title: Supplier reference + description: Reference to the supplier the record relates to. + type: object + properties: + id: + minLength: 1 + type: string + description: The supplier's unique ID + supplierName: + type: string + nullable: true + description: The supplier's name + required: + - id + supplierStatus: + description: Status of the supplier. + type: string + enum: + - Unknown + - Active + - Archived + examples: + - id: C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F + supplierName: Kelly's Industrial Supplies + contactName: Kelly's Industrial Supplies + emailAddress: sales@kellysupplies.com + phone: 07999 999999 + addresses: + - type: Billing + line1: Unit 51 + line2: Bakersfield Industrial Estate + city: Bakersfield + region: California + country: USA + postalcode: '93308' + registrationNumber: string + taxNumber: string + status: Unknown + defaultCurrency: string + metadata: + isDeleted: true + supplementalData: content: - application/json: - schema: - $ref: '#/components/schemas/BankFeedAccountMappingResponse' - 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}/bankFeeds/info': - parameters: - - $ref: '#/components/parameters/companyId' - - $ref: '#/components/parameters/connectionId' - get: - summary: Get company information + property1: + property1: null + property2: null + property2: + property1: null + property2: null + modifiedDate: '2022-10-23T00:00:00Z' + sourceModifiedDate: '2022-10-23T00:00:00Z' + AccountingSuppliers: + title: Suppliers + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingSupplier' + - $ref: '#/components/schemas/PagingInfo' + AccountingTrackingCategory: + x-internal: true + title: 'Accounting: Tracking category' + description: "Details of a category used for tracking transactions.\n\n> Language tip\n>\n> Parameters used to track types of spend in various parts of an organization can be called **dimensions**, **projects**, **classes**, or **locations** in different accounting software. In Codat, we refer to these as tracking categories.\n\n## Overview\n\nTracking categories are used to monitor cost centres and control budgets that sit outside the standard chart of accounts. Customers may use tracking categories to group together and track the income and costs of specific departments, projects, locations or customers.\n\nFrom their accounting system, customers can: \n\n- Create and maintain tracking categories and tracking category types.\n- View all tracking categories that are available for use.\n- View the relationships between the categories.\n- Assign invoices, bills, credit notes, or bill credit notes to one or more categories.\n- View the categories that a transaction belongs to.\n- View all transactions in a tracking category.\n\n### Tracking categories per platform\n\nReview the platform-specific tracking categories that Codat supports, and the level they are assigned to in the source platform. \n\n\n\n \n \n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n\n
PlatformTracking categoryTracking level
Dynamics 365DimensionsLine item
FreshbooksExpense categoriesLine item
MYOBCategoriesTransaction
NetsuiteClassesLine item
LocationsLine item
DepartmentsLine item
Custom segmentsLine item
QuickBooks DesktopClassesLine item or transaction level
LocationsTransaction
QuickBooks OnlineClassesLine item or transaction level
LocationsTransaction
Sage 200Cost centersLine item
DepartmentsLine item
Analysis codesTransaction
Sage 50DepartmentsLine item
CostcodesLine item
ProjectsLine item
Sage IntacctDimensionsLine item
XeroTracking categoriesLine item
\n\n> **Example use case**\n>\n> Monitor the budget for your annual conference using a tracking category called 'AnnualConference2020' with the **type** set to **Costing**.\n\nIf a tracking category has a parent category, the ID of that parent category is displayed. There is also a `hasChildren` field that shows whether there are child subcategories nested beneath. " + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'The identifier for the item, unique per tracking category.' + nullable: true + name: + type: string + description: The name of the tracking category. + nullable: true + status: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/status' + parentId: + type: string + description: The identifier for this item's immediate parent. + nullable: true + hasChildren: + type: boolean + description: Boolean value indicating whether this category has SubCategories. + metadata: + $ref: '#/components/schemas/Metadata' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + trackingCategoryRef: + required: + - id + type: object + description: References a category against which the item is tracked. + deprecated: true + properties: + id: + minLength: 1 + type: string + description: Unique identifier to the tracking category. + name: + type: string + nullable: true + description: Name of tracking category. + status: + title: Tracking category status + type: string + description: Current state of the tracking category. + enum: + - Unknown + - Active + - Archived + examples: + - id: string + name: string + status: Unknown + parentId: string + hasChildren: true + modifiedDate: '2022-10-23T00:00:00Z' + sourceModifiedDate: '2022-10-23T00:00:00Z' + AccountingTransfer: + title: 'Accounting: Transfer' + description: 'A transfer records the movement of money between two bank accounts, or between a bank account and a nominal account. It is a child data type of [account transactions](https://docs.codat.io/lending-api#/schemas/AccountTransaction).' + allOf: + - properties: + id: + type: string + description: Unique identifier for the transfer. + description: + type: string + nullable: true + description: Description of the transfer. + contactRef: + $ref: '#/components/schemas/AccountingJournalEntry/definitions/journalLine/properties/contactRef' + description: 'The customer or supplier for the transfer, if available.' + date: + $ref: '#/components/schemas/DateTime' + description: The day on which the transfer was made. + from: + $ref: '#/components/schemas/AccountingTransfer/definitions/transferAccount' + description: The details of the accounts the transfer is moving from. + to: + $ref: '#/components/schemas/AccountingTransfer/definitions/transferAccount' + description: The details of the accounts the transfer is moving to. + status: + description: The status of the transfer in the account + type: string + enum: + - Unknown + - Unreconciled + - Reconciled + - Void + nullable: true + trackingCategoryRefs: + type: array + nullable: true + description: Reference to the tracking categories this transfer is being tracked against. + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + depositedRecordRefs: + type: array + nullable: true + description: List of selected transactions to associate with the transfer. Use this field to include transactions which are posted to the _undeposited funds_ (or other holding) account within the transfer. + items: + $ref: '#/components/schemas/AccountingRecordRef' + metadata: + $ref: '#/components/schemas/Metadata' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + transferAccount: + title: Transfer account + description: Account details of the account sending or receiving the transfer. + type: object + properties: + accountRef: + $ref: '#/components/schemas/AccountingRecordRef' + description: The account that the transfer is moving from or to. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + amount: + type: number + format: decimal + description: The amount transferred between accounts. + type: object + AccountingTransfers: + title: 'Accounting: Transfers' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/AccountingTransfer' + - $ref: '#/components/schemas/PagingInfo' + AccountsPayableTracking: + title: Tracking + x-internal: true + type: object + description: 'Categories, and a project and customer, against which the item is tracked.' + properties: + categoryRefs: + type: array + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + customerRef: + $ref: '#/components/schemas/AccountingCustomer/definitions/accountingCustomerRef' + projectRef: + $ref: '#/components/schemas/ProjectRef' + isBilledTo: + $ref: '#/components/schemas/AccountsPayableTracking/definitions/billedToType' + isRebilledTo: + $ref: '#/components/schemas/AccountsPayableTracking/definitions/billedToType' + required: + - categoryRefs + - isBilledTo + - isRebilledTo + definitions: + billedToType: + type: string + description: Defines if the invoice or credit note is billed/rebilled to a project or customer. + enum: + - Unknown + - NotApplicable + - Customer + - Project + AccountsReceivableTracking: + title: Tracking + x-internal: true + type: object + description: 'Categories, and a project and customer, against which the item is tracked.' + properties: + categoryRefs: + type: array + items: + $ref: '#/components/schemas/AccountingTrackingCategory/definitions/trackingCategoryRef' + customerRef: + $ref: '#/components/schemas/AccountingCustomer/definitions/accountingCustomerRef' + projectRef: + $ref: '#/components/schemas/ProjectRef' + isBilledTo: + $ref: '#/components/schemas/AccountsReceivableTracking/definitions/billedToType' + isRebilledTo: + $ref: '#/components/schemas/AccountsReceivableTracking/definitions/billedToType' + recordRef: + $ref: '#/components/schemas/AccountingRecordRef' + required: + - categoryRefs + - isBilledTo + - isRebilledTo + definitions: + billedToType: + type: string + enum: + - Unknown + - NotApplicable + - Project + description: Defines if the bill or bill credit note is billed/rebilled to a project. + AgedCurrencyOutstanding: + type: object + title: 'Accounting: Aged currency outstanding' + properties: + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + agedOutstandingAmounts: + type: array + description: Array of outstanding amounts by period. + items: + $ref: '#/components/schemas/AgedCurrencyOutstanding/definitions/agedOutstandingAmount' + definitions: + agedOutstandingAmount: + type: object + title: Aged outstanding amount + properties: + fromDate: + $ref: '#/components/schemas/DateTime' + description: Start date of period. + toDate: + $ref: '#/components/schemas/DateTime' + description: End date of period. + amount: + type: number + format: decimal + description: The amount outstanding. + details: + type: array + description: Array of details. + items: + $ref: '#/components/schemas/AgedCurrencyOutstanding/definitions/agedOutstandingAmountDetail' + agedOutstandingAmountDetail: + type: object + title: Amounts outstanding by data type + properties: + name: + type: string + description: Name of data type with outstanding amount for given period. + amount: + type: number + format: decimal + description: The amount outstanding. + Attachments: + x-internal: true + type: object + properties: + attachments: + type: array + items: + $ref: '#/components/schemas/AccountingAttachment' + nullable: true + title: Attachments + BankFeedBankAccountMapping: + title: Bank feed account mapping + type: object + additionalProperties: false + properties: + sourceAccountId: + type: string + description: Unique ID for the source account + targetAccountId: + type: string + nullable: true + description: Unique ID for the target account + feedStartDate: + $ref: '#/components/schemas/DateTime' + nullable: true + description: The date from which bank transactions can be provided to the platform. + required: + - sourceAccountId + examples: + - sourceAccountId: acc-002 + targetAccountId: account-081 + BankFeedBankAccountMappingResponse: + title: Bank feed account mapping response + type: object + additionalProperties: false + properties: + sourceAccountId: + type: string + description: Unique ID for the source account. + targetAccountId: + type: string + nullable: true + description: Unique ID for the target account. + status: + type: string + nullable: true + description: Status of the POST request. + error: + 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 + 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: + type: string + description: Account number for the source account. + sourceBalance: + 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: + 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.' + definitions: + targetAccountOption: + title: Target Account Option + 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 + BankingAccount: + title: 'Banking: Bank account' description: |- - Use the *Get company information* endpoint to return information about the company available from the underlying accounting software. + This data type provides a list of all the SMB's bank accounts, with rich data like balances, account numbers, and institutions holding the accounts. - ### 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 - responses: - '200': - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/CompanyInformation' - 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 + Responses are paged, so you should provide `page` and `pageSize` query parameters in your request. + type: object + allOf: + - type: object + properties: + id: + minLength: 1 + type: string + description: The ID of the account from the provider. + name: + minLength: 1 + type: string + description: The name of the account according to the provider. + informalName: + type: string + nullable: true + description: 'The friendly name of the account, chosen by the holder. This may not have been set by the account holder and therefore is not always available.' + holder: + type: string + nullable: true + description: The name of the person or company who holds the account. + type: + $ref: '#/components/schemas/AccountingBankAccountType' + balance: + $ref: '#/components/schemas/BankingAccountBalance/definitions/accountBalanceAmounts' + description: An object containing bank balance data. + identifiers: + $ref: '#/components/schemas/BankingAccount/definitions/accountIdentifiers' + currency: + minLength: 1 + type: string + description: The currency code for the account. + institution: + $ref: '#/components/schemas/BankingAccount/definitions/accountInstitution' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - id + - name + - type + - balance + - identifiers + - currency + - institution + definitions: + accountIdentifiers: + title: Account Identifiers + description: An object containing bank account identification information. + type: object + x-internal: true + additionalProperties: false + properties: + type: + $ref: '#/components/schemas/BankingAccount/definitions/accountIdentifierType' + subtype: + type: string + nullable: true + description: Detailed account category + number: + type: string + nullable: true + description: 'The account number for the account. When combined with the`bankCode`, this is usually enough to uniquely identify an account within a jurisdiction.' + bankCode: + type: string + nullable: true + description: |- + The local (usually national) routing number for the account. + + This is known by different names in different countries: + * BSB code (Australia) + * routing number (Canada, USA) + * sort code (UK) + iban: + type: string + nullable: true + description: 'The international bank account number (IBAN) for the account, if known.' + bic: + type: string + nullable: true + description: 'The ISO 9362 code (commonly called SWIFT code, SWIFT-BIC or BIC) for the account.' + maskedAccountNumber: + type: string + nullable: true + description: A portion of the actual account `number` to help account identification where number is tokenised (Plaid only) + required: + - type + accountIdentifierType: + type: string + x-internal: true + description: Type of account + enum: + - Account + - Card + - Credit + - Depository + - Investment + - Loan + - Other + accountInstitution: + title: Account Institution + description: The bank or other financial institution providing the account. + x-internal: true + type: object + additionalProperties: false + properties: + id: + type: string + description: 'The institution''s ID, according to the provider.' + name: + type: string + description: 'The institution''s name, according to the underlying provider.' + examples: + - results: + - id: 1703194f-7805-4da8-bac0-2ba5da4a4216 + name: Business Current Account + informalName: Codat + holder: Codat Ltd + type: Debit + balance: + available: -459987.97 + current: -459964.9 + limit: 5000 + identifiers: + type: Depository + subtype: checking + number: '46762629' + bankCode: 009911 + iban: GB29 LOYD 4773 2346 7626 29 + bic: LOYDGB21006 + maskedAccountNumber: LOYDGB21006 + currency: GBP + institution: + id: lloyds-bank + name: Lloyds Bank + modifiedDate: '2022-05-23T16:32:50Z' + sourceModifiedDate: '2021-08-14T05:04:12' + BankingAccountBalance: + title: 'Banking: Account balance' + description: "The Banking Account Balances data type provides a list of balances for a bank account including end-of-day batch balance or running balances per transaction.\n\nResponses are paged, so you should provide `page` and `pageSize` query parameters in your request.\n\n> **How often should I pull Account Balances?**\n>\n> Because these balances are closing balances, we recommend you pull Account Balance no more frequently than daily. If you require a live intraday balance, this can be found for each account on the [Account](https://docs.codat.io/lending-api#/schemas/Account) data type.\n> \n> Whilst you can choose to sync hourly, this may incur usage charges from Plaid or TrueLayer." + type: object + allOf: + - type: object + properties: + accountId: + minLength: 1 + type: string + description: The unique identifier of the account. + balance: + $ref: '#/components/schemas/BankingAccountBalance/definitions/accountBalanceAmounts' + date: + $ref: '#/components/schemas/DateTime' + description: Date of the balance. + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - accountId + - balance + - date + definitions: + accountBalanceAmounts: + title: Account Balance Amounts + x-internal: true + type: object + properties: + available: + type: number + format: decimal + nullable: true + description: 'The balance available in the account, including any pending transactions. This doesn''t include additional funds available from any overdrafts.' + current: + type: number + format: decimal + description: The balance of the account only including cleared transactions. + limit: + type: number + format: decimal + nullable: true + description: 'The minimum allowed balance for the account. For example, a $100.00 overdraft would show as a limit of `-100.00`.' + additionalProperties: false + description: 'Depending on the data provided by the underlying bank, not all balances are always available.' + examples: + - accountBalances: + - accountId: cce404db-27f7-4286-95db-622b53596cf4 + balance: + available: 714374.48 + current: 714374.57 + limit: 5000 + date: '2021-03-18T00:00:00' + - accountId: cce404db-27f7-4286-95db-622b53596cf4 + balance: + available: 714374.48 + current: 714374.57 + limit: 5000 + date: '2021-03-19T00:00:00' + - accountId: cce404db-27f7-4286-95db-622b53596cf4 + balance: + available: 714195.66 + current: 714204.39 + limit: 5000 + date: '2021-03-22T00:00:00' + - accountId: 2f593774-1075-4805-a552-84eecc7eb264 + balance: + available: -644945.42 + current: -644925.84 + limit: 0 + date: '2022-03-09T00:00:00' + BankingAccountBalances: + title: 'Banking: Account balances' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/BankingAccountBalance' + - $ref: '#/components/schemas/PagingInfo' + BankingAccounts: + title: 'Banking: Bank accounts' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/BankingAccount' + - $ref: '#/components/schemas/PagingInfo' + BankingTransaction: + title: 'Banking: Transaction' 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. + The Banking Transactions data type provides an immutable source of up-to-date information on income and expenditure. - [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. + Responses are paged, so you should provide `page` and `pageSize` query parameters in your request. + type: object + allOf: + - type: object + properties: + id: + minLength: 1 + type: string + description: The unique identifier of the bank transaction. + accountId: + minLength: 1 + type: string + description: The unique identifier of the bank account. + description: + type: string + nullable: true + description: The description of the bank transaction. + amount: + type: number + format: decimal + description: The amount of the bank transaction. + currency: + minLength: 1 + type: string + description: The currency of the bank transaction. + postedDate: + $ref: '#/components/schemas/DateTime' + description: The date the bank transaction was cleared. + authorizedDate: + $ref: '#/components/schemas/DateTime' + description: The date the bank transaction was authorized. + code: + $ref: '#/components/schemas/BankingTransaction/definitions/transactionCode' + merchantName: + type: string + nullable: true + description: The name of the merchant. + transactionCategoryRef: + $ref: '#/components/schemas/BankingTransactionCategory/definitions/transactionCategoryRef' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - id + - accountId + - currency + definitions: + transactionCode: + type: string + x-internal: true + description: Code to identify the underlying transaction. + enum: + - Unknown + - Fee + - Payment + - Cash + - Transfer + - Interest + - Cashback + - Cheque + - DirectDebit + - Purchase + - StandingOrder + - Adjustment + - Credit + - Other + - NotSupported + examples: + - id: 0130b5bb-1419-40f6-8a27-7362d0381229 + accountId: 1703194f-7805-4da8-bac0-2ba5da4a4216 + description: Payments for direct income ce149943-c157-43fc-aac7-42a716b655b6 + amount: 5062.39 + currency: GBP + postedDate: '2021-07-06T00:00:00' + authorizedDate: '2021-07-06T00:00:00' + merchantName: New Look + transactionCategoryRef: + id: health-and-fitness-sports + modifiedDate: '2022-05-23T16:32:50Z' + sourceModifiedDate: '2021-06-28T10:48:12' + BankingTransactionCategories: + title: 'Banking: Transaction categories' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/BankingTransactionCategory' + - $ref: '#/components/schemas/PagingInfo' + BankingTransactionCategory: + title: 'Banking: Transaction category' + description: |- + The Banking Transaction Categories data type provides a list of hierarchical categories associated with a transaction for greater contextual meaning to transaction activity. - **Integration-specific behavior** + Responses are paged, so you should provide `page` and `pageSize` query parameters in your request. + type: object + allOf: + - type: object + description: Status of the bank transaction category. + properties: + id: + minLength: 1 + type: string + description: The unique identifier of the bank transaction category. + name: + minLength: 1 + type: string + description: The name of the bank transaction category. + parentId: + type: string + nullable: true + description: The unique identifier of the parent bank transaction category. + hasChildren: + type: boolean + description: A Boolean indicating whether there are other bank transaction categories beneath this one in the hierarchy. + status: + $ref: '#/components/schemas/BankingTransactionCategory/definitions/transactionCategoryStatus' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - id + - name + definitions: + transactionCategoryRef: + type: object + x-internal: true + description: An object of bank transaction category reference data. + properties: + id: + minLength: 1 + type: string + description: The unique category reference id for the bank transaction. + name: + type: string + nullable: true + description: The category name reference for the bank transaction. + required: + - id + transactionCategoryStatus: + type: string + description: The status of the transaction category. + x-internal: true + enum: + - Unknown + - Active + - Archived + examples: + - id: auto-and-transport + name: Auto & Transport + hasChildren: true + status: Active + modifiedDate: '2022-05-23T16:32:50' + sourceModifiedDate: '2021-04-24T07:59:10' + BankingTransactions: + title: 'Banking: Transactions' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/BankingTransaction' + - $ref: '#/components/schemas/PagingInfo' + BankStatementUploadConfiguration: + title: Banking data upload settings + description: Configuration settings for uploading banking data to Codat + additionalProperties: false + type: object + properties: + source: + type: string + enum: + - codat + description: The source of the banking data that determines its format + accountId: + type: string + description: The ID of the account in the third-party platform + providerId: + type: string + description: TrueLayer provider ID (only required if source is TrueLayer) + CategorizedBankStatementAccounts: + title: Categorized bank statement accounts + description: |- + > **Categorization engine** + > + > The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source. - 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 + The Enhanced Cash Flow accounts endpoint provides a list of accounts that categorized transactions have been taken from. + allOf: + - type: object + properties: + results: + type: array + items: + title: Account + type: object + properties: + id: + description: The ID of the account from the provider. + type: string + sourceRef: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/accounts/properties/sourceRef' + platformName: + description: 'Name of the banking data source, e.g. "Plaid".' + type: string + accountProvider: + description: The bank or other financial institution providing the account. + type: string + accountName: + description: The name of the account according to the provider. + type: string + accountType: + description: 'The type of banking account, e.g. credit or debit.' + type: string + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency code for the bank account. + currentBalance: + description: The balance of the bank account. + type: number + format: decimal + identifiers: + $ref: '#/components/schemas/BankingAccount/definitions/accountIdentifiers' + - $ref: '#/components/schemas/PagingInfo' + example: + results: + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Savings Account + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Banking - Business Credit Card + accountType: Credit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Undeposited Funds + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Current Account + accountType: Debit + currency: GBP + currentBalance: 0 + pageNumber: 1 + pageSize: 10 + totalResults: 15 + _links: + self: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/accounts + current: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/accounts?page=1&pageSize=10 + next: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/accounts?page=2&pageSize=10 + CategorizedBankStatementTransactions: + title: Categorized bank statement transactions + description: |- + > **Categorization engine** + > + > The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source. + + The Enhanced Cash Flow Transactions endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources. + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowItem/properties/transactions/items' + - $ref: '#/components/schemas/PagingInfo' + example: + results: + - sourceRef: + sourceType: Banking + - accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + date: '2023-01-25' + description: Payment to supplier + amount: 100 + currency: USD + transactionCategory: + confidence: 92.7 + levels: + - Asset + - Current + - Bank + confidences: + - 92.7 + - 95 + - 96 + platformName: Plaid + counterpartyNames: + - Counterparty + modifiedDate: '2023-01-25T22:36:05.125Z' + isRecurring: true + - sourceRef: + sourceType: Banking + - accountRef: + id: 12345678-1234-1234-1234-123456789012 + name: Business Saving Account + id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + date: '2023-01-25' + description: Payment to supplier + amount: 100 + currency: USD + transactionCategory: + confidence: 92.7 + levels: + - Expense + - Operating + confidences: + - 92.7 + - 95 + platformName: Plaid + counterpartyNames: [] + modifiedDate: '2023-01-25T22:36:05.125Z' + isRecurring: false + pageNumber: 1 + pageSize: 100 + totalResults: 2401 + _links: + self: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions + current: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=1&pageSize=100 + next: + href: /companies/82458839-6812-49e9-baac-7dcf8c32de1f/reports/categorizedBankStatement/latest/transactions?page=2&pageSize=100 + ClientRateLimitWebhook: + title: Client rate limit webhook + type: object + properties: + id: + type: string + format: uuid + example: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b + description: Unique identifier of the event. + eventType: + type: string + description: The type of event. + examples: + - client.rateLimit.reset + - client.rateLimit.reached + generatedDate: + $ref: '#/components/schemas/DateTime' + description: The date time in UTC the event was generated in Codat. + payload: + $ref: '#/components/schemas/ClientRateLimitWebhook/definitions/clientRateLimitWebhookPayload' + definitions: + clientRateLimitWebhookPayload: + title: Client rate limit webhook payload + type: object + properties: + dailyQuota: + type: integer + description: The number of available requests per day. + quotaRemaining: + type: integer + description: Total number of requests remaining for your client. + expiryDate: + $ref: '#/components/schemas/DateTime' + description: The date time in UTC when your daily quota is reset. + CommerceAddress: + title: 'Commerce: Address' + x-internal: true + type: object + properties: + type: + $ref: '#/components/schemas/CommerceAddress/definitions/commerceAddressType' + line1: + description: The first line of the address + type: string + line2: + description: The second line of the address + type: string + city: + description: 'The third line of the address, or city' + type: string + region: + description: 'The fourth line of the address, or region' + type: string + country: + description: The country for the address + type: string + postalCode: + description: The postal (or zip) code for the address + type: string + definitions: + commerceAddressType: + description: The type of the address + type: string + enum: + - Billing + - Delivery + - Order + - Inventory + - Unknown + CommerceCompanyInfo: + title: 'Commerce: Company profile' + description: "In the Codat system, company profile includes standard commercial details about \na linked company, such as their address, phone number, and company registration.\n" + type: object + allOf: + - type: object + properties: + companyName: + type: string + description: The name of the company + example: Codat + commercePlatformRef: + type: string + description: Identifier or reference for the company in the commerce software + companyLegalName: + type: string + description: The full legal name of the company + example: Codat Limited + addresses: + type: array + description: Addresses associated with the company + items: + $ref: '#/components/schemas/CommerceAddress' + phoneNumbers: + type: array + description: Phone numbers associated with the company + items: + $ref: '#/components/schemas/PhoneNumber' + webLinks: + description: Weblinks associated with the company + type: array + items: + $ref: '#/components/schemas/WebLink' + registrationNumber: + description: The registration number of the company + type: string + examples: + - 10480375 + baseCurrency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + accountBalances: + description: The available and current cash balances for the company's accounts + type: array + items: + $ref: '#/components/schemas/CommerceCompanyInfo/definitions/accountBalance' + sourceUrls: + description: 'URL addresses for the originating system. For example, potential use cases include ''deeplinking'' to the originating system' + type: object + additionalProperties: + type: string + example: + url1: 'https://connect.sandbox.com/v2/customers' + url2: 'https://connect.sandbox.com/v2/disputes' + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + accountBalance: + title: Account Balance + type: object + x-internal: true + properties: + available: + description: The account's current balance + type: number + format: decimal + pending: + description: Funds that are not yet available in the balance + type: number + format: decimal + reserved: + description: Funds reserved as holdings + format: decimal + currency: + description: The currency of the account + allOf: + - $ref: '#/components/schemas/SourceAccount/properties/currency' + CommerceCustomer: + title: 'Commerce: Customer' + description: 'When a customer places an order with the connected commerce store their details are added to the Customers dataset. You can use the data from the Customers endpoints to calculate key metrics, such as customer churn.' + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + customerName: + type: string + description: Name of the customer + example: Fred Smith + emailAddress: + type: string + description: Email address of the customer + example: fred.smith@myCompany.com + phone: + $ref: '#/components/schemas/PhoneNumber/properties/number' + defaultCurrency: + allOf: + - description: "Default currency of any transactional data for the customer, \nfor example, orders or payments\n" + - $ref: '#/components/schemas/SourceAccount/properties/currency' + addresses: + type: array + description: Addresses of the customer + items: + $ref: '#/components/schemas/CommerceAddress' + note: + type: string + description: Any additional information about the customer + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + commerceCustomerRef: + type: object + description: Reference to the customer that placed the order. + properties: + id: + description: The unique identitifer of the customer being referenced + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + name: + description: Name of the customer being referenced. + type: string + required: + - id + examples: + - customers: + - id: '15' + customerName: Daffy Duck + emailAddress: d.duck@warnerbros.com + defaultCurrency: GBP + phone: (877) 492-8687 + addresses: + - type: billing + line1: 301 Duck Pond + line2: 28 Green Street + city: London + region: England + country: United Kingdom + postalCode: WX1X 0BE + - type: delivery + line1: Bread Street + line2: Bird Avenue + city: Paris + region: France + country: France + postalCode: WDF 123 + note: Regular customer + createdDate: '0001-01-01T00:00:00' + modifiedDate: null + sourceModifiedDate: '2020-09-15T23:52:28' + - id: '18' + customerName: Tasmanian Devil + emailAddress: t.devil@warnerbros.com + defaultCurrency: GBP + phone: +1-202-555-0181 + addresses: + - type: billing + line1: 101 Fire Rooms + line2: Engine Street + city: London + region: England + country: United Kingdom + postalCode: WC1X 0BE + note: Handle with care + createdDate: '0001-01-01T00:00:00' + modifiedDate: null + sourceModifiedDate: '2020-04-16T02:41:52' + - id: a99f5e0c-a4db-452f-8d2c-8fd15482b384 + customerName: Bugs Bunny + emailAddress: b.bunny@warnerbros.com + defaultCurrency: GBP + phone: '' + addresses: + - type: billing + line1: 301 Carrot Street + line2: Orange Town + city: Yorkshire + region: England + country: United Kingdom + postalCode: WF1X 0BE + - type: delivery + line1: 424 Field Street + line2: The Meadow + city: Paris + region: France + country: France + postalCode: WDF 123 + note: Regular customer + createdDate: '0001-01-01T00:00:00' + modifiedDate: null + sourceModifiedDate: '2020-08-12T14:37:37' + CommerceCustomers: + title: 'Commerce: Customers' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceCustomer' + - $ref: '#/components/schemas/PagingInfo' + CommerceDispute: + title: 'Commerce: Dispute' + description: "A customer may file a payment dispute with their bank or other card issuer when they're unsatisfied with their purchase or believe they have been charged incorrectly. For example: \n- They didn't receive an order. \n- The product they received was different to the commerce store's description. \n- They've been the victim of online fraud. \n\nYou can use data from the Disputes endpoints to calculate key metrics, such as the number of chargebacks." + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + required: + - currency + properties: + disputedTransactions: + description: Link to the source event(s) which triggered this transaction. + type: array + items: + $ref: '#/components/schemas/CommerceTransaction/definitions/transactionSourceRef' + totalAmount: + description: Total transaction amount that is under dispute. + format: decimal + examples: + - 194.12 + - -283.56 + - 0 + currency: + description: Currency of the disputed transaction. + $ref: '#/components/schemas/SourceAccount/properties/currency' + status: + $ref: '#/components/schemas/CommerceDispute/definitions/disputeStatus' + reason: + description: Reason for the dispute + type: string + examples: + - Unhappy with product + dueDate: + description: Date when the next action in the dispute resolution is due + $ref: '#/components/schemas/DateTime' + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + disputeStatus: + description: Current status of the dispute + x-internal: true + type: string + enum: + - Won + - Lost + - Accepted + - Processing + - ChargeRefunded + - EvidenceRequired + - InquiryEvidenceRequired + - InquiryProcessing + - InquiryClosed + - WaitingThirdParty + - Unknown + example: EvidenceRequired + examples: + - id: 03e608e3-bd1c-454f-8c2b-fb0133e43b95 + disputedTransactions: + - id: e63ad857-7e12-4e64-9185-cdfd7c45d09d + type: Order + totalAmount: -47.66 + currency: GBP + status: InquiryEvidenceRequired + reason: Unhappy with product + dueDate: '2021-03-29T14:39:55' + createdDate: '2021-03-22T14:39:55' + modifiedDate: '2022-02-02T11:02:45Z' + sourceModifiedDate: '2021-03-22T14:39:55' + CommerceDisputes: + title: 'Commerce: Disputes' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceDispute' + - $ref: '#/components/schemas/PagingInfo' + CommerceLocation: + title: 'Commerce: Location' + type: object 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. + The Location datatype holds information on the geographic location at which stocks of products may be held, as referenced in the Products data type. - Write operations are actions that send requests to Codat, enabling the creation, updating, deletion of records, or uploading attachments in the connected accounting software. + A Location also holds information on geographic locations where orders were placed, as referenced in the Orders data type. + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + name: + description: Name of this location + type: string + address: + description: Address associated with the location + $ref: '#/components/schemas/CommerceAddress' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + locationRef: + type: object + description: Reference to the geographic location where the order was placed. + properties: + id: + description: The unique identitifer of the location being referenced. + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + name: + description: Name of the location being referenced. + type: string + required: + - id + examples: + - id: '15' + name: London Warehouse + address: + type: Inventory + line1: Warner House + line2: 98 Theobald's Road + city: London + region: '' + country: United Kingdom + postalCode: WC1X 8WB + modifiedDate: '2020-08-12T14:37:37' + sourceModifiedDate: '2020-08-12T14:37:37' + CommerceLocations: + title: 'Commerce: Locations' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceLocation' + - $ref: '#/components/schemas/PagingInfo' + CommerceOrder: + title: 'Commerce: Order' + description: | + Orders contain the transaction details for all products sold by the company, and include details of any payments, service charges, or refunds related to each order. You can use data from the Orders endpoints to calculate key metrics, such as gross sales values and monthly recurring revenue (MRR). + allOf: + - type: object + x-stoplight: + id: 516bf0ecc4907 + required: + - id + properties: + id: + type: string + description: 'A unique, persistent identifier for this record' + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + x-codat-validation: + - validator: UniqueWithinConnection + - properties: + orderNumber: + type: string + description: Friendly reference for the order in the commerce or point of sale platform. + country: + description: "The Codat country property is returned as it was provided in the underlying platform by the company without any formatting on our part.\n\nDepending on the platform the value of this property will either be an ISO 3166 code (2-alpha or 3-alpha) or free-form text returned as a string name in our model. \n\nFor POST operations against platforms that demand a specific format for the country code, we have documented accepted values in the [options](https://docs.codat.io/lending-api#/operations/get-companies-companyId-connections-connectionId-push) endpoint." + type: string + format: ISO3166 Alpha-3 + examples: + - GBR + - USA + - ABW + currency: + allOf: + - $ref: '#/components/schemas/SourceAccount/properties/currency' + - description: Currency in which the order was placed. + closedDate: + $ref: '#/components/schemas/DateTime' + description: 'Date on which order was closed after the product was shipped, paid for, and any refund period had elapsed.' + totalAmount: + description: 'Total amount of the order, including discounts, refunds, and tax, but excluding gratuities.' + type: number + format: decimal + totalRefund: + description: 'Total amount of any refunds issued on the order, including discounts and tax, but excluding gratuities. This is always negative.' + type: number + format: decimal + totalTaxAmount: + description: Total amount of tax applied to the order. + type: number + format: decimal + totalDiscount: + description: 'Total amount of any discounts applied to the order, excluding tax. This is typically positive (for discounts which decrease the amount of the order), but can also be negative (for discounts which increase the amount of the order).' + type: number + format: decimal + totalGratuity: + description: Extra amount added to the order. + type: number + format: decimal + orderLineItems: + type: array + items: + $ref: '#/components/schemas/CommerceOrder/definitions/orderLineItem' + payments: + type: array + items: + $ref: '#/components/schemas/CommercePayment/definitions/paymentRef' + serviceCharges: + type: array + items: + $ref: '#/components/schemas/CommerceOrder/definitions/serviceCharge' + locationRef: + $ref: '#/components/schemas/CommerceLocation/definitions/locationRef' + customerRef: + $ref: '#/components/schemas/CommerceCustomer/definitions/commerceCustomerRef' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - title: Created date + type: object + x-internal: true + properties: + createdDate: + $ref: '#/components/schemas/DateTime' + description: The date the entity was created. + - 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. - 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 + 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: + orderLineItem: + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + quantity: + type: number + format: decimal + description: | + Number of units of the product sold. + For refunds, quantity is negative. + taxPercentage: + type: number + format: decimal + description: Percentage rate (from 0 to 100) of any sales tax applied to the unit price. + examples: + - 0 + - 12.5 + - '45.00' + totalAmount: + type: number + format: decimal + description: 'Total amount of the line item, including discounts and tax.' + totalTaxAmount: + type: number + format: decimal + description: 'Total amount of tax applied to the line item, factoring in any discounts.' + unitPrice: + type: number + format: decimal + description: 'Price per unit of goods or services, excluding discounts and tax.' + taxes: + type: array + items: + $ref: '#/components/schemas/CommerceTaxComponent/definitions/taxComponentAllocation' + description: Taxes breakdown as applied to order lines. + productRef: + $ref: '#/components/schemas/CommerceProduct/definitions/productRef' + productVariantRef: + $ref: '#/components/schemas/CommerceProduct/definitions/productVariantRef' + discountAllocations: + type: array + items: + $ref: '#/components/schemas/CommerceOrder/definitions/orderDiscountAllocation' + serviceCharge: + type: object + properties: + description: + description: Service charges for this order. + type: string + example: A service charge + totalAmount: + description: 'Total amount of the service charge, including tax.' + type: number + format: decimal + examples: + - 0 + - 12.5 + - 45 + taxPercentage: + description: Percentage rate (from 0 to 100) of any tax applied to the service charge. + type: number + format: decimal + examples: + - 0 + - 12.5 + - 45 + taxAmount: + description: Amount of the service charge that is tax. + type: number + format: decimal + examples: + - 0 + - 12.5 + - 45 + taxes: + description: Taxes breakdown as applied to service charges. + type: array + items: + $ref: '#/components/schemas/CommerceTaxComponent/definitions/taxComponentAllocation' + quantity: + description: The number of times the charge is charged. + type: integer + examples: + - 1 + - 12 + - 45 + type: + $ref: '#/components/schemas/CommerceOrder/definitions/serviceChargeType' + serviceChargeType: + description: The type of the service charge. + type: string + enum: + - Generic + - Shipping + - Overpayment + - Unknown + example: Overpayment + orderDiscountAllocation: + type: object + properties: + name: + type: string + description: Name of the discount in the commerce or point of sale platform. + example: Promotional Discount + totalAmount: + type: number + format: decimal + description: 'Total amount of discount applied, excluding tax. This is typically positive (for discounts which decrease the amount of the order line), but can also be negative (for discounts which increase the amount of the order line).' + example: 15.25 + examples: + - id: 01e63721-1205-478e-8503-9d8bf8a93f44 + orderNumber: '99123956' + country: CAN + currency: CAD + createdDate: '2021-03-28T03:00:14' + totalAmount: 12 + totalRefund: 0 + totalTaxAmount: 2 + totalDiscount: 0 + totalGratuity: 1 + orderLineItems: + - id: 116113a6-54d3-4624-ba73-26a77a5ffd51 + quantity: 1 + taxPercentage: 20 + totalAmount: 12 + totalTaxAmount: 2 + unitPrice: 10 + taxes: + - taxComponentRef: + id: '72' + name: Sales Tax + taxAmount: '' + - taxComponentRef: + id: '72' + name: City Tax + taxAmount: '' + productRef: + id: ac186646-41f2-4280-afea-1012c59459ab + name: Intelligent Concrete Salad + productVariantRef: + id: f9ca9de5-9e31-460d-ac81-368f4e7c8fc0 + name: Small Incredible Wooden Soap + discountAllocations: [] + payments: + - id: defdceb6-83a3-4b7d-a74e-e9ef947d5f48 + amount: 12 + currency: CAD + type: Paypal + status: Unknown + dueDate: '2021-04-04T03:00:14' + createdDate: '2021-03-28T03:00:14' + modifiedDate: '2022-02-02T11:02:45' + serviceCharges: + - description: Service Charge + totalAmount: 1.2 + taxPercentage: 20 + taxAmount: 0.2 + taxes: + - taxComponentRef: + id: '72' + name: Service Tax + taxAmount: '' + quantity: 1 + type: Generic + locationRef: + id: 47bbffc7-c045-4b0f-a3bb-ecf1f669edfa + customerRef: + id: 2634d180-7205-43f0-a73d-84af6443a005 + name: Emmy Roberts + modifiedDate: '2022-02-02T11:02:45Z' + sourceModifiedDate: '2021-03-28T03:00:14' + type: object + CommerceOrders: + title: 'Commerce: Orders' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceOrder' + - $ref: '#/components/schemas/PagingInfo' + CommercePayment: + title: 'Commerce: Payment' 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. + Payments contain details of all payments made by customers to a company, including: amounts, currency used, payment method, payment provider, and payment status. - A sync is a single execution that fetches bank transactions from a connected bank account and records them in the company's accounting software. + Refunds are recorded as separate, negative payments. Note that a refund can only occur in relation to a payment that has been completed (i.e. has a status of `Paid`). When a customer cancels an order _before_ a payment has been completed, the payment shows as `Cancelled`. - 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' - '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' - '409': - $ref: '#/components/responses/Conflict' - '429': - $ref: '#/components/responses/Too-Many-Requests' - '500': - $ref: '#/components/responses/Internal-Server-Error' - '503': - $ref: '#/components/responses/Service-Unavailable' -webhooks: - client.rateLimit.reached: - post: - description: Called when your client’s request count to Codat's API surpasses the allocated quota. - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ClientRateLimitWebhook' + You can use data from the Payments endpoints to calculate key metrics, such as gross sales and monthly recurring revenue (MRR). + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + amount: + type: number + format: decimal + description: Payment Amount (including gratuity) + examples: + - 194.12 + - -283.56 + - 0 + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency in which the payment was made + paymentMethodRef: + $ref: '#/components/schemas/PaymentMethodRef' + status: + $ref: '#/components/schemas/CommercePayment/definitions/paymentStatus' + paymentProvider: + type: string + description: 'Service provider of the payment, if applicable.' + examples: + - Amazon Pay + - Checkout.com + - SagePay + dueDate: + description: Date by which payment must be made + $ref: '#/components/schemas/DateTime' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + definitions: + paymentStatus: + type: string + x-internal: true + description: Status of the payment. + enum: + - Pending + - Authorized + - Paid + - Failed + - Cancelled + - Unknown + paymentType: + type: string + x-internal: true + nullable: true + description: Type of payment. + enum: + - Cash + - Card + - Invoice + - OnlineCard + - Swish + - Vipps + - Mobile + - StoreCredit + - Paypal + - Custom + - Prepaid + - Unknown + example: Cash + paymentRef: + x-internal: true + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + amount: + type: number + format: decimal + nullable: true + description: Payment Amount (including gratuity). + examples: + - 194.12 + - -283.56 + - 0 + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency in which the payment was made. + type: + $ref: '#/components/schemas/CommercePayment/definitions/paymentType' + status: + $ref: '#/components/schemas/CommercePayment/definitions/paymentStatus' + paymentProvider: + type: string + description: 'Service provider of the payment, if applicable.' + examples: + - Amazon Pay + - Checkout.com + - SagePay + dueDate: + description: Date by which payment must be made + $ref: '#/components/schemas/DateTime' + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + CommercePaymentMethod: + title: 'Commerce: Payment method' + description: A Payment Method represents the payment method(s) used to make payments. + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + name: + type: string + description: The name of the PaymentMethod + example: Alipay + status: + description: Status of the Payment Method. + x-internal: true + type: string + enum: + - Unknown + - Active + - Archived + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + CommercePaymentMethods: + title: 'Commerce: Payment methods' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommercePaymentMethod' + - $ref: '#/components/schemas/PagingInfo' + CommercePayments: + title: 'Commerce: Payments' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommercePayment' + - $ref: '#/components/schemas/PagingInfo' + CommerceProduct: + title: 'Commerce: Product' + description: | + A Product is an item in the company's inventory, and includes information about the price and quantity of all products, and variants thereof, available for sale. + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + name: + type: string + description: Name of the product in the commerce or POS system + examples: + - Hard Drive + - Windows Installation + - Software Support (Hourly) + description: + type: string + description: Description of the product recorded in the commerce or point of sale platform. + examples: + - 1tb Western Digital Hard Drive + - Install of Windows 11 (Professional Edition) + - 1 hour of support from an agent (phone or remote) + categorization: + type: string + description: Retail category that the product is assigned to e.g. `Hardware`. + examples: + - Hardware + - Software + - Support Services + isGiftCard: + type: boolean + description: | + Whether the product represents a gift card or voucher that + can be redeemed in the commerce or POS platform. + variants: + type: array + items: + $ref: '#/components/schemas/CommerceProduct/definitions/productVariant' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + definitions: + productRef: + type: object + description: Reference that links the line item to the correct product details. + properties: + id: + description: The unique identifier of the product being referenced. + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + name: + description: Name of the product being referenced. + type: string + required: + - id + productVariant: + title: Product Variant + description: | + Represents a variation of a product available for sale, for example an item of clothing that may be available for sale in multiple sizes and colors. + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + description: 'Identifier of the product variant, unique to the company.' + - properties: + name: + type: string + examples: + - Red Coat + - Black Coat + - Large Brown Hat + description: Name of the product recorded in the commerce or point of sale platform. + isTaxEnabled: + type: boolean + description: Whether sales taxes are enabled for this product variant. + sku: + type: string + examples: + - Coat-Red-Lrg + - Coat-Black-Md + - LargeBrownHat + - A725BA2 + description: 'SKU (stock keeping unit) of the variant, as defined by the merchant.' + barcode: + type: string + examples: + - '564158468416486458646886484' + - CSE370 + description: 'Unique product number of the variant. This might be a barcode, UPC, ISBN, etc.' + unitOfMeasure: + type: string + examples: + - kg + - m + - meters + description: 'Unit of measure for the variant, such as `kg` or `meters`.' + vatPercentage: + type: number + format: decimal + examples: + - 12.5 + - 0 + - 20 + description: VAT rate for the product variant if sales taxes are enabled. + prices: + type: array + description: Prices for the product variants in different currencies. + items: + $ref: '#/components/schemas/CommerceProduct/definitions/productPrice' + inventory: + $ref: '#/components/schemas/CommerceProduct/definitions/productInventory' + shippingRequired: + type: boolean + description: Indicates whether or not the product requires physical delivery. + status: + $ref: '#/components/schemas/CommerceProduct/definitions/productVariantStatus' + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + productVariantRef: + title: Product variant reference + type: object + description: Reference that links the line item to the specific version of product that has been ordered. + properties: + id: + description: The unique identifier of the product variant being referenced. + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + name: + description: Name of the product variant being referenced. + type: string + required: + - id + productPrice: + title: Product Price Variant + x-internal: true + type: object + properties: + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + nullable: true + unitPrice: + type: number + format: decimal + description: The product variant's unit price. + productInventory: + title: Product Inventory + description: Information about the total inventory as well as the locations inventory is in. + x-internal: true + type: object + properties: + totalQuantity: + type: number + format: decimal + nullable: true + description: The total quantity of stock remaining across locations. + locations: + type: array + items: + $ref: '#/components/schemas/CommerceProduct/definitions/productInventoryLocation' + productInventoryLocation: + title: Product Inventory Location + x-internal: true + type: object + properties: + quantity: + type: number + format: decimal + description: The quantity of stock remaining at location. + locationRef: + $ref: '#/components/schemas/CommerceLocation/definitions/locationRef' + productVariantStatus: + x-internal: true + type: string + description: The status of the product variant. + enum: + - Unknown + - Published + - Unpublished + CommerceProductCategories: + title: 'Commerce: Product categories' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceProductCategory' + - $ref: '#/components/schemas/PagingInfo' + CommerceProductCategory: + title: 'Commerce: Product category' + description: 'Product categories are used to classify a group of products together, either by type (e.g. "Furniture"), or sometimes by tax profile.' + type: object + allOf: + - type: object + properties: + id: + type: string + example: '"102"' + description: The unique identifier of the product category + name: + type: string + example: Entertainment + description: The name of the product category + ancestorRefs: + type: array + description: A collection of parent product categories implicitly ordered with the immediate parent last in the list. + items: + $ref: '#/components/schemas/CommerceRecordRef' + hasChildren: + type: boolean + description: A boolean indicating whether there are other product categories beneath this one in the hierarchy. + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + examples: + - productCategories: + - id: '100' + name: Entertainment + ancestorRefs: [] + hasChildren: true + modifiedDate: '2022-01-01T12:00:00Z' + sourceModifiedDate: '2021-10-01T12:53:21Z' + - id: '101' + name: Cinema + ancestorRefs: + - id: '100' + name: Entertainment + hasChildren: true + modifiedDate: '2022-01-01T12:00:00Z' + sourceModifiedDate: '2021-10-01T12:55:02Z' + - id: '102' + name: Movie + ancestorRefs: + - id: '100' + name: Entertainment + - id: '101' + name: Cinema + hasChildren: false + modifiedDate: '2022-01-01T12:00:00Z' + sourceModifiedDate: '2021-12-25T12:00:00Z' + CommerceProducts: + title: 'Commerce: Products' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceProduct' + - $ref: '#/components/schemas/PagingInfo' + CommerceRecordRef: + title: Record Ref + x-internal: true + type: object + properties: + id: + description: The unique identitifer of the record being referenced + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + type: + description: The type of record being referenced. + type: string + required: + - id + - type + description: '' + CommerceReport: + title: Commerce report + description: "## Structure\n\nAssess reports follow a consistent structure. Reports contain four sections of information:\n\n### 1. Report definition\n\nInformation such as:\n\n 1. The report info (e.g. enhanced_profit_and_loss).\n 2. The display name of the report (e.g. Enhanced Profit and Loss).\n \n### 2. Dimension info\n\nInformation about the dimension contained in the reports such as:\n\n 1. The type of dimension (e.g. datetime, recordRef).\n 2. The display name of the dimension (e.g. Period, Category type, Category sub type).\n 3. The details about each item within the dimension (e.g. displayName:\"Jan 2022\", start:\"...\", end:\"...\", id:\"...\", name:\"...\").\n\n### 3. Measure info\n\nInformation about the measures contained in the report such as:\n\n 1. The display name of the measure (e.g. value of account, percentage change).\n 2. The type of the measure (e.g. currency, percentage).\n 3. The unit of the measure (e.g. %, GBP).\n \n### 4. The data for the report\n\nWhen the *includeDisplayName* parameter is set to *true*, it shows the *dimensionDisplayName* and *itemDisplayName* to make the data human-readable. The default setting for *includeDisplayName* is *false*.\n\n\n## Displaying the report\n\nReports can be rendered as follows (ordering is implicit rather than explicit):\n\n![A table showing an example of how a report can be rendered](https://files.readme.io/1fa20ca-Report1.png)\n\n# Data model\n\n## Dimensions" + type: object + properties: + reportInfo: + type: object + additionalProperties: + type: string + dimensions: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/commerceReportDimension' + measures: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/commerceReportMeasure' + reportData: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/commerceReportComponent' + errors: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/commerceReportError' + definitions: + commerceReportMeasure: + title: Measure + type: object + properties: + displayName: + description: The measure's display name. + type: string + units: + type: string + description: The measure's units e.g. percentage (%). + index: + type: integer + description: The measure's index. + type: + type: string + description: The measure's type. + commerceReportError: + title: Error + type: object + properties: + message: + type: string + description: Message returned by error. + type: + type: string + description: The type of error. + details: + description: Additional details on the error. + type: object + additionalProperties: + type: array + items: + type: string + commerceReportDimension: + title: Dimension + type: object + properties: + index: + type: integer + description: The dimension's index. + displayName: + type: string + description: The dimension's display name. + type: + type: string + description: The dimension's type. + items: + type: array + items: + type: object + properties: + index: + type: integer + description: The dimension's items index. + commerceReportComponent: + title: Report component + type: object + properties: + dimension: + type: integer + description: The component's dimension. + dimensionDisplayName: + type: string + description: The component's display name. + item: + type: integer + description: The component's item number. + itemDisplayName: + type: string + description: The component's item display name. + measures: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/reportComponentMeasure' + components: + type: array + items: + $ref: '#/components/schemas/CommerceReport/definitions/commerceReportComponent' + reportComponentMeasure: + type: object + title: Report component measure + properties: + index: + type: integer + description: The measure's index. + measureDisplayName: + type: string + description: The measure's display name. + value: + type: number + format: decimal + description: The measure's value. + x-examples: + Example 1: + reportInfo: + additionalProp1: string + additionalProp2: string + additionalProp3: string + dimensions: + - index: 0 + displayName: string + type: string + items: + - index: 0 + measures: + - displayName: string + units: string + index: 0 + type: string + reportData: + - dimension: 0 + dimensionDisplayName: string + item: 0 + itemDisplayName: string + measures: + - index: 0 + measureDisplayName: string + components: + - string + errors: + - message: string + type: DatesOutOfRange + details: + additionalProp1: + - string + additionalProp2: + - string + additionalProp3: + - string + CommerceTaxComponent: + title: 'Commerce: Tax component' + description: 'The Tax Components endpoints return tax rates data from the commerce software, including tax rate names and values. This is to support the mapping of tax rates from the commerce software to those in the accounting software.' + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + name: + type: string + description: Name of the Tax Rate Component in the source commerce software. + example: Sales Tax + rate: + description: Rate of taxation represented as a fraction of the net price (typically in the range 0.00 - 1.00). + type: number + format: decimal examples: - Reached: - value: - id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b - eventType: client.rateLimit.reached - generatedDate: '2024-09-01T00:00:00Z' - payload: - dailyQuota: 12000 - quotaRemaining: 0 - expiryDate: '2024-09-01T12:14:14Z' - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - client.rateLimit.reset: - post: - description: 'Called when your client''s rate limit quota is reset, allowing additional requests to Codat''s API.' - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ClientRateLimitWebhook' + - 0.15 + - 0.2 + isCompound: + description: The Boolean flag to indicate when a Tax Rate Component compounds on a sale. + type: boolean examples: - Reset: - value: - id: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b - eventType: client.rateLimit.reset - generatedDate: '2024-09-01T00:00:00Z' - payload: - dailyQuota: 12000 - quotaRemaining: 11993 - expiryDate: '2024-09-01T23:59:99Z' - responses: - '200': - description: Return a 200 status to indicate that the webhook was received successfully. - 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' + - true + - false + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + required: + - name + definitions: + taxComponentAllocation: + title: Tax Component Allocation + type: object + properties: + taxComponentRef: + $ref: '#/components/schemas/CommerceTaxComponent/definitions/taxComponentRef' + rate: + description: Tax amount on order line sale as available from source commerce software. + type: number + format: decimal + nullable: true + taxComponentRef: + type: object + description: Taxes rates reference object depending on the rates being available on source commerce software. + properties: + id: + description: The unique identitifer of the tax component being referenced. + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + name: + description: Name of the tax component being referenced. + type: string + required: + - id + - name + examples: + - id: 13d946f0-c5d5-42bc-b092-97ece17923ab + name: Sales Tax (15%) + rate: 0.15 + isCompound: true + modifiedDate: '2022-10-23T00:00:00Z' + sourceModifiedDate: '2022-10-23T00:00:00Z' + CommerceTransaction: + title: 'Commerce: Transaction' + description: "Details of all financial transactions recorded in the commerce or point of sale system are added to the Transactions data type. For example, payments, service charges, and fees.\n\nYou can use data from the Transactions endpoints to calculate key metrics, such as: \n- Transaction volumes \n- Average transaction volume \n- Average transaction value \n- Returns \n- Payouts" + type: object + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/0' + - type: object + properties: + totalAmount: + description: The total transaction amount + type: number + format: decimal 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' + - 194.12 + - -283.56 + - 0 + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + type: + $ref: '#/components/schemas/CommerceTransaction/definitions/transactionType' + subType: + description: Non-standardised transaction type data from the commerce software + type: string 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 + - CardPayment + - Invoice payment + transactionSourceRef: + description: Link to the source event which triggered this transaction + allOf: + - $ref: '#/components/schemas/CommerceTransaction/definitions/transactionSourceRef' + supplementalData: + $ref: '#/components/schemas/SupplementalData' + - allOf: + - type: object + x-stoplight: + id: c590b4405180f + allOf: + - $ref: '#/components/schemas/CommerceOrder/allOf/2' + - type: object + x-stoplight: + id: gdyjg7bg783br + properties: + sourceCreatedDate: + $ref: '#/components/schemas/DateTime' + description: The date on which this record was created in the originating system + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + x-stoplight: + id: 9e815c1766554 + definitions: + transactionSourceRef: + title: Transaction Source Reference + x-internal: true + allOf: + - $ref: '#/components/schemas/CommerceRecordRef' + - type: object + properties: + type: + $ref: '#/components/schemas/CommerceTransaction/definitions/transactionSourceType' + transactionSourceType: + x-internal: true + type: string + description: The type of source the transaction arose. + enum: + - Fee + - Order + - Payment + - ServiceCharge + - Unknown + transactionType: + x-internal: true + description: "The type of the platform transaction: \n- `Unknown` \n- `FailedPayout` — Failed transfer of funds from the seller's merchant account to their bank account. \n- `Payment` — Credit and debit card payments. \n- `PaymentFee` — Payment provider's fee on each card payment. \n- `PaymentFeeRefund` — Payment provider's fee that has been refunded to the seller. \n- `Payout` — Transfer of funds from the seller's merchant account to their bank account. \n- `Refund` — Refunds to a customer's credit or debit card. \n- `Transfer` — Secure transfer of funds to the seller's bank account. " + type: string + enum: + - Payment + - Refund + - Payout + - FailedPayout + - Transfer + - PaymentFee + - PaymentFeeRefund + - Unknown + examples: [] + CommerceTransactions: + title: 'Commerce: Transactions' + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/CommerceTransaction' + - $ref: '#/components/schemas/PagingInfo' + Companies: + title: Companies + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/Company' + - $ref: '#/components/schemas/PagingInfo' + Company: + title: Company + description: "\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\x6C\x65\x6E\x64\x69\x6E\x67\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' + - type: object + properties: + dataConnections: + type: array + items: + $ref: '#/components/schemas/Connection' + definitions: + companyDetails: + title: Company details + type: object + properties: + id: + $ref: '#/components/parameters/companyId/schema' + name: + type: string + description: The name of the company + example: Codat Ltd. + description: + $ref: '#/components/schemas/CompanyRequestBody/properties/description' + nullable: true + redirect: + type: string + format: uri + description: 'The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company.' + example: 'https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739' + lastSync: + $ref: '#/components/schemas/DateTime' + nullable: true + created: + $ref: '#/components/schemas/DateTime' + createdByUserName: + type: string + description: Name of user that created the company in Codat. + nullable: true + products: + type: array + items: + type: string + description: An array of products that are currently enabled for the company. + tags: + title: Tags + type: object + maxProperties: 10 + propertyNames: + pattern: '^.{1,27}$' + additionalProperties: + type: string + maxLength: 100 + description: A collection of user-defined key-value pairs that store custom metadata against the company. + referenceParentCompany: + $ref: '#/components/schemas/Company/definitions/companyReference' + nullable: true + description: The parent entity or controlling organization of this company. Null if the company has no parent. + referenceSubsidiaryCompanies: + type: array + nullable: false + description: A list of subsidiary companies owned or controlled by this entity. Empty if the company has no children. + minItems: 0 + items: + $ref: '#/components/schemas/Company/definitions/companyReference' + required: + - id + - name + - redirect + companyReference: + title: Company reference + type: object + properties: + id: + $ref: '#/components/parameters/companyId/schema' + name: + $ref: '#/components/schemas/Company/definitions/companyDetails/properties/name' + description: + $ref: '#/components/schemas/Company/definitions/companyDetails/properties/description' + links: + type: object + description: A collection of links for the company. + properties: + portal: + type: string + format: uri + description: Link to the company page in the portal. + tags: + $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' + examples: + - id: 0498e921-9b53-4396-a412-4f2f5983b0a2 + name: string + redirect: 'https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739' + lastSync: '2022-01-01T12:00:00.000Z' + created: '2022-01-01T12:00:00.000Z' + createdByUserName: string + tags: + region: us + uid: f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c + dataConnections: + - id: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd + integrationId: bf083d72-62c7-493e-aec9-81b4dbba7e2c + integrationKey: dfxm + sourceId: bdd831ce-eebd-4896-89a7-20e5ee8989ee + platformName: Basiq + linkUrl: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' + status: Linked + lastSync: '2022-10-27T10:22:43.6464237Z' + created: '2022-10-27T09:53:29Z' + sourceType: Banking + products: + - spend-insights + - lending + CompanyRequestBody: + title: Create company request + x-internal: true + type: object + properties: + name: + type: string + description: Name of company being connected. + pattern: '^[A-Za-z0-9\s\-'',&@.,?!\s]+$' + minLength: 1 + example: Bank of Dave + description: + type: string + example: Requested early access to the new financing scheme. + description: 'Additional information about the company. This can be used to store foreign IDs, references, etc.' + tags: + $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' + required: + - name + CompanyUpdateRequest: + title: Update company request + x-internal: true + type: object + properties: + name: + type: string + description: Name of company being connected. + pattern: '^[A-Za-z0-9\s\-'',&@.,?!\s]+$' + minLength: 1 + example: Bank of Dave + description: + $ref: '#/components/schemas/CompanyRequestBody/properties/description' + tags: + $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' + Connection: + title: Connection + description: "\uFEFF\x41\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x27\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\x6C\x65\x6E\x64\x69\x6E\x67\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: + $ref: '#/components/parameters/connectionId/schema' + integrationId: + type: string + format: uuid + example: fd321cb6-7963-4506-b873-e99593a45e30 + description: A Codat ID representing the integration. + integrationKey: + type: string + description: A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future. + sourceId: + type: string + format: uuid + example: 35b92968-9851-4095-ad60-395c95cbcba4 + description: 'A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`.' + sourceType: + title: Source Type + description: The type of platform of the connection. + type: string + enum: + - Accounting + - Banking + - BankFeed + - Commerce + - Expense + - Other + - Unknown + example: Accounting + platformName: + type: string + description: Name of integration connected to company. + linkUrl: + type: string + format: uri + description: The link URL your customers can use to authorize access to their business application. + example: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/2e2eb431-c1fa-4dc9-93fa-d29781c12bcd/start' + status: + $ref: '#/components/schemas/Connection/definitions/dataConnectionStatus' + lastSync: + $ref: '#/components/schemas/DateTime' + nullable: true + created: + $ref: '#/components/schemas/DateTime' + dataConnectionErrors: + type: array + nullable: true + items: + $ref: '#/components/schemas/Connection/definitions/dataConnectionError' + connectionInfo: + type: object + nullable: true + additionalProperties: true + additionalProperties: false + required: + - id + - integrationId + - integrationKey + - sourceId + - platformName + - linkUrl + - status + - created + - sourceType + definitions: + dataConnectionStatus: + title: Data connection status + description: The current authorization status of the data connection. + type: string + enum: + - PendingAuth + - Linked + - Unlinked + - Deauthorized + dataConnectionError: + title: Data connection error + type: object + properties: + statusCode: + type: string + description: The HTTP status code returned by the source platform when the error occurred. + statusText: + type: string + description: A non-numeric status code/text returned by the source platform when the error occurred. + errorMessage: + type: string + description: A message about a error returned by Codat. + erroredOnUtc: + $ref: '#/components/schemas/DateTime' + status: + title: Error status + description: The current status of a transient error. Null statuses indicate that the error is not transient. + type: string + nullable: true + enum: + - Active + - Resolved + resolvedOnUtc: + description: The datetime in Utc that the error was resolved. + nullable: true + $ref: '#/components/schemas/DateTime' + dataConnectionSourceType: + title: Source Type + description: The type of platform of the connection. + type: string + enum: + - Accounting + - Banking + - BankFeed + - Commerce + - Expense + - Other + - Unknown + example: Accounting + example: + id: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd + integrationId: bf083d72-62c7-493e-aec9-81b4dbba7e2c + integrationKey: dfxm + sourceId: bdd831ce-eebd-4896-89a7-20e5ee8989ee + platformName: Basiq + linkUrl: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' + status: Linked + lastSync: '2022-10-27T10:22:43.6464237Z' + created: '2022-10-27T09:53:29Z' + sourceType: Banking + Connections: + title: Connections + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/Connection' + - $ref: '#/components/schemas/PagingInfo' + DataIntegrityDetail: + title: Data integrity detail + type: object + properties: + id: + type: string + description: ID GUID of the transaction. + type: + type: string + description: The data type of the record. + connectionId: + type: string + format: uuid + description: ID GUID representing the connection of the accounting or banking platform. + readOnly: true + date: + $ref: '#/components/schemas/DateTime' + description: The date of the transaction. + description: + type: string + description: The transaction description. + amount: + type: number + format: decimal + description: The transaction value. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency of the transaction. + matches: + type: array + items: + $ref: '#/components/schemas/DataIntegrityDetail/definitions/dataIntegrityMatch' + definitions: + dataIntegrityMatch: + type: object + properties: + id: + type: string + description: ID GUID of the transaction. + type: + type: string + description: 'The data type which the data type in the URL has been matched against. For example, if you''ve matched accountTransactions and banking-transactions, and you call this endpoint with accountTransactions in the URL, this property would be banking-transactions.' + connectionId: + type: string + description: ID GUID representing the connection of the accounting or banking platform. + format: uuid + date: + type: string + description: The date of the transaction. + description: + type: string + description: The transaction description. + amount: + type: string + description: The transaction value. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency of the transaction. + DataIntegrityDetails: + title: Data integrity details + x-internal: true + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/DataIntegrityDetail' + - $ref: '#/components/schemas/PagingInfo' + DataIntegrityStatus: + title: Data integrity status + type: object + allOf: + - $ref: '#/components/schemas/DataIntegritySummary/definitions/dataIntegrityType' + - type: object + properties: + statusInfo: + $ref: '#/components/schemas/DataIntegrityStatus/definitions/dataIntegrityStatusInfo' + connectionIds: + $ref: '#/components/schemas/DataIntegrityStatus/definitions/dataIntegrityConnectionId' + amounts: + $ref: '#/components/schemas/DataIntegrityStatus/definitions/dataIntegrityAmounts' + dates: + $ref: '#/components/schemas/DataIntegrityStatus/definitions/dataIntegrityDates' + definitions: + dataIntegrityStatusInfo: + type: object + properties: + lastMatched: + type: string + $ref: '#/components/schemas/DateTime' + description: The date the matching algorithm last ran against the company’s data type specified. + readOnly: true + currentStatus: + $ref: '#/components/schemas/DataIntegrityStatus/definitions/integrityStatus' + statusMessage: + type: string + description: Detailed explanation supporting the status value. + dataIntegrityConnectionId: + type: object + properties: + source: + type: array + description: An array of strings. The connection IDs for the type specified in the url. + items: + type: string + target: + type: array + description: An array of strings. The connection IDs for the type being matched to. + items: + type: string + dataIntegrityAmounts: + type: object + description: 'Only returned for transactions. For accounts, there is nothing returned.' + properties: + min: + type: number + format: decimal + description: Lowest value of transaction set. + max: + type: number + format: decimal + description: Highest value of transaction set. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + dataIntegrityDates: + type: object + description: 'Only returned for transactions. For accounts, there is nothing returned.' + properties: + minDate: + $ref: '#/components/schemas/DateTime' + description: Earliest date of transaction set. + readOnly: true + maxDate: + $ref: '#/components/schemas/DateTime' + description: Latest date of transaction set. + readOnly: true + minOverlappingDate: + $ref: '#/components/schemas/DateTime' + description: Earliest date where transactions exist in both accounting and banking platforms. + readOnly: true + maxOverlappingDate: + $ref: '#/components/schemas/DateTime' + description: Latest date where transactions exist in both account and banking platforms. + readOnly: true + integrityStatus: + type: string + enum: + - Unknown + - DoesNotExist + - Error + - Complete + description: The current status of the most recently run matching algorithm. + examples: + - type: string + statusInfo: + lastMatched: '2021-10-24T14:15:22Z' + currentStatus: Unknown + statusMessage: string + connectionIds: + source: + - d5a8d1b2-b38a-4e44-8641-548ad43be6bb + - da8c9f39-8af9-4a98-964b-f1e207942837 + target: + - 3d7ce25a-c107-44bc-8e0c-36c10bdd14e0 + - a5300eac-01fa-4a77-b5b0-ea0b86a3be69 + amounts: + min: 130 + max: 2450 + currency: GBP + dates: + minDate: '2021-09-17T12:09:33.441Z' + maxDate: '2021-12-16T12:12:53.441Z' + minOverlappingDate: '2021-09-30T12:09:13.441Z' + maxOverlappingDate: '2021-11-27T12:19:33.441Z' + DataIntegrityStatuses: + title: Data integrity statuses + x-internal: true + type: object + properties: + metadata: + type: array + items: + $ref: '#/components/schemas/DataIntegrityStatus' + DataIntegritySummaries: + title: Data integrity summaries + x-internal: true + type: object + properties: + summaries: + type: array + items: + $ref: '#/components/schemas/DataIntegritySummary' + DataIntegritySummary: + title: Data integrity summary + type: object + allOf: + - $ref: '#/components/schemas/DataIntegritySummary/definitions/dataIntegrityType' + - type: object + properties: + byAmount: + $ref: '#/components/schemas/DataIntegritySummary/definitions/dataIntegrityByAmount' + byCount: + $ref: '#/components/schemas/DataIntegritySummary/definitions/dataIntegrityByCount' + definitions: + dataIntegrityType: + type: object + properties: + type: + type: string + description: 'The data type which the data type in the URL has been matched against. For example, if you''ve matched accountTransactions and banking-transactions, and you call this endpoint with accountTransactions in the URL, this property would be banking-transactions.' + dataIntegrityByAmount: + title: Data integrity by amount + type: object + properties: + matchPercentage: + type: number + format: decimal + description: The percentage of the absolute value of transactions of the type specified in the route which have a match. + unmatched: + type: number + format: decimal + description: The sum of the absolute value of transactions of the type specified in the route which don't have a match. + matched: + type: number + format: decimal + description: The sum of the absolute value of transactions of the type specified in the route which have a match. + total: + type: number + format: decimal + description: The total of unmatched and matched. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + dataIntegrityByCount: + title: Data integrity by count + type: object + properties: + matchPercentage: + type: number + format: decimal + description: The percentage of records of the type specified in the route which have a match. + unmatched: + type: number + format: decimal + description: The number of records of the type specified in the route which don't have a match. + matched: + type: number + format: decimal + description: The number of records of the type specified in the route which do have a match. + total: + type: number + format: decimal + description: The total of unmatched and matched. + 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: - username: + dataType: + title: Data types + x-internal: true + type: string + description: Available data types + enum: + - accountTransactions + - balanceSheet + - bankAccounts + - bankTransactions + - billCreditNotes + - billPayments + - bills + - cashFlowStatement + - chartOfAccounts + - company + - creditNotes + - customers + - directCosts + - directIncomes + - invoices + - itemReceipts + - items + - journalEntries + - journals + - paymentMethods + - payments + - profitAndLoss + - purchaseOrders + - salesOrders + - suppliers + - taxRates + - trackingCategories + - transfers + - banking-accountBalances + - banking-accounts + - banking-transactionCategories + - banking-transactions + - commerce-companyInfo + - commerce-customers + - commerce-disputes + - commerce-locations + - commerce-orders + - commerce-paymentMethods + - commerce-payments + - commerce-productCategories + - commerce-products + - commerce-taxComponents + - commerce-transactions + example: invoices + lastSuccessfulSync: + $ref: '#/components/schemas/DateTime' + currentStatus: + $ref: '#/components/schemas/PullOperation/properties/status' + latestSyncId: type: string - example: S0MW-TR0P-7DS0 - description: Username used by the bank feeds platform to retrieve transactions - password: + description: Unique identifier for most recent sync of data type. + format: uuid + example: ad474a37-2003-478e-baee-9af9f1ec2fe3 + latestSuccessfulSyncId: type: string - example: cO0ajh0uGyTN0Pwh - description: Password to enable the bank feeds platform to securely retrieve transactions. + description: Unique identifier for the most recent successful sync of data type. + format: uuid + example: 8220fc90-55b6-47bc-9417-48ac6ea93101 examples: - - QuickBooks Online Bank Feeds: null - username: S0MW-TR0P-7DS0 - password: cO0ajh0uGyTN0Pwh - BankAccounts: + - dataType: string + lastSuccessfulSync: '2022-01-01T13:00:00.000Z' + currentStatus: string + latestSyncId: ad474a37-2003-478e-baee-9af9f1ec2fe3 + latestSuccessfulSyncId: 8220fc90-55b6-47bc-9417-48ac6ea93101 + DataStatusResponse: x-internal: true - title: '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 + title: Data status response type: object - additionalProperties: false - properties: - sourceAccountId: - type: string - description: Unique ID for the source account - targetAccountId: - type: string - nullable: true - description: Unique ID for the target account - feedStartDate: - $ref: '#/components/schemas/DateTime' - nullable: true - description: The date from which bank transactions can be provided to the platform. - required: - - sourceAccountId + additionalProperties: + $ref: '#/components/schemas/DataStatus' + DataType: + x-internal: true + $ref: '#/components/schemas/DataStatus/properties/dataType' + DateTime: + title: Date time + type: string examples: - - sourceAccountId: acc-002 - targetAccountId: account-081 - BankFeedAccountMappingResponse: - title: Bank feed account mapping response + - '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." + EndUploadSessionRequest: + title: End upload session request type: object - additionalProperties: false properties: - sourceAccountId: - type: string - description: Unique ID for the source account. - targetAccountId: - type: string - nullable: true - description: Unique ID for the target account. status: type: string - nullable: true - description: Status of the POST request. - error: - 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 + enum: + - Cancel + - Process + description: An indicator to cancel the dataset processing or trigger ingestion and enrichment of data. + EnhancedCashFlowTransactions: + title: Enhanced cash flow transactions + description: |- + > **Categorization engine** + > + > The categorization engine uses machine learning and has been fully trained against Plaid and TrueLayer banking data sources. It is not fully trained against the Basiq banking data source. + + The Enhanced Cash Flow Transactions endpoint provides a fully categorized list of banking transactions for a company. Accounts and transaction data are obtained from the company's banking data sources. 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: - type: string - description: Account number for the source account. - sourceBalance: - 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: + reportInfo: + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/reportInfo' + dataSources: 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.' + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/dataSource' + reportItems: + type: array + items: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowItem' definitions: - targetAccountOption: - title: Target Account Option + dataSource: type: object properties: - id: + accounts: + description: 'An array containing bank account data for each connected banking data source that have the following data types enabled: `banking-accounts`, `banking-transactions`.' + type: array + items: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/accounts' + accounts: + title: Accounts + type: object + properties: + sourceRef: + title: Report source reference + description: A source reference containing the `sourceType` object "Banking". + type: object + properties: + sourceType: + description: The data source type. + type: string + examples: + - Example: + value: + sourceRef: + sourceType: Banking + platformName: + description: 'Name of the banking data source, e.g. "Plaid".' type: string - description: Id of the target account. - name: + accountProvider: + description: The bank or other financial institution providing the account. type: string - nullable: true - description: Name of the target account. - balance: - type: number - format: decimal - nullable: true - description: The balance of the account. - sortCode: + accountName: + description: The name of the account according to the provider. type: string - nullable: true - description: The sort code of the account. - accountNumber: + accountType: + description: 'The type of banking account, e.g. credit or debit.' 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 - ClientRateLimitWebhook: - title: Client rate limit webhook + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency code for the bank account. + currentBalance: + description: The balance of the bank account. + type: number + format: decimal + enhancedCashFlowItem: + type: object + properties: + transactions: + description: An array of transaction data. + type: array + items: + title: Cash flow transaction + type: object + properties: + id: + description: The unique identifier of the bank transaction. + type: string + date: + description: The date the bank transaction was posted. + $ref: '#/components/schemas/DateTime' + description: + description: The description of the bank transaction. + type: string + amount: + description: The bank transaction amount. + type: number + format: decimal + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: The currency code for bank transaction. + transactionCategory: + description: Contains an array of category levels. + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowItem/properties/transactions/items/definitions/transactionCategory' + platformName: + description: Returns the payment processor responsible for the transaction. + type: string + counterpartyNames: + description: An array of counterparty names involved in the transaction. + type: array + items: + type: string + sourceRef: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/accounts/properties/sourceRef' + accountRef: + $ref: '#/components/schemas/EnhancedCashFlowTransactions/definitions/enhancedCashFlowItem/properties/transactions/items/definitions/accountRef' + modifiedDate: + description: The date the bank transaction was last modified. + $ref: '#/components/schemas/DateTime' + isRecurring: + description: Indicates if the transaction is classified as recurring by Codat's categorization engine. + type: boolean + nullable: true + definitions: + accountRef: + title: Account reference + description: An account reference containing the account id and name. + type: object + properties: + id: + description: The id of the account. + type: string + name: + description: The name of the account. + type: string + examples: + - Example: + value: + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + transactionCategory: + title: Transaction category + type: object + properties: + confidence: + description: Returns the aggregate confidence of the suggested category for the transaction. The value is between 0 and 100. + type: number + format: decimal + confidences: + description: An ordered array of category level confidences where each element is the confidence of the corresponding item in the `levels` array. + type: array + items: + type: number + format: decimal + levels: + description: The suggested category is an ordered array of category levels where each element (or level) is a subcategory of the previous element (or level). + type: array + items: + type: string + examples: + - Example: + value: + transactionCategory: + confidence: 92.7 + levels: + - Asset + - Current + - Bank + - BankTransfers + - ShareholderTransfers + confidences: + - 92.7 + - 95 + - 96 + - 97.5 + - 100 + examples: + - reportInfo: + pageNumber: 1 + pageSize: 100 + totalResults: 2401 + reportName: Cash Flow transactions report + companyName: Example Company + generatedDate: '2023-01-25T22:36:05.125Z' + dataSources: + - accounts: + - sourceRef: + sourceType: Banking + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + platformName: Plaid + accountProvider: Bank of Sandbox + accountName: Business Current Account + accountType: Debit + currency: USD + currentBalance: 1000 + identifiers: + - type: Debit + subType: Current + number: 12345678 + bankCode: 123456 + iban: US123456789 + bic: US123456789 + maskedAccountNumber: 1234 + - sourceRef: + sourceType: Banking + id: 12345678-1234-1234-1234-123456789012 + platformName: Plaid + accountProvider: Bank of Sandbox + accountName: Business Saving Account + accountType: Debit + currency: USD + currentBalance: 5321 + identifiers: + - type: Debit + subType: Saving + number: 87654321 + bankCode: 654321 + iban: US987654321 + bic: US987654321 + maskedAccountNumber: 4321 + reportItems: + - transactions: + - sourceRef: + sourceType: Banking + - accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + date: '2023-01-25' + description: Payment to supplier + amount: 100 + currency: USD + transactionCategory: + confidence: 92.7 + levels: + - Asset + - Current + - Bank + confidences: + - 92.7 + - 95 + - 96 + platformName: Plaid + counterpartyNames: + - Counterparty + modifiedDate: '2023-01-25T22:36:05.125Z' + - sourceRef: + sourceType: Banking + - accountRef: + id: 12345678-1234-1234-1234-123456789012 + name: Business Saving Account + id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + date: '2023-01-25' + description: Payment to supplier + amount: 100 + currency: USD + transactionCategory: null + confidence: 92.7 + levels: + - Expense + - Operating + confidences: + - 92.7 + - 95 + platformName: Plaid + counterpartyNames: [] + modifiedDate: '2023-01-25T22:36:05.125Z' + EnhancedFinancialReport: + title: Enhanced report type: object properties: - id: - type: string - format: uuid - example: 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b - description: Unique identifier of the event. - eventType: - type: string - description: The type of event. - examples: - - client.rateLimit.reset - - client.rateLimit.reached - generatedDate: - $ref: '#/components/schemas/DateTime' - description: The date time in UTC the event was generated in Codat. - payload: - $ref: '#/components/schemas/ClientRateLimitWebhook/definitions/clientRateLimitWebhookPayload' + reportInfo: + $ref: '#/components/schemas/EnhancedFinancialReport/definitions/enhancedReportInfo' + reportItems: + type: array + description: An array of report items. + items: + title: Report item + type: object + properties: + date: + $ref: '#/components/schemas/DateTime' + description: Last date of the period. + balance: + type: number + format: decimal + description: Balance of the account as reported on the profit and loss or Balance sheet. + accountName: + type: string + description: Name of the account. + accountId: + type: string + description: The unique account ID. + accountCategory: + $ref: '#/components/schemas/EnhancedFinancialReport/definitions/enhancedReportAccountCategory' definitions: - clientRateLimitWebhookPayload: - title: Client rate limit webhook payload + enhancedReportAccountCategory: + title: Account category + descrciption: 'An object containing the suggested or confirmed account categories, up to five levels.' type: object properties: - dailyQuota: - type: integer - description: The number of available requests per day. - quotaRemaining: - type: integer - description: Total number of requests remaining for your client. - expiryDate: + status: + type: string + description: 'Returns a status of "Suggested" or "Confirmed". If an account has a confirmed category, it will replace any suggested category returned.' + levels: + type: array + items: + $ref: '#/components/schemas/EnhancedFinancialReport/definitions/accountCategoryLevel' + accountCategoryLevel: + title: Account category level + description: An object containing an ordered list of account category levels. + type: object + properties: + levelName: + type: string + description: Account category name. + confidence: + type: number + format: decimal + description: Confidence level of the category. This will only be populated where `status` is `Suggested`. + enhancedReportInfo: + type: object + properties: + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + description: Currency of the P&L/Balance sheet. + reportName: + type: string + description: The name of the report. + companyName: + type: string + description: Name of the company queried. + generatedDate: $ref: '#/components/schemas/DateTime' - description: The date time in UTC when your daily quota is reset. - Companies: - title: Companies - x-internal: true - allOf: - - type: object - properties: - results: - type: array - items: - $ref: '#/components/schemas/Company' - - 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' - 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: Returns the YYYY-MM-DD datetime of report generation. + examples: + - reportInfo: + reportName: EnhancedProfitAndLossAccounts + companyName: ABC LTD + generatedDate: '2022-01-01' + reportItems: + - date: '2022-01-01' + balance: 70 + accountName: Sales UK + accountId: 13931cbf-ea06-4d6e-9538-a8457fa66011 + accountCategory: + status: Suggested + levels: + - levelName: Income + confidence: 0.95 + - levelName: Revenue + confidence: 0.9 + - date: '2022-01-01' + balance: 30 + accountName: Sales US + accountId: 13931cbf-ea06-4d6e-9538-a8457fa66011 + accountCategory: + lastUpdated: '2022-01-02' + status: Suggested + levels: + - levelName: Income + confidence: 0.95 + - levelName: Revenue + confidence: 0.9 + - date: '2022-01-01' + balance: 70 + accountName: Amazon + accountId: 13931cbf-ea06-4d6e-9538-a8457fa66011 + accountCategory: + lastUpdated: '2022-01-02' + status: Suggested + levels: + - levelName: Income + confidence: 0.95 + - levelName: Revenue + confidence: 0.95 + - levelName: Online + confidence: 0.8 + EnhancedInvoicesReport: + title: Enhanced invoices report + description: The enhanced invoices report takes the key elements of the Invoices report verifying those marked as paid in the accounting software have actually been paid by matching with the bank statement. type: object - allOf: - - $ref: '#/components/schemas/Company/definitions/companyDetails' - - type: object - properties: - dataConnections: - type: array - items: - $ref: '#/components/schemas/Connection' + properties: + reportInfo: + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/reportInfo' + reportItems: + type: array + items: + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/enhancedInvoiceReportItem' definitions: - companyDetails: - title: Company details + lendingCustomerRef: type: object properties: id: - $ref: '#/components/parameters/companyId/schema' - name: + minLength: 1 type: string - description: The name of the company - example: Codat Ltd. - description: - $ref: '#/components/schemas/CompanyRequestBody/properties/description' - nullable: true - redirect: + description: '`id` from the Customers data type.' + customerName: type: string - format: uri - description: 'The `redirect` [Link URL](https://docs.codat.io/auth-flow/authorize-hosted-link) enabling the customer to start their auth flow journey for the company.' - example: 'https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739' - lastSync: - $ref: '#/components/schemas/DateTime' nullable: true - created: + description: '`customerName` from the Customer data type.' + payment: + title: Enhanced invoice payment item + type: object + properties: + id: + type: string + description: 'ID of the invoice, which may be a GUID but it may be something else depending on the accounting software.' + date: $ref: '#/components/schemas/DateTime' - createdByUserName: + paymentType: type: string - description: Name of user that created the company in Codat. - nullable: true - products: - type: array - items: - type: string - description: An array of products that are currently enabled for the company. - tags: - title: Tags - type: object - maxProperties: 10 - propertyNames: - pattern: '^.{1,27}$' - additionalProperties: - type: string - maxLength: 100 - description: A collection of user-defined key-value pairs that store custom metadata against the company. - referenceParentCompany: - $ref: '#/components/schemas/Company/definitions/companyReference' - nullable: true - description: The parent entity or controlling organization of this company. Null if the company has no parent. - referenceSubsidiaryCompanies: + description: The type of payment. + amount: + type: number + format: decimal + description: Payment amount. + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + currencyRate: + $ref: '#/components/schemas/AccountingPaymentAllocation/definitions/paymentAllocationPayment/properties/currencyRate' + bankingTransactionRefs: type: array - nullable: false - description: A list of subsidiary companies owned or controlled by this entity. Empty if the company has no children. - minItems: 0 items: - $ref: '#/components/schemas/Company/definitions/companyReference' - required: - - id - - name - - redirect - companyReference: - title: Company reference + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/bankingTransactionRef' + bankingTransactionRef: + title: Banking transaction reference type: object properties: id: - $ref: '#/components/parameters/companyId/schema' - name: - $ref: '#/components/schemas/Company/definitions/companyDetails/properties/name' + type: string + description: Unique identifier for the bank transaction. + dataConnectionId: + type: string + description: Unique identifier of the bank transaction's connection. + accountId: + type: string + description: Unique identifier of the bank transaction's account. + accountName: + type: string + description: Name given to account. + date: + $ref: '#/components/schemas/DateTime' description: - $ref: '#/components/schemas/Company/definitions/companyDetails/properties/description' - links: - type: object - description: A collection of links for the company. - properties: - portal: - type: string - format: uri - description: Link to the company page in the portal. - tags: - $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' - examples: - - id: 0498e921-9b53-4396-a412-4f2f5983b0a2 - name: string - redirect: 'https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739' - lastSync: '2022-01-01T12:00:00.000Z' - created: '2022-01-01T12:00:00.000Z' - createdByUserName: string - tags: - region: us - uid: f6b0c253-16c7-4da1-a0c5-9c871e9c9d6c - dataConnections: - - id: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd - integrationId: bf083d72-62c7-493e-aec9-81b4dbba7e2c - integrationKey: dfxm - sourceId: bdd831ce-eebd-4896-89a7-20e5ee8989ee - platformName: Basiq - linkUrl: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' - status: Linked - lastSync: '2022-10-27T10:22:43.6464237Z' - created: '2022-10-27T09:53:29Z' - sourceType: Banking - products: - - spend-insights - - lending - CompanyAccessToken: - title: Company access token - description: Details of the access token provisioned for a company. + type: string + description: Description given to bank transaction. + amount: + type: number + description: Bank transaction amount. + format: decimal + invoiceStatus: + $ref: '#/components/schemas/AccountingInvoice/definitions/invoiceStatus' + enhancedInvoiceReportItem: + title: Enhanced invoice report item + type: object + allOf: + - type: object + properties: + id: + type: string + description: 'ID of the invoice, which may be a GUID but it may be something else depending on the accounting software.' + invoiceNumber: + type: string + description: Invoice number. + customerRef: + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/lendingCustomerRef' + issueDate: + $ref: '#/components/schemas/DateTime' + dueDate: + $ref: '#/components/schemas/DateTime' + status: + $ref: '#/components/schemas/AccountingInvoice/definitions/invoiceStatus' + currency: + $ref: '#/components/schemas/SourceAccount/properties/currency' + totalAmount: + type: number + format: decimal + description: Invoice's total amount. + amountDue: + type: number + format: decimal + description: Invoice's total amount due. + payments: + type: array + items: + $ref: '#/components/schemas/EnhancedInvoicesReport/definitions/payment' + paidOnDate: + $ref: '#/components/schemas/DateTime' + - $ref: '#/components/schemas/CommerceOrder/allOf/3' + reportInfo: + title: Report information + type: object + description: 'Report additional information, which is specific to Lending reports.' + properties: + pageNumber: + type: integer + description: The number of the page queried. + pageSize: + type: integer + description: The number of transactions returned per page. + totalResults: + type: integer + description: The total number of transactions available for a company for the period specified in the query string. + reportName: + type: string + description: Name of the report. + companyName: + type: string + description: The name of the company being queried. + generatedDate: + type: string + description: Date the report was generated. + examples: + - Example 1: + value: + pageNumber: 0 + pageSize: 0 + totalResults: 0 + reportName: string + companyName: string + generatedDate: '2023-01-26T07:36:40.487Z' + ErrorMessage: + title: Error message type: object - allOf: - - $ref: '#/components/schemas/CompanyAccessToken/definitions/accessToken' + x-internal: true + properties: + statusCode: + type: integer + description: The HTTP status code returned by the error. + service: + type: string + description: Codat's service the returned the error. + error: + type: string + description: A brief description of the error. + correlationId: + type: string + description: Unique identifier used to propagate to all downstream services and determine the source of the error. + validation: + $ref: '#/components/schemas/ErrorMessage/definitions/errorValidation' + canBeRetried: + type: string + description: '`True` if the error occurred transiently and can be retried.' + detailedErrorCode: + type: integer + description: Machine readable error code used to automate processes based on the code returned. definitions: - accessToken: - title: Access token + errorValidation: + title: Validation error + type: object + nullable: true + description: 'A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here.' + properties: + errors: + type: array + nullable: true + items: + $ref: '#/components/schemas/ErrorMessage/definitions/errorValidationItem' + warnings: + type: array + nullable: true + items: + $ref: '#/components/schemas/ErrorMessage/definitions/errorValidationItem' + errorValidationItem: + title: Validation error item type: object properties: - expiresIn: - type: integer - description: The number of seconds until the access token expires. - example: 86400 - accessToken: + itemId: + type: string + nullable: true + description: Unique identifier for a validation item. + message: type: string - description: The access token for the company. - tokenType: + nullable: true + description: A message outlining validation item's issue. + validatorName: 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. + nullable: true + description: Name of validator. + ExcelStatus: type: object + title: Excel status properties: - companyName: - type: string - nullable: false - description: Name of the linked company. - baseCurrency: - type: string - nullable: false - description: Currency set in the accounting software of the linked company. - planType: + lastGenerated: + $ref: '#/components/schemas/DateTime' + description: The date and time of when the generation of the most recent report was initiated. + inProgress: + type: boolean + description: 'When true, the request was successful and the report is being generated. If false, the request was unsuccessful and the report is not being generated.' + queued: type: string - nullable: true - description: 'Accounting software subscription type such as Trial, Demo, Standard.' - multicurrencyEnabled: + description: The date and time of when a successful request was queued for the most recent report. + success: 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 - CompanyRequestBody: - title: Create company request - x-internal: true - type: object - properties: - name: + description: True if the requested report was successfully queued and false if the requested report was not able to be queued. + errorMessage: type: string - description: Name of company being connected. - pattern: '^[A-Za-z0-9\s\-'',&@.,?!\s]+$' - minLength: 1 - example: Bank of Dave - description: + description: Error details in case the report generation request was unsuccessful. + lastInvocationId: type: string - example: Requested early access to the new financing scheme. - description: 'Additional information about the company. This can be used to store foreign IDs, references, etc.' - tags: - $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' - required: - - name - CompanyUpdateRequest: - title: Update company request - x-internal: true - type: object - properties: - name: + description: A unique ID generated for this request. + reportType: + $ref: '#/components/schemas/ExcelStatus/definitions/excelReportTypes' + fileSize: + type: integer + nullable: true + description: The file size in Bytes is populated upon successful generation of the report. + definitions: + excelReportTypes: type: string - description: Name of company being connected. - pattern: '^[A-Za-z0-9\s\-'',&@.,?!\s]+$' - minLength: 1 - example: Bank of Dave - description: - $ref: '#/components/schemas/CompanyRequestBody/properties/description' - tags: - $ref: '#/components/schemas/Company/definitions/companyDetails/properties/tags' - Connection: - title: Connection - description: "\uFEFF\x41\x20\x63\x6F\x6E\x6E\x65\x63\x74\x69\x6F\x6E\x20\x72\x65\x70\x72\x65\x73\x65\x6E\x74\x73\x20\x61\x20\x5B\x63\x6F\x6D\x70\x61\x6E\x79\x27\x73\x5D\x28\x68\x74\x74\x70\x73\x3A\x2F\x2F\x64\x6F\x63\x73\x2E\x63\x6F\x64\x61\x74\x2E\x69\x6F\x2F\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" + enum: + - audit + - enhancedFinancials + - enhancedInvoices + - enhancedCashFlow + description: The type of the report requested in the query string. + examples: + - lastGenerated: '2023-01-25T22:36:05.125Z' + inProgress: true + queued: '2023-01-25T22:36:05.125Z' + success: true + errorMessage: string + lastInvocationId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 + reportType: string + fileSize: 0 + File: + title: File type: object properties: - id: - $ref: '#/components/parameters/connectionId/schema' - integrationId: - type: string - format: uuid - example: fd321cb6-7963-4506-b873-e99593a45e30 - description: A Codat ID representing the integration. - integrationKey: + fileName: type: string - description: A unique four-character ID that identifies the platform of the company's data connection. This ensures continuity if the platform changes its name in the future. - sourceId: + nullable: true + description: The file's name. + displayName: type: string - format: uuid - example: 35b92968-9851-4095-ad60-395c95cbcba4 - description: 'A source-specific ID used to distinguish between different sources originating from the same data connection. In general, a data connection is a single data source. However, for TrueLayer, `sourceId` is associated with a specific bank and has a many-to-one relationship with the `integrationId`.' + nullable: true + description: An optional display name for the file. sourceType: - title: Source Type - description: The type of platform of the connection. - type: string - enum: - - Accounting - - Banking - - BankFeed - - Commerce - - Expense - - Other - - Unknown - example: Accounting - platformName: type: string - description: Name of integration connected to company. - linkUrl: - type: string - format: uri - description: The link URL your customers can use to authorize access to their business application. - example: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/2e2eb431-c1fa-4dc9-93fa-d29781c12bcd/start' - status: - $ref: '#/components/schemas/Connection/definitions/dataConnectionStatus' - lastSync: - $ref: '#/components/schemas/DateTime' nullable: true - created: + description: The source of the file uploaded. + uploaded: $ref: '#/components/schemas/DateTime' - dataConnectionErrors: - type: array - nullable: true - items: - $ref: '#/components/schemas/Connection/definitions/dataConnectionError' - connectionInfo: - type: object - nullable: true - additionalProperties: true additionalProperties: false + Files: + title: Files + type: array + items: + $ref: '#/components/schemas/File' + FileUpload: + title: Attachment upload + type: object + x-internal: true required: - - id - - integrationId - - integrationKey - - sourceId - - platformName - - linkUrl - - status - - created - - sourceType + - file + properties: + file: + $ref: '#/components/schemas/FileUpload/definitions/codatFile' definitions: - dataConnectionStatus: - title: Data connection status - description: The current authorization status of the data connection. + codatFile: type: string - enum: - - PendingAuth - - Linked - - Unlinked - - Deauthorized - dataConnectionError: - title: Data connection error + description: The file to be uploaded as an attachment. + format: binary + FinancialSummary: + title: Closed Books Indicator + type: object + properties: + booksClosedDate: type: object + description: The date time in UTC the books closed. properties: - statusCode: + date: type: string - description: The HTTP status code returned by the source platform when the error occurred. - statusText: + format: date-time + description: The date time in UTC the books closed. + example: '2025-05-31T00:00:00Z' + reason: + type: array + description: List of reasons explaining the books closed date. + items: + type: string + example: + - One or more accounts show a deviation from expected movements for March 2025 + - One of the marketing accounts haven't been booked for February 2025 + - One of the inventory accounts haven't been booked for March 2025 + accountingScore: + type: object + description: 'A score based on data completeness, accuracy, consistency, and presentation of data and the reasons for the score.' + properties: + score: + type: number + format: decimal + description: The accounting score value. + example: 90 + reason: + type: array + description: List of reasons explaining the accounting score. + items: + type: string + example: + - Balance sheet is unbalanced. + - Negative Tangible Assets on Balance Sheet + - Negative Accounts Receivable on Balance Sheet + LoanSummary: + title: Loan summary + type: object + properties: + reportInfo: + $ref: '#/components/schemas/LoanSummary/definitions/loanSummaryReportInfo' + reportItems: + type: array + description: Returns a summary of all loan activity for that integration type + items: + $ref: '#/components/schemas/LoanSummary/definitions/loanSummaryReportItem' + definitions: + loanSummaryReportInfo: + title: Loan Summary Report Info + type: object + properties: + reportName: type: string - description: A non-numeric status code/text returned by the source platform when the error occurred. - errorMessage: + description: The name of the report. + companyName: type: string - description: A message about a error returned by Codat. - erroredOnUtc: + description: Name of the company queried. + generatedDate: $ref: '#/components/schemas/DateTime' - status: - title: Error status - description: The current status of a transient error. Null statuses indicate that the error is not transient. + description: Returns the YYYY-MM-DD datetime of report generation. urns the YYYY-MM-DD datetime of report generation. + loanRef: + title: Loan Reference + type: object + properties: + id: type: string - nullable: true - enum: - - Active - - Resolved - resolvedOnUtc: - description: The datetime in Utc that the error was resolved. - nullable: true + description: The id of the object being referred to. + dataConnectionId: + type: string + description: The dataConnectionId the object being referred to is associated with. + x-stoplight: + id: vrnhmgrfndjhh + type: + type: string + description: 'The object type data is referring to, e.g. Account.' + loanSummaryRecordRef: + title: Item reference + type: object + properties: + id: + type: string + description: The id of the object being referred to. + dataConnectionId: + type: string + description: The dataConnectionId the object being referred to is associated with. + integrationType: + $ref: '#/components/schemas/LoanSummary/definitions/loanSummaryIntegrationType' + recordRefType: + $ref: '#/components/schemas/LoanSummary/definitions/loanSummaryRecordRefType' + loanSummaryReportItem: + type: object + properties: + recordRef: + $ref: '#/components/schemas/LoanSummary/definitions/loanSummaryRecordRef' + description: Contains object that contains a summary of all loan transactions for that integration type. + description: + type: string + description: The description of the object being referred to. E.g. the account. + startDate: $ref: '#/components/schemas/DateTime' - dataConnectionSourceType: - title: Source Type - description: The type of platform of the connection. + description: The date of the earliest loan transaction. + totalDrawdowns: + type: number + format: decimal + description: The total loan drawdowns. + totalRepayments: + type: number + format: decimal + description: The total loan repayments which includes capital plus any interest. + balance: + type: number + format: decimal + description: The loan outstanding balance. This may not equal totalDrawdowns - totalRepayments due to interest which has been accrued. + lender: + type: string + description: The name of lender providing the loan. + loanSummaryIntegrationType: + title: Integration type type: string enum: - Accounting - Banking - - BankFeed - Commerce - - Expense - - Other - - Unknown - example: Accounting - example: - id: ee2eb431-c0fa-4dc9-93fa-d29781c12bcd - integrationId: bf083d72-62c7-493e-aec9-81b4dbba7e2c - integrationKey: dfxm - sourceId: bdd831ce-eebd-4896-89a7-20e5ee8989ee - platformName: Basiq - linkUrl: 'https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/ee2eb431-c0fa-4dc9-93fa-d29781c12bcd/start' - status: Linked - lastSync: '2022-10-27T10:22:43.6464237Z' - created: '2022-10-27T09:53:29Z' - sourceType: Banking - Connections: - title: Connections + description: The integration type begin referred to. + loanSummaryRecordRefType: + title: Record reference type + type: string + enum: + - accounts + - banking-accounts + - commerce-transactions + description: The datatype being referred to. + examples: + - reportInfo: + reportName: LoanSummaryReport + companyName: The Coffee shop + generatedDate: '2022-10-23T00:00:00Z' + reportItems: + - recordRef: + id: string + dataConnectionId: DE34E8E3-089F-4DF4-89E9-F7C43618FCAAA + integrationType: Accounting + recordRefType: accounts + description: string + startDate: '2021-01-01' + totalInvestments: 100000 + totalRepayments: 83481.72 + balance: 42513.18 + lender: Barclays Bank + LoanTransactions: + title: Loan transactions + type: object + properties: + reportInfo: + $ref: '#/components/schemas/LoanTransactions/definitions/loanTransactionsReportInfo' + reportItems: + type: array + description: Contains object of reporting properties. The loan ref will reference a different object depending on the integration type. + items: + $ref: '#/components/schemas/LoanTransactions/definitions/reportItems' + definitions: + loanTransactionsReportInfo: + title: Loan Transactions Report Info + type: object + properties: + pageNumber: + type: integer + description: The page number. + pageSize: + type: integer + description: Queried page size. + totalResults: + type: integer + description: The total number of transactions returned. + reportName: + type: string + description: The name of the report. + companyName: + type: string + description: Name of the company queried. + generatedDate: + $ref: '#/components/schemas/DateTime' + description: Returns the YYYY-MM-DD datetime of report generation. + loanRef: + title: Loan Reference + type: object + properties: + id: + type: string + description: The id of the object being referred to. + dataConnectionId: + type: string + description: The dataConnectionId the object being referred to is associated with. + type: + type: string + description: 'The object type data is referring to, e.g. Account.' + itemRef: + title: Item reference + type: object + properties: + id: + type: string + description: 'The id of the object, e.g. the Journal entry.' + dataConnectionId: + type: string + description: The data connection id being referenced. + type: + type: string + description: The data type the loan transaction entry was extracted from. + reportItems: + type: object + properties: + loanRef: + $ref: '#/components/schemas/LoanTransactions/definitions/loanRef' + description: Contains object that contains all the Loan transactions for that integration type. + itemRef: + $ref: '#/components/schemas/LoanTransactions/definitions/itemRef' + description: Contains object of reporting properties. The loan ref will reference a different object depending on the integration type. + date: + $ref: '#/components/schemas/DateTime' + description: The date of that entry type occurred. + amount: + type: number + format: decimal + description: The loan transaction amount. + loanTransactionType: + description: The type of loan transaction. + type: string + enum: + - Investment + - Repayment + - Interest + - AccuredInterest + lender: + type: string + description: The name of lender providing the loan. + examples: + - reportInfo: + pageNumber: 1 + pageSize: 1000 + totalResults: 1 + reportName: AccountingLoanTransactions + companyName: Supermarket store + generatedDate: '2022-10-23T00:00:00Z' + reportItems: + - loanRef: + id: '332' + dataConnectionId: ecd2d6be-5194-40a1-838f-5577a4881aaa + type: chartOfAccount + itemRef: + id: '755488' + dataConnectionId: ecd2d6be-5194-40a1-838f-5577a4881aaa + type: journalEntry + date: '2020-08-02' + amount: -455 + transactionType: Repayment + lender: Barclays Bank + Metadata: + title: Metadata + type: object x-internal: true - allOf: - - type: object - properties: - results: - type: array - items: - $ref: '#/components/schemas/Connection' - - $ref: '#/components/schemas/Companies/allOf/1' - CreateBankTransactions: - title: Create bank transactions + properties: + isDeleted: + type: boolean + description: Indicates whether the record has been deleted in the third-party system this record originated from. + nullable: true + PagingInfo: type: object + title: Pagination information + x-internal: true properties: - accountId: - type: string - description: Unique identifier for a bank account. + 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: - - 13d946f0-c5d5-42bc-b092-97ece17923ab - - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 - - '7110701885' - - EILBDVJVNUAGVKRQ - - Checking 0202 - transactions: - $ref: '#/components/schemas/BankTransactions' + - 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: - - accountId - - transactions - CreateBankTransactionsResponse: - title: Create bank transaction response - x-internal: true - allOf: - - type: object - properties: - data: - $ref: '#/components/schemas/CreateBankTransactions' - - $ref: '#/components/schemas/PushOperation' - 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 + - pageNumber + - pageSize + - totalResults + - _links 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." - ErrorMessage: - title: Error message + - pageNumber: 1 + pageSize: 10 + totalResults: 1 + _links: + self: + href: '/companies/{id}/data/{dataType}' + current: + href: '/companies/{id}/data/{dataType}?page=1&pageSize=10' + PaymentMethodRef: + type: object + title: Payment method reference + description: The payment method the record is linked to in the accounting or commerce software. + properties: + id: + description: The unique identifier of the location being referenced. + type: string + name: + description: Name of the location being referenced. + type: string + required: + - id + example: + id: EILBDVJVNUAGVKRQ + name: AliPay + PhoneNumber: + title: Phone type: object x-internal: true properties: - statusCode: - type: integer - description: The HTTP status code returned by the error. - service: + number: type: string - description: Codat's service the returned the error. - error: + nullable: true + examples: + - +44 25691 154789 + - (877) 492-8687 + - 01224 658 999 + description: A phone number. + type: + description: The type of phone number type: string - description: A brief description of the error. - correlationId: + enum: + - Primary + - Landline + - Mobile + - Fax + - Unknown + required: + - type + ProjectRef: + title: 'Accounting: Project reference' + x-internal: true + required: + - id + type: object + properties: + id: + minLength: 1 type: string - description: Unique identifier used to propagate to all downstream services and determine the source of the error. - validation: - $ref: '#/components/schemas/ErrorMessage/definitions/errorValidation' - canBeRetried: + description: Unique identifier to the project reference. + name: type: string - description: '`True` if the error occurred transiently and can be retried.' - detailedErrorCode: - type: integer - description: Machine readable error code used to automate processes based on the code returned. - definitions: - errorValidation: - title: Validation error - type: object nullable: true - description: 'A human-readable object describing validation decisions Codat has made. If an operation has failed because of validation errors, they will be detailed here.' - properties: - errors: - type: array - nullable: true - items: - $ref: '#/components/schemas/ErrorMessage/definitions/errorValidationItem' - warnings: - type: array - nullable: true - items: - $ref: '#/components/schemas/ErrorMessage/definitions/errorValidationItem' - errorValidationItem: - title: Validation error item - type: object - properties: - itemId: - type: string - nullable: true - description: Unique identifier for a validation item. - message: - type: string - nullable: true - description: A message outlining validation item's issue. - validatorName: - type: string - nullable: true - description: Name of validator. + description: The project's name. PullOperation: title: Pull operation description: |- @@ -4288,7 +83505,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 @@ -4301,7 +83518,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' @@ -4398,7 +83615,7 @@ components: type: string description: Unique identifier for a push operation. dataType: - $ref: '#/components/schemas/DataType' + $ref: '#/components/schemas/DataStatus/properties/dataType' nullable: true additionalProperties: false pushOperationStatus: @@ -4431,7 +83648,7 @@ components: type: array items: $ref: '#/components/schemas/PushOperation' - - $ref: '#/components/schemas/Companies/allOf/1' + - $ref: '#/components/schemas/PagingInfo' PushOption: title: Push option x-internal: true @@ -4559,6 +83776,78 @@ components: $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/description' required: $ref: '#/components/schemas/PushOption/definitions/pushOptionProperty/properties/required' + ReportLine: + x-internal: true + type: object + title: 'Accounting: Report line' + properties: + accountId: + type: string + nullable: true + description: 'Identifier for the account, unique for the company in the accounting software.' + name: + type: string + nullable: true + description: Name of the report line item. + value: + type: number + format: decimal + description: Numerical value of the line item. + items: + type: array + nullable: true + description: An array of ReportLine items. + items: + $ref: '#/components/schemas/ReportLine' + required: + - value + ReportOperation: + title: Report + type: object + properties: + id: + type: string + format: uuid + description: Unique identifier of the report + example: 52c0f26b-051a-43ff-b02a-258eec67f5ef + status: + type: string + enum: + - InProgress + - Complete + - Error + description: The status of the report generation. + type: + type: string + enum: + - categorizedBankStatement + - creditModel + - spendAnalysis + description: The name of the generated report. + requestedDate: + description: The date and time on which the report was requested. + $ref: '#/components/schemas/DateTime' + updatedDate: + description: The date and time on which the report was last updated. + $ref: '#/components/schemas/DateTime' + errorMessage: + type: string + nullable: true + description: A short message describing any errors that occurred while generating the report. + description: Information about report generation. + definitions: + reports: + title: Reports + allOf: + - type: object + properties: + results: + type: array + items: + $ref: '#/components/schemas/ReportOperation' + minLength: 0 + maxLength: 2000 + - $ref: '#/components/schemas/PagingInfo' SourceAccount: title: Source account (v1) type: object @@ -4665,56 +83954,6 @@ components: 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 - 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: - type: string - description: Unique ID for the source account. - examples: - - '12345' - result: - 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: string - examples: - - A bank account already exists with the same Id SourceAccountV2: title: Source account (v2) type: object @@ -4906,187 +84145,53 @@ components: 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: - 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: - 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 - 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 + StartUploadSessionRequest: + title: Upload session start request 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: + properties: + dataType: type: string - format: date-time + enum: + - banking-accounts + - banking-transactions + description: A key for a Codat data type. + 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 - description: 'The UTC timestamp when the sync execution ended, if completed (i.e. `status` is any value other than `Started`).' - errorMessage: + ThirdPartySchema: + title: Third-party schema + description: The format should be identical to the file format receieved from the third-party banking source (e.g. Plaid or TrueLayer). + type: object + x-speakeasy-type-override: any + WebLink: + title: Weblink + description: Weblink associated with the company. + type: object + properties: + type: + description: The type of the weblink. type: string - nullable: true - description: Error message if the sync failed. - errorCode: + enum: + - Website + - Social + - Unknown + url: + description: The full URL for the weblink. 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 + format: url + example: + type: Website + url: 'https://codat.io' parameters: - companyId: - name: companyId - in: path - required: true - schema: - type: string - format: uuid - example: 8a210b68-6988-11ed-a1eb-0242ac120002 - description: Unique identifier for your SMB in Codat. - description: Unique identifier for a company. - connectionId: - name: connectionId - in: path - required: true - schema: - type: string - format: uuid - example: 2e9d2c44-f675-40ba-8049-353bfcb5e171 - description: Unique identifier for a company's data connection. - description: Unique identifier for a connection. - 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. page: name: page in: query @@ -5124,9 +84229,29 @@ components: type: string example: '-modifiedDate' description: 'Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results).' + companyId: + name: companyId + in: path + required: true + schema: + type: string + format: uuid + example: 8a210b68-6988-11ed-a1eb-0242ac120002 + description: Unique identifier for your SMB in Codat. + description: Unique identifier for a company. + connectionId: + name: connectionId + in: path + required: true + schema: + type: string + format: uuid + example: 2e9d2c44-f675-40ba-8049-353bfcb5e171 + description: Unique identifier for a company's data connection. + description: Unique identifier for a connection. dataType: name: dataType - description: The key of a Codat data type + description: A key for a Codat data type. in: path required: true schema: @@ -5140,6 +84265,233 @@ components: format: uuid description: Unique identifier for the dataset that completed its sync. description: Unique identifier for the dataset that completed its sync. + dataIntegrityDataType: + name: dataType + in: path + required: true + schema: + type: string + enum: + - banking-accounts + - banking-transactions + - bankAccounts + - accountTransactions + example: banking-accounts + description: A key for a Codat data type. + reportDate: + name: reportDate + in: query + schema: + type: string + example: 29-09-2020 + description: 'The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.' + reportDateRequired: + name: reportDate + in: query + required: true + schema: + type: string + example: 29-09-2020 + description: 'The date in which the report is created up to. Users must specify a specific date, however the response will be provided for the full month.' + periodLength: + name: periodLength + in: query + required: true + schema: + type: integer + description: The number of months per period. E.g. 2 = 2 months per period. + numberOfPeriods: + name: numberOfPeriods + in: query + required: false + schema: + type: integer + description: 'The number of periods to return. If not provided, 12 periods will be used as the default value.' + numberOfPeriodsRequired: + name: numberOfPeriods + in: query + required: true + schema: + type: integer + description: The number of periods to return. There will be no pagination as a query parameter. + periodUnit: + name: periodUnit + in: query + required: true + schema: + type: string + enum: + - Day + - Week + - Month + - Year + description: The period unit of time returned. + includeDisplayNames: + name: includeDisplayNames + in: query + schema: + type: boolean + description: Shows the dimensionDisplayName and itemDisplayName in measures to make the report data human-readable. + excelReportType: + name: reportType + in: query + schema: + $ref: '#/components/schemas/ExcelStatus/definitions/excelReportTypes' + description: The type of report you want to generate and download. + required: true + accountingAccountId: + name: accountId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for an account. + accountingBillPaymentId: + name: billPaymentId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a bill payment. + accountingBillId: + name: billId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a bill. + attachmentId: + name: attachmentId + in: path + required: true + schema: + type: string + format: uuid + example: 8a210b68-6988-11ed-a1eb-0242ac120002 + description: Unique identifier for an attachment. + accountingDirectCostId: + name: directCostId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a direct cost. + accountingDirectIncomeId: + name: directIncomeId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a direct income. + accountingInvoiceId: + name: invoiceId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for an invoice. + accountingSupplierId: + name: supplierId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a supplier. + accountingReportDate: + name: reportDate + in: query + schema: + type: string + format: date + example: '2022-12-31' + description: Date the report is generated up to. + accountingNumberOfPeriods: + name: numberOfPeriods + in: query + schema: + type: integer + format: int32 + example: 12 + description: Number of periods to include in the report. + accountingPeriodLengthDays: + name: periodLengthDays + in: query + schema: + type: integer + format: int32 + example: 30 + description: The length of period in days. + accountingPeriodLength: + name: periodLength + description: Number of months defining the period of interest. + in: query + required: true + schema: + type: integer + format: int32 + example: 4 + accountingPeriodsToCompare: + name: periodsToCompare + description: Number of periods with `periodLength` to compare. + in: query + required: true + schema: + type: integer + format: int32 + example: 20 + accountingStartMonth: + name: startMonth + in: query + schema: + $ref: '#/components/schemas/DateTime' + description: The month the report starts from. + customerId: + name: customerId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a customer. timeoutInMinutes: name: timeoutInMinutes in: query @@ -5147,6 +84499,93 @@ components: type: integer format: int32 description: Time limit for the push operation to complete before it is timed out. + allowSyncOnPushComplete: + name: allowSyncOnPushComplete + in: query + schema: + type: boolean + default: true + description: Allow a sync upon push completion. + forceUpdate: + name: forceUpdate + in: query + schema: + type: boolean + default: false + description: 'When updating data in the destination platform Codat checks the `sourceModifiedDate` against the `lastupdated` date from the accounting software, if they''re different Codat will return an error suggesting you should initiate another pull of the data. If this is set to `true` then the update will override this check.' + pushOperationKey: + name: pushOperationKey + schema: + type: string + format: uuid + in: path + required: true + description: Unique identifier for the push operation. + paymentId: + name: paymentId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a payment. + productId: + name: productId + in: path + required: true + schema: + type: string + examples: + - 13d946f0-c5d5-42bc-b092-97ece17923ab + - 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2 + - 7110701885 + - EILBDVJVNUAGVKRQ + description: Unique identifier for a product. + path: + name: path + description: The endpoint path of the third-party banking service that the request body originates from. Only required if the source is not `codat`. + in: query + required: false + schema: + type: string + enum: + - auth/get + reportType: + name: reportType + description: The type of the report + in: path + required: true + schema: + type: string + enum: + - categorizedBankStatement + - creditModel + reportId: + name: reportId + description: 'Unique identifier for a report, use either the Id of the report or `latest` for the most recently generate report.' + in: path + required: true + schema: + oneOf: + - type: string + title: ID + format: uuid + example: 8a210b68-6988-11ed-a1eb-0242ac120002 + - type: string + title: Latest + enum: + - latest + maxAge: + description: The maximum age of report to fetch. + name: maxAge + in: query + required: false + schema: + $ref: '#/components/schemas/DateTime' responses: BadRequest: description: The request made is not valid. @@ -5336,3 +84775,270 @@ components: type: apiKey in: header x-speakeasy-example: Basic BASE_64_ENCODED(API_KEY) + examples: + CodatBankStatementUploadConfiguration: + value: + source: codat + accountId: abc123-ABC + summary: Settings for uploading codat data + EnhancedCashflowExample: + value: + reportInfo: + pageNumber: 1 + pageSize: 10 + totalResults: 2194 + reportName: Cash flow transactions report + companyName: test + generatedDate: '2023-03-24T16:44:17.5302732Z' + dataSources: + - accounts: + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Savings Account + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Banking - Business Credit Card + accountType: Credit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Undeposited Funds + accountType: Debit + currency: GBP + currentBalance: 0 + - sourceRef: + sourceType: Banking + platformName: Banking Sandbox + accountProvider: Lloyds Bank + accountName: Business Current Account + accountType: Debit + currency: GBP + currentBalance: 0 + reportItems: + - transactions: + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: ab5e07a0-5578-4d91-8421-2dc72713b74f + date: '2022-11-08T00:00:00' + description: Payment m86SDGpQr3 + amount: -6905.44 + currency: GBP + transactionCategory: + confidence: 52.53 + levels: + - Expense + - Operating + confidences: + - 56 + - 52.53 + platformName: Shopify + counterpartyNames: + - Shopify + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: 9846bbed-46d3-472c-a848-1ce8ebea7213 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 4332.84 + currency: GBP + transactionCategory: + confidence: 88 + levels: + - Expense + confidences: + - 88 + platformName: Amazon + counterpartyNames: + - Amazon + - Amazon Marketplace + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 94b213fb-d742-435e-90f1-bfe723a076d5 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 4034.3 + currency: GBP + transactionCategory: + confidence: 61.08 + levels: + - Income + - Revenue + confidences: + - 65 + - 61.08 + platformName: Shopify + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: cfceb7ff-eaa2-45b6-aca7-fa0e0b439161 + date: '2022-11-08T00:00:00' + description: Payment to supplier 78792d13-90a0-4ea2-8e07-81c3c893997e + amount: -313.76 + currency: GBP + transactionCategory: + confidence: 40.98 + levels: + - Expense + - CostOfSales + confidences: + - 40.98 + - 99.9 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: ba814f14-0fe3-41d0-9308-57f40642ac75 + date: '2022-11-08T00:00:00' + description: Payment to supplier 46d2e1fb-b4e9-469c-814a-21ff8105a26e + amount: -614.4 + currency: GBP + transactionCategory: + confidence: 55.84 + levels: + - Income + - Revenue + confidences: + - 55.84 + - 75.5 + platformName: Zettle + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: e67cc30e-fd5c-4eea-8365-ec40dfdd3ef6 + date: '2022-11-08T00:00:00' + description: Payment from customer a5c68c7b-6825-46de-bf63-6ad23ef506a4 + amount: 5199.62 + currency: GBP + transactionCategory: + confidence: 57.85 + levels: + - Expense + confidences: + - 57.85 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a + name: Business Current Account + id: e0f08a0b-3575-4dde-98c4-3c854028d2d2 + date: '2022-11-08T00:00:00' + description: Payment to supplier 18ac18dc-945b-4083-9013-e8a100b999fa + amount: -21420.94 + currency: GBP + transactionCategory: + confidence: 70.58 + levels: + - Expense + - Operating + confidences: + - 70.58 + - 100 + platformName: Amazon + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 4b70d379-8284-4f44-bb37-c7935df950cc + date: '2022-11-08T00:00:00' + description: Payment to supplier 630a3f16-5f01-4986-ae6b-82333ec49449 + amount: -30924.22 + currency: GBP + transactionCategory: + confidence: 48.26 + levels: + - Income + confidences: + - 48.26 + platformName: DoorDash + counterpartyNames: [] + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: 76b73373-9345-472e-8edf-5be849d797fe + date: '2022-11-08T00:00:00' + description: Payment to supplier bQATU4eSb9 + amount: -568.78 + currency: GBP + transactionCategory: + confidence: 65.21 + levels: + - Income + - Revenue + confidences: + - 65.21 + - 100 + platformName: Uber + counterpartyNames: + - Uber + modifiedDate: '2022-11-08T12:00:00' + - sourceRef: + sourceType: Banking + accountRef: + id: 809b9470-c9fa-4257-bc9f-06a1dc7b0cbc + name: Business Undeposited Funds + id: ee92fd6f-e0f7-4391-85fd-4b50921b973f + date: '2022-11-08T00:00:00' + description: Payment to supplier 9c37eb21-579a-4886-8296-3a853076b7bd + amount: -13050.79 + currency: GBP + transactionCategory: + confidence: 92.33 + levels: + - Income + - Revenue + confidences: + - 92.33 + - 92.33 + platformName: DoorDash + counterpartyNames: + - DoorDash + modifiedDate: '2022-11-08T12:00:00' + SingleReportExample: + value: + id: 6e9bae88-72c9-45ae-abe8-41fbf2871458 + status: InProgress + type: categorizedBankStatement + requestedDate: '2024-09-27T04:43:41Z' + updatedDate: '2024-10-01T14:41:46Z' diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock index 72e34ef1..1c2a3243 100644 --- a/.speakeasy/workflow.lock +++ b/.speakeasy/workflow.lock @@ -1,4 +1,4 @@ -speakeasyVersion: 1.761.1 +speakeasyVersion: 1.761.5 sources: bank-feeds-source: sourceNamespace: bank-feeds-source @@ -9,11 +9,10 @@ sources: - 3.0.0 lending-source: sourceNamespace: lending-source - sourceRevisionDigest: sha256:7149d024c5bf2bf2ebf21d7a0dd81541b8737274458d8a3535c66bae43ec52f4 - sourceBlobDigest: sha256:f44b8b8db2e4c91dc3b443995ba4912363c5ae28b0b762c386273adef38bd4ed + sourceRevisionDigest: sha256:0a00d892955d2cc912bd47adf1de8b2a84bd3485a3359565572f79ef5e7b2c5b + sourceBlobDigest: sha256:152325157f20a95fe6446fc06c82dd9669c1d0f3083208ff5086f78f823c8b78 tags: - latest - - speakeasy-sdk-regen-1770204374 - 3.0.0 platform-source: sourceNamespace: platform-source @@ -70,10 +69,10 @@ targets: lending-library: source: lending-source sourceNamespace: lending-source - sourceRevisionDigest: sha256:7149d024c5bf2bf2ebf21d7a0dd81541b8737274458d8a3535c66bae43ec52f4 - sourceBlobDigest: sha256:f44b8b8db2e4c91dc3b443995ba4912363c5ae28b0b762c386273adef38bd4ed + sourceRevisionDigest: sha256:0a00d892955d2cc912bd47adf1de8b2a84bd3485a3359565572f79ef5e7b2c5b + sourceBlobDigest: sha256:152325157f20a95fe6446fc06c82dd9669c1d0f3083208ff5086f78f823c8b78 codeSamplesNamespace: lending-source-csharp-code-samples - codeSamplesRevisionDigest: sha256:3e4978bd8e0f762acc2df2152f45fb793431920135d23f2cb5d641853facc25f + codeSamplesRevisionDigest: sha256:85be91f3addbe61def24ccacc12cee07f117aa9273d8dac77eaebc64dc287ba8 platform-library: source: platform-source sourceNamespace: platform-source diff --git a/lending/.gitignore b/lending/.gitignore index a3f0a5df..3119dd72 100755 --- a/lending/.gitignore +++ b/lending/.gitignore @@ -1,3 +1,4 @@ +.speakeasy/reports .DS_Store **/.speakeasy/temp/ **/.speakeasy/logs/ diff --git a/lending/.speakeasy/gen.lock b/lending/.speakeasy/gen.lock index 231c0e3b..7b1857f8 100755 --- a/lending/.speakeasy/gen.lock +++ b/lending/.speakeasy/gen.lock @@ -1,42 +1,43 @@ lockVersion: 2.0.0 id: 35d91636-e73c-4697-a088-5369539eda61 management: - docChecksum: 9c447111606083b3e909a159cdbccbff + docChecksum: e847b688674aebeca362f82e6bf8bf3a docVersion: 3.0.0 - speakeasyVersion: 1.701.0 - generationVersion: 2.803.3 - releaseVersion: 10.0.1 - configChecksum: b2dc7cd5793412b3df69a7678603bcf4 + speakeasyVersion: 1.761.5 + generationVersion: 2.879.13 + releaseVersion: 10.0.2 + configChecksum: 70ebdfa8b2eae3ed8a2882a40e0818a0 repoURL: https://github.com/codatio/client-sdk-csharp.git repoSubDirectory: lending + installationURL: https://github.com/codatio/client-sdk-csharp published: true persistentEdits: - generation_id: 6b695a40-413a-40b5-8ab3-ab0acae8bfe4 - pristine_commit_hash: 7525ac9ce1881a12be38fa38c519252a7379ec51 - pristine_tree_hash: 8cd595122864616d251031d29d20748b3708004f + generation_id: f917a054-b6dc-4a7b-9f20-779e87680ad3 + pristine_commit_hash: ec61ba63e3003496943c7be7ba80956166c90067 + pristine_tree_hash: 9cfda3197acc30c78de596bc334f4ea19fe265df features: csharp: additionalDependencies: 0.1.0 - constsAndDefaults: 0.0.1 - core: 3.15.9 + constsAndDefaults: 0.0.3 + core: 3.15.20 decimal: 0.1.0 deprecations: 2.81.2 - examples: 2.81.6 - globalSecurity: 2.83.8 + examples: 2.81.7 + globalSecurity: 2.83.11 globalSecurityCallbacks: 0.1.0 globalSecurityFlattening: 0.1.0 - globalServerURLs: 2.83.0 + globalServerURLs: 2.83.1 groups: 2.81.3 intellisenseMarkdownSupport: 0.1.0 methodArguments: 0.2.1 - nameOverrides: 2.81.2 + nameOverrides: 2.81.4 nullables: 0.1.1 responseFormat: 0.0.4 - retries: 0.0.1 + retries: 0.0.2 sdkHooks: 0.3.0 serverEventsSentinels: 0.2.0 typeOverrides: 2.81.1 - unions: 1.1.1 + unions: 1.1.2 webhooks: 1.0.0 trackedFiles: .gitattributes: @@ -49,20 +50,20 @@ trackedFiles: pristine_git_object: dd0fc763bd9548f5c8c2606f525bf5bee3b4feff Codat/Lending/AccountBalances.cs: id: 61a13e127407 - last_write_checksum: sha1:6d60cca902322595772889bab501c4ba6ac7a1b1 - pristine_git_object: ea8c7a40956030a20a4ee2cbffab9358a2241c59 + last_write_checksum: sha1:4962f3b5d609bc7915c658c558068ab48c2a750d + pristine_git_object: ac9e0ea41917c67665cbb823840ced45100e3128 Codat/Lending/AccountTransactions.cs: id: ec378eb222bb - last_write_checksum: sha1:55d9f2dcc5759f2f084346ec7a6ec7fc85279633 - pristine_git_object: 68331c6e168fbdb893a1c9f4f4956b5af98e428b + last_write_checksum: sha1:1a28f995c4eb74446bf51973a06fa3ae5a4e95a1 + pristine_git_object: 89d83ce55462d0c7b2aa3b41d7889ea9f6417062 Codat/Lending/AccountingBankData.cs: id: f6180ea41391 - last_write_checksum: sha1:37e0a264d0231728a0c3cc7591db7099cf2d4f27 - pristine_git_object: 1f29f351aa3c4b2ecd0d154b35c9ccf9b12b39ff + last_write_checksum: sha1:b283d8aa44561abffaea0abf08b977c4950c26fb + pristine_git_object: 6ce62f28247f5647f140d6bc4122a3a8f71cd60f Codat/Lending/Accounts.cs: id: 8b1ddea19c0e - last_write_checksum: sha1:dd4df98fbceabf839a66bfde1c3d15f9d20a20f9 - pristine_git_object: 2782c2d55fcfb012ae000d6728bec448aa120add + last_write_checksum: sha1:a303b08c6deb07163ac7091be031a53de4ad9587 + pristine_git_object: bf04f395341ad0c86cbdc8fc3d1b01b13da6fe83 Codat/Lending/AccountsPayable.cs: id: ac58fd4a5786 last_write_checksum: sha1:afd34ebc8906e910410d0f404fd785220b0d500e @@ -73,148 +74,148 @@ trackedFiles: pristine_git_object: f84d462eb60cfec750ad6f26a888365ff743f454 Codat/Lending/BalanceSheet.cs: id: edd50f9219c6 - last_write_checksum: sha1:69712d66aaa9fe2e374348d7d779ff8fcf2513f5 - pristine_git_object: 456650b6b550a7302aaefccdd10a294e855cf089 + last_write_checksum: sha1:06c24f5e29644d818dca76945c6f323651777178 + pristine_git_object: cafeba485bdc7eb1fee8099cfe3ecfe8f5eeacbb Codat/Lending/BankAccounts.cs: id: 758ebe6f36b1 - last_write_checksum: sha1:e530eef21544bc79123738607ad35d91606abd60 - pristine_git_object: e3f348787f2c75686f8c06959d70a9577484fbfb + last_write_checksum: sha1:db1111b91212fc0a1366bbc3da24d2ac416263b9 + pristine_git_object: 4d839b19985f1f4f8c3cd4319d5ad19b062c39b9 Codat/Lending/BankStatements.cs: id: 3b460250a2a1 - last_write_checksum: sha1:b7e8d10fc97c6862bc281b6ebcc87b849efda711 - pristine_git_object: 398a465fad0797fc080d842ede8fed159623f176 + last_write_checksum: sha1:a57739a7666a404180efe82f214d2e47db3f0db4 + pristine_git_object: 5f9814a5966c7549a0db811792b474aed72080cd Codat/Lending/BankTransactions.cs: id: 56875543d8d5 - last_write_checksum: sha1:ff21a582e3c96d46665deb53a8469b6d1e178953 - pristine_git_object: 672375d998a8059c40deba9464b2a93dfbd16633 + last_write_checksum: sha1:171167d746b71051570a331453326350d8627f68 + pristine_git_object: 8902eaf4a20263477783eb2e9bfbf4a384d6ec91 Codat/Lending/Banking.cs: id: dd0ee0faaac6 last_write_checksum: sha1:2fcdb97040c7628856b002122339aaad03f0a492 pristine_git_object: b6e17d5ba348b10e1625d941b9df9f8916c56ddb Codat/Lending/BillCreditNotes.cs: id: 49ce0ab178b6 - last_write_checksum: sha1:a322285a1cd7eb880ace72ac9c6f5b2e5945a1b6 - pristine_git_object: d85dbc4b6aba3501ede38e023d5849baccb47f16 + last_write_checksum: sha1:4bc4f66c281d4bc28667ddd4ed2aa92cc254f190 + pristine_git_object: 6efe957ed80d03355dff3d8023bda069ceccfcf5 Codat/Lending/BillPayments.cs: id: e750780e6199 - last_write_checksum: sha1:d777c13dded30041689984836ebd833b246fa8a4 - pristine_git_object: 80446e5aeab59f39f5a00f16d09c8126d1b67bcd + last_write_checksum: sha1:952023ccc06d3c60a954ae87e40ce7c93cca3b8d + pristine_git_object: 147898b8302a203722f44395b0ccce533b14c4c5 Codat/Lending/Bills.cs: id: 051e1bdbec0a - last_write_checksum: sha1:1102aedbb0b391e9f037b4ab5a89058541305704 - pristine_git_object: 235484273523ebe276591b57fcd09bf7abe72d80 + last_write_checksum: sha1:1bf122846671795869463015a698bf73d0d61b53 + pristine_git_object: b839e6c6cb37eb04bfffd517d5398e7154ff2f8e Codat/Lending/CashFlow.cs: id: e3d8574d52fd - last_write_checksum: sha1:471756424d0776628ed309fe5193fcba202b8cf2 - pristine_git_object: e43b8e3b5b8fd7cce64cf7bce23cc8f097587da9 + last_write_checksum: sha1:8f81dc6e0dd9efdef4083db13df86b3be4da3474 + pristine_git_object: 405751c3f70ada366710335786ab11b12bbdd541 Codat/Lending/CategorizedStatement.cs: id: 0a3bd0e30e3c - last_write_checksum: sha1:f34ff4e188594c1c9d4db9e573c51315de85335d - pristine_git_object: b4be1965ec1334191b621075e508e6ba5f6f35ce + last_write_checksum: sha1:fe10a36691e945beca1cc28c601db1debb0bf0ee + pristine_git_object: eac759869697e21cf5c03a693b33af5554896c34 Codat/Lending/Codat.Lending.csproj: id: 0d0ff25563e3 - last_write_checksum: sha1:ffededdea115cbffa627603b064068476dd529e9 - pristine_git_object: c88d46496f6ae966eb008b48af78d066d4e3b263 + last_write_checksum: sha1:622d57f34222959be2fe06c847de6026d480fa44 + pristine_git_object: 87a79ba915e099091f5bde3a78aa7acaeb20160e Codat/Lending/CodatLending.cs: id: 0cd451e759dc last_write_checksum: sha1:6a551d54c5e7127214725bbeb4131bdecb7d269b pristine_git_object: c91360b0c6ffc014a1b024b8fd69fc2a7d0a25b9 Codat/Lending/CodatLendingAccounts.cs: id: 69b6dbc92708 - last_write_checksum: sha1:e2e5cbd26a05e7bb363d4dac59e61ccf550c6de9 - pristine_git_object: bb5ca19a1c442fc14bb498a4a191dcdf161be798 + last_write_checksum: sha1:3fdf0b4fc9598e78076a5519d096e25013116fff + pristine_git_object: a1ba067c920b4a462ab54dff3acf73df748dc8eb Codat/Lending/CodatLendingBankingAccounts.cs: id: 4e2a13f18dcd - last_write_checksum: sha1:6b0f86ff92b5da8afca505d55c73851c47435efa - pristine_git_object: d8b41658e53dab49f5bd8c2a5219eae12fabf86c + last_write_checksum: sha1:81dc303a7d348d34760c45ba93bc3d687ffb9519 + pristine_git_object: cf1cf87dcf77f894c1256afef79ed9b4a14c3d11 Codat/Lending/CodatLendingCustomers.cs: id: 62623e0a444f - last_write_checksum: sha1:c4e602462f45cdb01f967b4fff054fa72d771b88 - pristine_git_object: c10743767cb797409ab825de881c4e765e5d7223 + last_write_checksum: sha1:3e54d1f6e3a642ad87b5dd22866d649db8c26d54 + pristine_git_object: ed4f4693f9c4b77d8c7004a89225fa11150d3400 Codat/Lending/CodatLendingDirectCosts.cs: id: 29b43364b2d5 - last_write_checksum: sha1:a54edc5910fc6e9f28899c8e9daf4906f4ade478 - pristine_git_object: 77998db8176a062c23526970a1319af946e31b29 + last_write_checksum: sha1:31000885af4e864914fc9c16b8e348c3e39d9c95 + pristine_git_object: 535df396d9d93fbc76fe355e70f3d53e1abf3d57 Codat/Lending/CodatLendingLoanWritebackAccounts.cs: id: 05e59742aff7 - last_write_checksum: sha1:19a37acc3799e86b1ab06f5fd9c3de6e54c46e21 - pristine_git_object: 2ee069d7cba4b97845c79b5618e2b8a72342dffb + last_write_checksum: sha1:a8710ec38b539af50e9c7867990890bcaf4ba1bb + pristine_git_object: 8eaf78c5841e6be57b4f493ea9e75b6d74b4620c Codat/Lending/CodatLendingLoanWritebackPayments.cs: id: e4a3ae7f7dd4 - last_write_checksum: sha1:c5a9dbcff3c5d40dffe748c463033708e189ec4b - pristine_git_object: d920ee12b3e395372a2b4dbbf36be356f01c766b + last_write_checksum: sha1:c4ff4d2869d0e814a31a0ad7a0d7fa1c3fd43f41 + pristine_git_object: 1bbcd6ff2d84142bac942c3513a7113a54995873 Codat/Lending/CodatLendingPayments.cs: id: 25eba761f532 - last_write_checksum: sha1:c2c613eb0e0848ada3cf7a38e557581273dea8f8 - pristine_git_object: 93480b4bb21c2bf430702c486209a49153157a3e + last_write_checksum: sha1:70383d491c80f269cb341201d8ed55d7267ce941 + pristine_git_object: 5c9d9662a08b692ec99b547c4f2808ba2a78f533 Codat/Lending/CodatLendingReports.cs: id: 3156dbae9e30 - last_write_checksum: sha1:6e658011ab5724f62239d5fcb2b24d47b87b93f9 - pristine_git_object: 4b242d0426b8216a7159bbdce332cd22bf6acfd7 + last_write_checksum: sha1:1217bf9e02281f0d93a0743ee86d69a1b937406f + pristine_git_object: 950612b079e34782b22ef179016043c5b0bbf3c1 Codat/Lending/CodatLendingSalesTransactions.cs: id: f718594b3b96 - last_write_checksum: sha1:5b7a31779dad7f146ad5496c9dbf3f2f150bdda8 - pristine_git_object: 79c5c493b24c0452a8eac349d81a36ca0b106ba8 + last_write_checksum: sha1:7b83740611cf31357451ed3f6bd9c2c142db50fb + pristine_git_object: 63832e32cb5c4ad6ffd86a022b553c915db77c21 Codat/Lending/CodatLendingSuppliers.cs: id: 000de83a7d04 - last_write_checksum: sha1:6d4e4dae4c2597014ca232ec8e5ba13fb7386b65 - pristine_git_object: 38888f78097503d9a1a83f07e1c204689ccfdd94 + last_write_checksum: sha1:38e4c14616cb928ed041290cb841c550beaf5548 + pristine_git_object: 810f58a9c0baf21f28d00ff51d10acff716ee211 Codat/Lending/CodatLendingTransactions.cs: id: 48a61364024d - last_write_checksum: sha1:1b9cbb04c5c8559535fd5cdd7db4befe979c16b4 - pristine_git_object: 36ea629c4ca5e25d14d5f4cdbce7438046425b5a + last_write_checksum: sha1:7498c8e99d28305eb54e8d9c4ecfc6daaf09420b + pristine_git_object: dcabf119b6710411acd506d7ee3cd6ce194112a5 Codat/Lending/CodatLendingTransfers.cs: id: 44b6e8986525 - last_write_checksum: sha1:067fa51c6915c5f3f98bafc4142bf9445aa1a2c9 - pristine_git_object: a00d2977b9d1513eb20fe6448f2cfcbffe059e14 + last_write_checksum: sha1:beee7f6d695435199d10638a75a1e289b119d0ae + pristine_git_object: 20ca53a13a21a83d9f44e5ea107952577011256a Codat/Lending/Companies.cs: id: aa390ab32eef - last_write_checksum: sha1:b2825fa7c888bcd833b7b41f22b15fc0560da55f - pristine_git_object: 324feedc78542ff5164dca37f061d67f843c86fe + last_write_checksum: sha1:56fcfe334bb9330b4d30fa43ea80fc2a741a3665 + pristine_git_object: 1ea9edcf1c339aa33e7b69d0b85ccc149ecfd574 Codat/Lending/CompanyInfo.cs: id: 10e3edcabee3 - last_write_checksum: sha1:3446a9dcc942b828cab6aa8b92bb137514887038 - pristine_git_object: 118828ffe672fb80b124434624addbb6a715d7c6 + last_write_checksum: sha1:915da4d2ee7d97886bc85752b89dc285ba3045fe + pristine_git_object: b855e1d8e3a14a050af8cc92f90031743b884865 Codat/Lending/Connections.cs: id: c02484f8a3a8 - last_write_checksum: sha1:5f4efe49f0ce28dea7750bb604995e4676790091 - pristine_git_object: a9e94918b4a204c46457ef688520b7f3ba94452c + last_write_checksum: sha1:984fd60180c97039c61f00a32aabc12172364252 + pristine_git_object: 340504e9f439535922208310ea6787d79ca2a6d3 Codat/Lending/CreateOperations.cs: id: 8f6b71a4062e - last_write_checksum: sha1:ebe14e774145fbabc1e43c89659773eb9186122b - pristine_git_object: 04b9befd4adb69d03a63f488f275866a61e6694a + last_write_checksum: sha1:aad8b5bfbfd1579b3fc9e4a3be665a4a542e04bf + pristine_git_object: d9e507a5e80055b30dc365cc4b59cd1f19285123 Codat/Lending/CreditNotes.cs: id: 2ec2bda4f2d7 - last_write_checksum: sha1:46e9efdb3bc36fcb9eff57c53d4b32bf2ea141c5 - pristine_git_object: 82d53cfbed8b69e09a9aa5035681e2f6dfd3166f + last_write_checksum: sha1:581529b626d32ffbdfdbac78b5b030b3b46d9745 + pristine_git_object: 4a1712ae74712d77258c82340a94784a9738ba96 Codat/Lending/Customers.cs: id: 37084fde8854 - last_write_checksum: sha1:b35cda27e5d4aeefafbdf8ce9cdd1b2111e3df3b - pristine_git_object: 506a16ba2d2c72ee17af9ff314f132b8d529595f + last_write_checksum: sha1:1033c2f895121e91f99ba2fae3c9593ce003c180 + pristine_git_object: e78dc64bb25c965ba564df5e39e2167941637707 Codat/Lending/DataIntegrity.cs: id: ace899aba277 - last_write_checksum: sha1:72c472ca02788f53c5bf8273c8ba6482f5206038 - pristine_git_object: 80641bbda388656602267ada3e51b72656b1528e + last_write_checksum: sha1:d1228f7695e55dd0196ada8661ec0f2d8edcebbc + pristine_git_object: c36dbed3a754e0183eb65842bbd959a04541dc41 Codat/Lending/DirectCosts.cs: id: 9174cacd2644 - last_write_checksum: sha1:477030b99c4952dda85e0b6af0007c7388fa1a1a - pristine_git_object: ed0abc024104161df594ccb1fce99850f09b6d58 + last_write_checksum: sha1:e97632bd2b55d1dff19e3f35614785d2273d9adf + pristine_git_object: dd2c27a0916b85c8789470a990309a00ac7fcc75 Codat/Lending/DirectIncomes.cs: id: 6afdd2b31623 - last_write_checksum: sha1:cfcadd63163fd3d76100e5a172006a6a691efc7a - pristine_git_object: d543291d6fc27bf94a072f4ceb7585720ffc6803 + last_write_checksum: sha1:529786d82cdaf9d325bd821b45d06facd4175970 + pristine_git_object: 1f6cf730fdffa76e4cfe9af3303b737758033175 Codat/Lending/Disputes.cs: id: 09385a911974 - last_write_checksum: sha1:57b50829c5c9f03089f38e6979fbd84c6668a2c7 - pristine_git_object: c7827ced0c9638d23abe968245ac3699f93ce63d + last_write_checksum: sha1:2442d6741669846b32f370a6a22cde6d2a84adad + pristine_git_object: 4f1f3c535ce20546710de8d249b3c29b4b83b26b Codat/Lending/ExcelReports.cs: id: 569b49a9d3ce - last_write_checksum: sha1:73fd46c83f7016a6a29910944bb4065e3ddf1969 - pristine_git_object: 332de610bb73fd12cce830370cb03570f75cd0bf + last_write_checksum: sha1:2f94ca4e4bf723591c01502c4af38a59627178ac + pristine_git_object: 2bd5a215feee6100ed9996f84b7339893e87973f Codat/Lending/FileUpload.cs: id: 8cdfb9881ce9 - last_write_checksum: sha1:c74385134f3ef0bbf72c1e6ba7b00bba0858deb2 - pristine_git_object: 47efe95b012cdf7b02ba1c806dbfdd629c75ea76 + last_write_checksum: sha1:23cbbf86f490eb7062816ea061527f8797b89dcb + pristine_git_object: 1f848fa065167c10408938c61794f56caae39ffd Codat/Lending/FinancialStatements.cs: id: 6be629ea2964 last_write_checksum: sha1:56250301a0d14200a735ff987e515ed529ec5431 @@ -229,40 +230,40 @@ trackedFiles: pristine_git_object: dc90041b82e932bf04bd771ffb5d7bec4b6e36af Codat/Lending/Invoices.cs: id: c33b167a8df1 - last_write_checksum: sha1:29ef2410207e5320046da10193103e15b0856092 - pristine_git_object: 9cda2c8ad13f65565f512b7e75c2090825056009 + last_write_checksum: sha1:bae279ffc901ab06e413282b7e7b248e91ae61a7 + pristine_git_object: ecad71fa78d9c3efe383c9080fc166e0059153a7 Codat/Lending/JournalEntries.cs: id: 21a85e4bb52f - last_write_checksum: sha1:e6f88832148cda10014916a78876f7af070ace6d - pristine_git_object: c5739e7118eccfaacea416ea1aa3a3308cd7c5a8 + last_write_checksum: sha1:430ac99495dba86123dcb4eb7eca38940fca05e8 + pristine_git_object: 8a93856039c61e79f6a5d8aa313ee8eed7b76f6f Codat/Lending/Journals.cs: id: d9e245de93fe - last_write_checksum: sha1:511d8e8295f29d84ff9ba51476995e7b715ab80f - pristine_git_object: 20a2e75626020c987a6a6e3a157cb1b97408b54f + last_write_checksum: sha1:f18ae88c6233d40604ddbfcc2f8310a8f64fe68a + pristine_git_object: f0975eb56169f496b48cf9b21c4f1dea64f95459 Codat/Lending/Liabilities.cs: id: 66c801b11294 - last_write_checksum: sha1:0312c088129adcdfde89558a3e4c2ee4e93187ea - pristine_git_object: 1766819e4248cef54e22b0bd091df45fb49f8a4b + last_write_checksum: sha1:951bbc00c072d1f834c92cb1cd5f22ad6542d601 + pristine_git_object: 7c78ac823dd011766d49040c44a867fc5bf915a0 Codat/Lending/LoanWriteback.cs: id: 973d271f91fc last_write_checksum: sha1:a646c5de963b913b14e70c0df066833c3e02637d pristine_git_object: 11c3658e5095cc1d3c9670c80ca67f8e98070f6b Codat/Lending/Locations.cs: id: d52deed38107 - last_write_checksum: sha1:7d4348bf0f7607a0906f12f35d571ca53424dd66 - pristine_git_object: 684ded218d1312c08d1bbdcdf2c952a3628b5250 + last_write_checksum: sha1:dc9a9a4555328c8194f4ea797d37a1596d476ab7 + pristine_git_object: d87f000542012e2119fd84f9964c028dbbb405cc Codat/Lending/ManageData.cs: id: 75b953997d4a - last_write_checksum: sha1:f9076a23e282c327f257cddb31a5d885026e3c37 - pristine_git_object: 80fbda9dcc39ecfb56f65e0c06d77b1edeb43ef5 + last_write_checksum: sha1:f80e5b35d967397dfa8b60087a0238aaee581b87 + pristine_git_object: 0e205bf72399cee0170130ff4cda6a9fee84126b Codat/Lending/ManageReports.cs: id: bfa11f6bbb9f - last_write_checksum: sha1:1c70c070e5a8ba6403154827b245e175ca5c09e7 - pristine_git_object: 511a60dc53b6c113a8130d1c4d6a9a8a449fab09 + last_write_checksum: sha1:4f79e0fe3ce4b5fa1a5032add671c0d5645c2fae + pristine_git_object: 8c523668ccbbacfb6fdd3f7fef814e4972e67487 Codat/Lending/Metrics.cs: id: 3c2a34c8194e - last_write_checksum: sha1:b587813ac4d104250aae0ac00e38e9a599592ed5 - pristine_git_object: ab2bd601b01b9efcc0288ea2b5c190e858b4e44b + last_write_checksum: sha1:0d0b8c909e62a5d1e442e89bb77f57e342a59117 + pristine_git_object: 480e7c929b4ea45fb6762ea552059ac08493a20a Codat/Lending/Models/Components/AccountBalance.cs: id: 161b936a0702 last_write_checksum: sha1:9f0fa4b9c1b0ed54c6db1a2c1b5084ef021de3cd @@ -913,8 +914,8 @@ trackedFiles: pristine_git_object: 598d3e84df8b5790c72e9255cfd9cf99f482aeaa Codat/Lending/Models/Components/Connection.cs: id: b4b771a64df3 - last_write_checksum: sha1:d154dbe3fd81f8c79de59894a4947cb14d7b7c7a - pristine_git_object: 6a329fb2bba86127e3fa9ef7984cc172a7fc3a0b + last_write_checksum: sha1:9cdca1f8d846f789344b9a30f23fd36422657dd2 + pristine_git_object: e3bc340869a741f911b4bc5e109edb5551ef175b Codat/Lending/Models/Components/Connections.cs: id: ccc9978a53e5 last_write_checksum: sha1:ddf40ec28a99140fff332680a773f2169862f681 @@ -2933,68 +2934,68 @@ trackedFiles: pristine_git_object: de051e5456b1eaa5f157af38b897d26cb7531d5c Codat/Lending/Orders.cs: id: ff6d031b4fe6 - last_write_checksum: sha1:27b1c15bfe60f3044df6de193c157e5e1ceeadac - pristine_git_object: 60835c37b34a11543e5def7a6bcf033b98414d61 + last_write_checksum: sha1:92ebc219056fbd7c51e3fbc98242408b9d1cdf77 + pristine_git_object: 16bd7c41477dc45897a3f9ba5e0c7c1201ef8b59 Codat/Lending/PaymentMethods.cs: id: ab99cea4d371 - last_write_checksum: sha1:46df6540dd74ba476545623801dfab3ba7728384 - pristine_git_object: 24e2ce2d33fd5c1a1c426047513a93e0f0207b73 + last_write_checksum: sha1:a626b9f2e40b2dbd778f15dc51d813d97db15659 + pristine_git_object: b547239a9c5a9c57e091da8692f29fb3587778c2 Codat/Lending/Payments.cs: id: 4b71bad22fd4 - last_write_checksum: sha1:1fe955a268fb55a0dbf419378b5e2a3a2328985e - pristine_git_object: f08f6a8b35ef9daf2d54ec004a41186791c3cd29 + last_write_checksum: sha1:37eced265ab5b43300ef4bfc7fe50d77c73ee668 + pristine_git_object: 38be54acab0588b732c296969a1e1d5d48df6dbd Codat/Lending/ProductCategories.cs: id: eb90b39516b7 - last_write_checksum: sha1:9a8ae97b86a68b3aa712cef367a4b05624eea9c1 - pristine_git_object: 818bc821aab0ca41b21befd62e5fb5c17bab865a + last_write_checksum: sha1:a0e623bcf4abc97c22e62957612d05db6a31e21e + pristine_git_object: b780452bda1d169c7c9bd1bc1a6bd330a6a68d24 Codat/Lending/Products.cs: id: b4e7bf592db4 - last_write_checksum: sha1:da5838d2f221fc0272f25b322e6ac54dec368af1 - pristine_git_object: c9ecff241c1279f97b54508791d4e4b3b73768c2 + last_write_checksum: sha1:6131e05ad16ee115cbd8f79d772c2f8342a05a8b + pristine_git_object: 45a53722ff2d747c8dcf1d0e9661ba12e957e438 Codat/Lending/ProfitAndLoss.cs: id: 9c541445abde - last_write_checksum: sha1:61c470f841e3c754181591d1620782d1eed145b0 - pristine_git_object: 25a1ac27dbfe908101e4d38f011e94f6fd886aaf + last_write_checksum: sha1:53ded6fa293945546c057fe8a28d78fb5ae8b711 + pristine_git_object: e333f68b6de6bf34fefe6b7b73d07842c4a2ddb3 Codat/Lending/PullOperations.cs: id: 4c5865cd974a - last_write_checksum: sha1:73461b2735f43a786a30640786b999400b907782 - pristine_git_object: d922614576c0d37a1deddd9222d7005b63e85c37 + last_write_checksum: sha1:aa66a8f2c1f3eee10a17fa7cf336b57195988fdd + pristine_git_object: ba9c9460c54fb25c8ae7faf50107e02586a0cca8 Codat/Lending/Refresh.cs: id: 9d21f2171509 - last_write_checksum: sha1:302e67045e1b09f21d50064c8305ab53792fcd24 - pristine_git_object: 30a98c0c1a71738bacb96f211974ff6e985bf339 + last_write_checksum: sha1:e84a4666247a226a846f9c9aa189b11a3098ee58 + pristine_git_object: acfef2849988b18c116b94aad013df64ef88d3ab Codat/Lending/Reports.cs: id: f56dbb5f4e95 - last_write_checksum: sha1:938858f84021aac3c6b763c880095cbe072e5cfc - pristine_git_object: ce5270d74e9c35cef091a06d37f55e85298fd9f1 + last_write_checksum: sha1:207c27ed367cb66564497cd49b6937a3d381a1d1 + pristine_git_object: 34e6a45dc0ce7e928535555a9f9697a1336d45e5 Codat/Lending/SDKConfig.cs: id: 2ede6f8ed1c1 - last_write_checksum: sha1:ad3354081807cdcde9fa9074bfc8b115c5723909 - pristine_git_object: 7f68a004305b56749f4173597d122f3e4f1c0d88 + last_write_checksum: sha1:9132ec061597bd3ea1b54b0c94435bfa5096e7ef + pristine_git_object: c1d6f23a147fd19f2cc196b7aac02eb5bc755464 Codat/Lending/Sales.cs: id: c60ae2e87856 last_write_checksum: sha1:1d18339426725ea721558696ee61c38a687cd38b pristine_git_object: 9ed0ed36c2dd0b984239db6bcdd413d466f01fe9 Codat/Lending/SourceAccounts.cs: id: 46ac67c5e94c - last_write_checksum: sha1:b93196d4126073c59c9fcb48d2b3559680c1de54 - pristine_git_object: b0f1c8b0d96cce5fd197d60638a43ea070009876 + last_write_checksum: sha1:d17d0fd9afb7fe40122002b0f21112e41e5141b6 + pristine_git_object: a3c0c0892b76eba76fea705aa45408607cbaad90 Codat/Lending/Suppliers.cs: id: 063fbcd90dba - last_write_checksum: sha1:5f56b7fe2e552d48cdbae9f4fc49f2b5ce38cb79 - pristine_git_object: d2cc8276e8a7c9ba36f43a8d66ed6942a8432d36 + last_write_checksum: sha1:24c1d916884abf41e2b29b25d9642b9cbf7c94ce + pristine_git_object: fe1ce32eb7f2be500c2756949d710fec6426242d Codat/Lending/TransactionCategories.cs: id: e49cd947d886 - last_write_checksum: sha1:3696161a65c29ab29f1c33983112d24b28fb9f49 - pristine_git_object: 902f309954ea3a76ebafa0627d773bb4d279ab6e + last_write_checksum: sha1:1b5a73aa894578dbdfd2ff3290f075f881d025d4 + pristine_git_object: ef00135dcc9ad9b32234f3c7fdab0a650b65e14f Codat/Lending/Transactions.cs: id: fc1202f0120c last_write_checksum: sha1:2775f47dee23900a3b3f09795972371cc14f3228 pristine_git_object: 0df74a164f57a764d2c51591e73e85c96d964aa5 Codat/Lending/Transfers.cs: id: 9922ab40c248 - last_write_checksum: sha1:95a03806e31c5270adb341a71168b2a46fdf6918 - pristine_git_object: ea28a7660685ad56e94f81a9d379fd62c372298a + last_write_checksum: sha1:d0790c8d0a145e82d8556e79406e35057da6b394 + pristine_git_object: 0c4936dcef6c642140578edf725c46a8424eb980 Codat/Lending/Utils/AnyDeserializer.cs: id: a13f585d1274 last_write_checksum: sha1:1b10199c54905d6881cee0b84cbe06b1ea2b53c6 @@ -3005,8 +3006,8 @@ trackedFiles: pristine_git_object: 1320db9c86e76521ca451a9223547cad0533d441 Codat/Lending/Utils/Constants.cs: id: 900b1be46e7b - last_write_checksum: sha1:f8662f9be653157e1dbde4b1ce81d3199047b43f - pristine_git_object: 09dce91e67f7318c9ad3b94cdc4b95ce06c820c2 + last_write_checksum: sha1:ae57c6fff4e0629a1fc7f9164d401d465e49f867 + pristine_git_object: 14a46e73df7143824556a94393ab8fa90a1d7cbc Codat/Lending/Utils/DecimalStrConverter.cs: id: 0596aaaffa75 last_write_checksum: sha1:b91014c9bf3b57b5ee79ff16c9d7b9a90626900a @@ -3033,8 +3034,8 @@ trackedFiles: pristine_git_object: d9f2faf5b3700d9a7da8dd0f7bf5b5ccdb88ffe5 Codat/Lending/Utils/RequestBodySerializer.cs: id: 98126d2c086d - last_write_checksum: sha1:0a44627c2b5045b4aa9d7f64c6af902696244df5 - pristine_git_object: e2c73a451f55b3e9f425caaed8b7e9d185b2783c + last_write_checksum: sha1:abeb22f80123fa7d24b43104e26efe88334d176a + pristine_git_object: 6aa2fdc787428f6a92c37328e16178f5cbb71390 Codat/Lending/Utils/ResponseBodyDeserializer.cs: id: c85b66bffcac last_write_checksum: sha1:6cfd4c83ec1984510e04191b991b6b26c2e42bc8 @@ -3045,32 +3046,32 @@ trackedFiles: pristine_git_object: b3f313ecfbad32d670da8c1874dcffa94b9da4b7 Codat/Lending/Utils/Retries/Retries.cs: id: 3a61cd4ff046 - last_write_checksum: sha1:e42593329d1ad4039d9926d6bd1e98744481fceb - pristine_git_object: 26a1023f806ba299a29b3a7b957a3d3fa1350d10 + last_write_checksum: sha1:b1627498eb173790c2640de9fbafa5b9ce56bef2 + pristine_git_object: dc8a81f18aa7416cb6967c5407d5160e8b3bcec3 Codat/Lending/Utils/Retries/RetryConfig.cs: id: 4eb4b5c367b5 last_write_checksum: sha1:2048da5b846720da6b2cf7b7524bd8f977c77278 pristine_git_object: d5b5fc2f9b3ddd20eda242a97c95a5c9896115ec Codat/Lending/Utils/SecurityMetadata.cs: id: e9165d12aaeb - last_write_checksum: sha1:3d3bbef9f1ea08a94621218d3fa6e4de321d13b3 - pristine_git_object: 9a1f37ce76406b50bb4919d7cca9a2bb028824b4 + last_write_checksum: sha1:c2c8f2890a135243296ed0627ac074a46a3351be + pristine_git_object: cc85352bdfd1f81c7baa047871fa66acd8e9ab2b Codat/Lending/Utils/SpeakeasyHttpClient.cs: id: 1cce1d171acf last_write_checksum: sha1:80753077c02ee5770d7789dcb800b24c0268e979 pristine_git_object: 8eccdf8dfc28c3e18873fe28d79ffc7b0e46a542 Codat/Lending/Utils/SpeakeasyMetadata.cs: id: 95c97e440493 - last_write_checksum: sha1:5567275fddb882530d68cd0293eae953c687b729 - pristine_git_object: 1ace4be7a3fc2aaf5fb86dfe3718decafeec2951 + last_write_checksum: sha1:8caa0536f7399389df2cde92779c48b934ad7a96 + pristine_git_object: 06b903395e23ed37e638a2801bcb22367093a512 Codat/Lending/Utils/URLBuilder.cs: id: 76889b274604 last_write_checksum: sha1:01122976b86ea932edfb49cb5a558a3802aa4ff2 pristine_git_object: 9dfc5823e8a44d881719d884bd9016278bb47f79 Codat/Lending/Utils/Utilities.cs: id: 6bc66c64b725 - last_write_checksum: sha1:74fae61e5734d8d0fed376be418689c10d6321a1 - pristine_git_object: ee59d7c1ab41b221b180b912083484f52c12b485 + last_write_checksum: sha1:ae9f85d83e622b4b4d65f8f1b7940c40948f0dca + pristine_git_object: aa3ac0d51567ba134127fb00a495adbbd4f0e3ee NUGET.md: id: f4c8a442a6e5 last_write_checksum: sha1:1a1a1590fbfb948e7e1814a4d7bfa79da4ed571e @@ -3081,8 +3082,8 @@ trackedFiles: pristine_git_object: 0462272e300d78f31443f80a848385081971a586 docs/Models/Components/AccountBalance.md: id: e75ca29e8717 - last_write_checksum: sha1:bec102ae67a8594902f8bc9b061731b9be4dcf5b - pristine_git_object: 91860054543f615cd06bdfef418902e0f09ce423 + last_write_checksum: sha1:7f1d6f457eecc9d75d50f8dae1327203b58fa2f4 + pristine_git_object: edeb8886d77db544ea008e7b510623150d420fa6 docs/Models/Components/AccountBalanceAmounts.md: id: 760fc3be5283 last_write_checksum: sha1:fd8cd1cc52f238e6f7765f43345666ee58509829 @@ -3101,8 +3102,8 @@ trackedFiles: pristine_git_object: e9b52ad0653c9e65ff3ec0fd7cef60f0c698d723 docs/Models/Components/AccountIdentifierType.md: id: c6535e7ff516 - last_write_checksum: sha1:e82fdfc2ab2742e6be656ada212a3985de00dc3c - pristine_git_object: 3c722650df5caaabca9a0095c60c7bce620e0cf9 + last_write_checksum: sha1:338f6e108cea123690fa40d56d5966860650634e + pristine_git_object: 01ca81092a86c97432c5749cad06359cea1dd434 docs/Models/Components/AccountIdentifiers.md: id: 7dca52395639 last_write_checksum: sha1:67b0e145e6e89eeb7b36cb08a4e3561052e3e2e1 @@ -3117,8 +3118,8 @@ trackedFiles: pristine_git_object: 83bfc1154e580e70d9542ca93674ea55fa3bce7b docs/Models/Components/AccountPrototype.md: id: 8cdcad64c0db - last_write_checksum: sha1:708b915f9839cc65a79cb3b566c93d652537635d - pristine_git_object: 4dcf0fa62773b69f936822cb5f4a78d406e8130e + last_write_checksum: sha1:eff10cc5aaf69b5079c5535b4deeb46c61df6737 + pristine_git_object: d5a4d57ea65ed6e7aad9e308190176d15f86bc33 docs/Models/Components/AccountPrototypeValidDataTypeLinks.md: id: a58258a71a3f last_write_checksum: sha1:60e13225efca84dc7b667dfa76183760ab0b4110 @@ -3129,8 +3130,8 @@ trackedFiles: pristine_git_object: 62f6df1983e6fd142fb486583ff65a7de17db00f docs/Models/Components/AccountStatus.md: id: e56505065ab2 - last_write_checksum: sha1:4c811aa55a916d05289828470737e6ad35871b08 - pristine_git_object: cddd64b3d7da64aefa7848351f3defff44589ed5 + last_write_checksum: sha1:a56e7270477d777dc371c61ab4aeaaf2aa410ef6 + pristine_git_object: ef7b575799acbfe6c46e91201c19b75245b85e5d docs/Models/Components/AccountTransactionLine.md: id: 753c0fe91bae last_write_checksum: sha1:ce89c8f5f8c579c57d5e7e4552efdcfb8297d117 @@ -3141,24 +3142,24 @@ trackedFiles: pristine_git_object: 6465d3ac93a927e41f47f27bd5f0ed74b09fa3e2 docs/Models/Components/AccountTransactionLineRecordRefDataType.md: id: 86a593ccc29a - last_write_checksum: sha1:85b7c47ba6904525c350e9955dea8ba077350a04 - pristine_git_object: a5421245551b16ce3df8c1948e574ee4d941d764 + last_write_checksum: sha1:08cd39a10607f99ec3f60222fce69146c44fc7a1 + pristine_git_object: 049d603336af931431f621e57a040d63bdf0fe05 docs/Models/Components/AccountType.md: id: 2b954dbcc0b2 - last_write_checksum: sha1:10ca58aebded67f1e12e208f3842f8e0c67a1408 - pristine_git_object: 938ae14688fb959391c95d7906b7b7ee64a84c57 + last_write_checksum: sha1:bb4d1b1d01dc633ca750ed613866e50d5a33946e + pristine_git_object: 9f8041bfefaf0a37763490d51445f970d9cce761 docs/Models/Components/AccountingAccount.md: id: 9f3d83bb3728 - last_write_checksum: sha1:310719d273fe4976db38af3ec79162f1dd3f0712 - pristine_git_object: 289e5959c6ab665adb4ad8b4bce14028e80c02a3 + last_write_checksum: sha1:f7cb73c113aa67b7971f32a827efdf2876581ff0 + pristine_git_object: 913b858e76e31d8bc13ddf98eaf2ec41151709d2 docs/Models/Components/AccountingAccountTransaction.md: id: 8bd2149fdebf - last_write_checksum: sha1:f7669f2bfe81b91d98ec0feaff0b868f9d3c261e - pristine_git_object: 6bfd1264fc6bad1bd5214bfe7f337a3682870f65 + last_write_checksum: sha1:3c9e79567d04606dd63775c7fc6d85a7f3a004ee + pristine_git_object: 5e20bfb322e784d126db0d4f80c4b877b0b4c359 docs/Models/Components/AccountingAccountTransactionStatus.md: id: 25aabe724957 - last_write_checksum: sha1:8f7bb929c885b169034dc1a6836beb930010bcc4 - pristine_git_object: 7a38d505d8bf5a69479204f793ea178ffb19545a + last_write_checksum: sha1:373fa880c5a284ff782c93bd870359098c626e1a + pristine_git_object: 1759467cb5bca3f83940d76217cf9dac748800e0 docs/Models/Components/AccountingAccountTransactions.md: id: e1d639be70f8 last_write_checksum: sha1:3c45bf6405cdb3406e0727e61d9cc6864f1cd716 @@ -3173,60 +3174,60 @@ trackedFiles: pristine_git_object: e71789507d79ed6cf3af08843e9311f67ee8e930 docs/Models/Components/AccountingAddressType.md: id: 22d4d6f3f407 - last_write_checksum: sha1:e3dc5b7d25f86a8253c301625a2ff96c7c264988 - pristine_git_object: 2c5f98c721c6a4604e410ca89be491adaa915fd4 + last_write_checksum: sha1:b7c660f87dec7853f6192e8470e2b9a8c7c43a4b + pristine_git_object: 033feda258555e45ee7d629414f8ca295ce73a7c docs/Models/Components/AccountingAgedCreditorReport.md: id: 167f712cf2fd - last_write_checksum: sha1:13368118e4cfca8c8e81ab873d0eff1de6ddf807 - pristine_git_object: 1244b2863ee1dee8a4ad73fc36ab4a9b275ce679 + last_write_checksum: sha1:c9255ede2edba2f5d6167a4d45ddbfd61b016f7c + pristine_git_object: 6ee80b3f2eae6bd7a5c563ef8755395a1a2e361d docs/Models/Components/AccountingAgedDebtorReport.md: id: ff1b8e24144a - last_write_checksum: sha1:b87b9e9be33911f71a0ffa26491e020fe936ef3c - pristine_git_object: a4c6d06f469645a9bb85dae7b2e8383d6028a2b8 + last_write_checksum: sha1:d7a3dd96f8885793bc5d29e401a214bfc9f6b952 + pristine_git_object: 608a663d91baa809fe3a874b2507f2bd9f0cae07 docs/Models/Components/AccountingAttachment.md: id: a0d8fa684ead - last_write_checksum: sha1:7460119f9b77e92fdb99c9e2c6d1af7d15698314 - pristine_git_object: 8a2f0e683abf4b6111b972f9000bb12ca2cf3dec + last_write_checksum: sha1:85985aa58513d98c1b85543fbcda79fff925b610 + pristine_git_object: 3ad20ccf7ca5b955d327a66bc624f7e530f8bd1b docs/Models/Components/AccountingBalanceSheet.md: id: 86de10f54b43 - last_write_checksum: sha1:70a88c9cd33e0e41a91aa9424f7bcf8524c5a01f - pristine_git_object: 6d6e57d58456c0f2ff14e0a9a74982aad30c94d4 + last_write_checksum: sha1:fdf5bffe072b1b31e53b65f73c047a3fb2492183 + pristine_git_object: e7712918e0e6ef26c4c85696ea061d5815debaa3 docs/Models/Components/AccountingBankAccount.md: id: 415b7dc929ff - last_write_checksum: sha1:735c5dbd41635dca57bda171cf8ac0fb85e4cc99 - pristine_git_object: 0876452e081a26a5337fe589a79457a4ca6cfaba + last_write_checksum: sha1:42cc743bd279c32d4a94f6dbef33a9be7f72421c + pristine_git_object: dfff9e24bf76a9c78fe19a7f74c88aebbc36a66e docs/Models/Components/AccountingBankAccountType.md: id: fbe95afe3b7d - last_write_checksum: sha1:5fb3fb962411f3d08cba85ee8cfc84d2aa238549 - pristine_git_object: e079af7b8313356d912bdb333bcd1bab21659721 + last_write_checksum: sha1:4a3daf86d466e6d3f7121020840436e3a48a02ab + pristine_git_object: 8e3cb2ff89081162d88043aa9d2d5dbb44187916 docs/Models/Components/AccountingBankAccounts.md: id: b065818b1a11 last_write_checksum: sha1:57afc9ab4511ad57cdd4a7e1566e8ad1c9eebfff pristine_git_object: a4e37534db5ab9e3ed85de325a01b39cb52d2351 docs/Models/Components/AccountingBankTransaction.md: id: 3511602c026f - last_write_checksum: sha1:40439392127200208559134f9d80b743e37db7f0 - pristine_git_object: c0c5ddb3673fe65cb5b9d494e544c3870a9f7e4d + last_write_checksum: sha1:b01660bd1b56b53dd52afa3c69b047eb64caa455 + pristine_git_object: b5869ff5a4e0f547ac2bdf331016e6774d89cf76 docs/Models/Components/AccountingBankTransactions.md: id: 85fd9e325180 last_write_checksum: sha1:ba2733076a83de9b17b11b4979e424407290f096 pristine_git_object: 6f0a92e51f970e29a49b5494b6f327c1b9d4e549 docs/Models/Components/AccountingBill.md: id: be8a4e72b5d5 - last_write_checksum: sha1:835913886075f0884ea456ab62f592d1a27f60d1 - pristine_git_object: 45a8922f0f06ab617073f78531688a89d6c0da81 + last_write_checksum: sha1:fc21c0568ee76e83c4d66d80d6b26ddef5c9176e + pristine_git_object: 71a8fbab14d2ec0abb2bd9202da5b22a3c696398 docs/Models/Components/AccountingBillCreditNote.md: id: 6bf13fb8a4f4 - last_write_checksum: sha1:3591dd0e353b7a7f51088242726202c89a7ae231 - pristine_git_object: 9fe5ce8e417b8e07c32132466a91c5e5298dc91e + last_write_checksum: sha1:b9d54807f1c93188e4d76b1ead6fba7761e00e9f + pristine_git_object: c9c34d7eb1463a526d13c6cd331287a3bc41d6e6 docs/Models/Components/AccountingBillCreditNotes.md: id: 0dff8375fedf last_write_checksum: sha1:24611a45f8054493d9395353e21a9a50b22987e2 pristine_git_object: a18bdbef50bc8c871af4688cf8776110d7543271 docs/Models/Components/AccountingBillPayment.md: id: d5801c994236 - last_write_checksum: sha1:4aaa3765f2acbb54523c19602f081bd3900413f6 - pristine_git_object: 55f5c64d8d3ec586317ae34b56fbb2a835643de6 + last_write_checksum: sha1:78656e4a1840a1872affde52f3dd9ab4985f7f79 + pristine_git_object: be955f7bae83e8035187f8dc5e9f3fd2de0f4d9b docs/Models/Components/AccountingBillPayments.md: id: 2484ed130655 last_write_checksum: sha1:e74e651a605343191f78f6a6b61392c389c0c31e @@ -3237,92 +3238,92 @@ trackedFiles: pristine_git_object: 677251bec145c30d987d37525e42e82b43438ccc docs/Models/Components/AccountingCashFlowStatement.md: id: f237dbe6c721 - last_write_checksum: sha1:09103c9ba6e8b439a1a89d037ffd47eec7280cfe - pristine_git_object: b567c612dc506fde6ce54aa64298e301e4aed570 + last_write_checksum: sha1:8784cc1e17db81eae61ddda95bd1f63b30896905 + pristine_git_object: 0a69988b0bad531dc5633aadc558e941d43745d6 docs/Models/Components/AccountingCompanyInfo.md: id: 8ebc49b1e8a1 - last_write_checksum: sha1:56a2ddcf54caaec1421a7a5e0facedbbff3b3c5d - pristine_git_object: dc0d4bdc2eefcd3a73f080425fc191a172635538 + last_write_checksum: sha1:ba5d301ec384eae75173cca1880af95aec5c488d + pristine_git_object: 03d2d56ff67a0fd31c9173d17106acddbf0e8fe7 docs/Models/Components/AccountingCreateAccountResponse.md: id: 15e974c1d11b - last_write_checksum: sha1:8a0b509d5183a2924114fb92a16f9ae5a1c4e448 - pristine_git_object: 1cb1c4678f93af5f312df079765ec3e68d0bc89a + last_write_checksum: sha1:eaee562a0b8211dec27ea30a0e87da62346f7c76 + pristine_git_object: 2afe59e3233541964c5f9784ce7de4f6d4b1df0f docs/Models/Components/AccountingCreateAccountResponseAccountingAccount.md: id: c0949bde5fb8 - last_write_checksum: sha1:98b60c14db30165bef3a32c73f2aa8c5428b26fd - pristine_git_object: 0ea57580430f69a09ac7c2d44f5f9f64c4bdf906 + last_write_checksum: sha1:4373341b11050c6f59dd11a9f5362253cf88352d + pristine_git_object: eb2448b6a7b8fc5ba6e64bbe156bfb12f35a0300 docs/Models/Components/AccountingCreateAccountResponseValidDataTypeLinks.md: id: 30971b2fb44b last_write_checksum: sha1:8d1307e88e2bcc9ce30844de32764e52975df07f pristine_git_object: f78dca2a130695f74ffc481b9ef99ca796e07ec0 docs/Models/Components/AccountingCreateBankAccountResponse.md: id: f0d2d4604004 - last_write_checksum: sha1:2034346008158078164ef724bda197fc0256838e - pristine_git_object: b97d621f25d366968ec2893c8834ec38a69149e6 + last_write_checksum: sha1:5aba0ef4f0d03cb50a5abf1f41e4e46e2f5fbcb3 + pristine_git_object: 454686f8639872c4c9892401e00860c51f2e6030 docs/Models/Components/AccountingCreateBankAccountResponseAccountingBankAccount.md: id: 54b9651ac3fb - last_write_checksum: sha1:0accfcf8af7f2019e6cf57d25ad2e51cc133d994 - pristine_git_object: 9e437e916e17ab6cf58f90bb7cc68af240f100fd + last_write_checksum: sha1:10d8b646ede74a64ef789ce2627e34159f523841 + pristine_git_object: 5f55c74d30f3ee0c3bc34bf1495f4bff3e08fad5 docs/Models/Components/AccountingCreateBankAccountTransactions.md: id: 5fe985007f90 - last_write_checksum: sha1:f3023955ccf68a7dc217af7132ad64a7e1e09461 - pristine_git_object: a9a7a9975009225f74d1475b58a27dfb6ed87c34 + last_write_checksum: sha1:5a7d5ef147b6619a4890d274dee06fbc611ccb01 + pristine_git_object: 7653716e83ac6dc29db6b7e94e1e5d6cab5a2d8e docs/Models/Components/AccountingCreateBankTransactions.md: id: 671a1920fb5b - last_write_checksum: sha1:317cf9f2f9e4cb572df9d916ac224652f47b9558 - pristine_git_object: 2d8a5926e53d90c178401736a78928becc628abd + last_write_checksum: sha1:5b55fcf3aca6045a3b45bead619b19a6ccff537b + pristine_git_object: ab00347d5ec1dfa52d8627314cdf9a5f2fbba184 docs/Models/Components/AccountingCreateBankTransactionsResponse.md: id: 65f1519ef446 - last_write_checksum: sha1:e152e317821f80de35e489b8c182395ab9a66870 - pristine_git_object: abe285d8a5f3db3349f1745954cee0ff1ca12587 + last_write_checksum: sha1:4ab9925e232a36119e1e4d66cca1e1ec76142a08 + pristine_git_object: dad74d1aba0ec0c475b987f43d44c5604632e7ab docs/Models/Components/AccountingCreateDirectCostResponse.md: id: 8f5de9f52b25 - last_write_checksum: sha1:4cceada38a885f7303c49740bfd5dccefb301fe4 - pristine_git_object: 5482283d203087497d3ae7014389b2fd8ee89b74 + last_write_checksum: sha1:5e6aa5ed7902c83162ec278fe96e4573b7300195 + pristine_git_object: 2ce3ba07317ffbe9afde315b09574bb7a64388be docs/Models/Components/AccountingCreateDirectCostResponseAccountingDirectCost.md: id: 16401d59b693 - last_write_checksum: sha1:8715f2e523b75fddf36327f507cb192f3ca63beb - pristine_git_object: 3c24ceb47df87cca22d6916b73b9e7bf9b40aed3 + last_write_checksum: sha1:c401091facf075b2525ed47fe4dcc253a9e8492d + pristine_git_object: 21268d803cc1000af69621706de4d631b114c1bb docs/Models/Components/AccountingCreatePaymentResponse.md: id: f86f44834d76 - last_write_checksum: sha1:cd179faa3b8af02621965c7e37624ce4a2d751de - pristine_git_object: 9ecd9a1b3951ebde23df5c3664708203e1a36e12 + last_write_checksum: sha1:fd51746b5006773b2c8eada110d6810a482b37f9 + pristine_git_object: 92e6eff7d5e3bc532b423ebe1f9cf41708d0321f docs/Models/Components/AccountingCreatePaymentResponseAccountingPayment.md: id: e6c84d431d7e - last_write_checksum: sha1:82f70c3256f045a3fcf40ae5c88a8c3853dcde1b - pristine_git_object: 627417bf83f0b86abe99609821332b3b45a71238 + last_write_checksum: sha1:29b4977f8fbc4652c28612a143f0066b800d3049 + pristine_git_object: cdbc04fc969926c52637ac42b2a234acca5ccae4 docs/Models/Components/AccountingCreateSupplierResponse.md: id: 093dbbb2ca98 - last_write_checksum: sha1:02ceb141462711cb3b80b6a205872f44785f2fdb - pristine_git_object: b56e45734bed7a139f39842b3a3da30188e8083f + last_write_checksum: sha1:0c26a9594420138ca8996d9c7b3b45531126f67d + pristine_git_object: 9058ba04f121dfdf8954f7487b073b5bbce21feb docs/Models/Components/AccountingCreateSupplierResponseAccountingSupplier.md: id: ff5c3c7c9e0b - last_write_checksum: sha1:b83ed888bf6f63fe697f10f10f9bb9585a37a52f - pristine_git_object: e4fb1ce8c6423e032aefb70018f0b9ef5b7b3dfe + last_write_checksum: sha1:74c969b52a96b4d341d556800009fd538fdc705f + pristine_git_object: d06755dc8de01ccc0312b4ff8f7d48197521d6c3 docs/Models/Components/AccountingCreateTransferResponse.md: id: d1acf7d8a728 - last_write_checksum: sha1:535f9b20f080741a974c980423522178ff4c769e - pristine_git_object: bbba988a92fc2567d665b532fb07b70b4e07508b + last_write_checksum: sha1:a27a714df03eb7786ad2b6f74956f1ad0d7f105b + pristine_git_object: 537a4ee782d3a7c90d07eee36aeb763ac7c92451 docs/Models/Components/AccountingCreateTransferResponseAccountingTransfer.md: id: 01f4ddcfeb22 - last_write_checksum: sha1:b6945dda2577571c5c1477cd28f6f5bacb969b51 - pristine_git_object: 4f2d421edfe7c155855f5d2be47c0d50703a740c + last_write_checksum: sha1:549382d7231b8764274be2326e2273fe9e19b92e + pristine_git_object: d4dca12e15a9191b0157e707b1322421213b3c44 docs/Models/Components/AccountingCreateTransferResponseStatus.md: id: adcc52c53811 - last_write_checksum: sha1:2aa7e64e9638a7d8794f5633fb8d33745a76add9 - pristine_git_object: 03ebdfdf66635b94f3a62a67baff561c8dd87f66 + last_write_checksum: sha1:d19a76d97a937d3f62d8435d37b617d3f59bb072 + pristine_git_object: 8e9aa5d9d5bae305e745d619981b2008421ceef3 docs/Models/Components/AccountingCreditNote.md: id: ebe0113d33e5 - last_write_checksum: sha1:a1c5ae7b71bb12ab8c38a20fb070654ec6f05fc5 - pristine_git_object: 7ddc183fa0bf9d42d08cdf38daad95a34810e075 + last_write_checksum: sha1:a61404519c739eb2b526f8518e7362841b9221a4 + pristine_git_object: 1bce54f785a5ef3142411e68e165a8a75381ec38 docs/Models/Components/AccountingCreditNotes.md: id: 585248de0db5 last_write_checksum: sha1:74528549b0d526222e14fdd2b88a6ed299d2409f pristine_git_object: 040131b13058a58f1398f636d90015794969aff9 docs/Models/Components/AccountingCustomer.md: id: 46f59a268511 - last_write_checksum: sha1:1e5ddc2723c430116a1301dfce1b885b61c65278 - pristine_git_object: bb38b4ac3f4bbf27b805dda71390e067e6823317 + last_write_checksum: sha1:4cbfa05dec825e520f58a56044f4d8bc553ac265 + pristine_git_object: e566e38694e1535835c8c5f4c925ab51eface040 docs/Models/Components/AccountingCustomerRef.md: id: 6dce0ffd0ab4 last_write_checksum: sha1:7926b32f5df809ec7b9cc4df102438687c66ba6f @@ -3333,52 +3334,52 @@ trackedFiles: pristine_git_object: c2fef611b2231ce398836cfe1beee07277294d1e docs/Models/Components/AccountingDirectCost.md: id: fb19bf9221b3 - last_write_checksum: sha1:fcfe4258279302897a86be3e66d41d2c924b23a9 - pristine_git_object: abf3ea767dfa4de1b111597403b838df34067005 + last_write_checksum: sha1:d0b52c30cda8b57779e0c939de05c81ad22dda60 + pristine_git_object: dbc6867b5c324048f338697bea8a7cff1ba7b5f4 docs/Models/Components/AccountingDirectCosts.md: id: 451880a1391e last_write_checksum: sha1:78a712a96dc3a8a9ffbbb912c47b4e9f90ffeb9e pristine_git_object: c4c86b89ec60264b7258cd59b956fbe165cf8f96 docs/Models/Components/AccountingDirectIncome.md: id: a56835b17c82 - last_write_checksum: sha1:9ca93fd92736f79967da922da06302166addf052 - pristine_git_object: 9e906bdee077e410625bb59649364a1e6f78cada + last_write_checksum: sha1:cb372542d2e7ce660f0dfa7f42a29768e561e4d4 + pristine_git_object: 690d840ee02b72f3d3b4243154f37911f0b0fd69 docs/Models/Components/AccountingDirectIncomes.md: id: 0f4bfe7208ae last_write_checksum: sha1:b70f42b014b16bf0d7e7a38b30bc82fd8a8f5bc9 pristine_git_object: bf72c828064f4019f07abf9976d8c8ba196ce0f4 docs/Models/Components/AccountingInvoice.md: id: 70b36ab66721 - last_write_checksum: sha1:9bce465eb4f8a910cb45353415e6d1476b43e685 - pristine_git_object: 8152ce991b2596d4d024b428ae1f298fa5e8670d + last_write_checksum: sha1:3ebfb8acd52c5262418b706c4b795f76efbe2ebb + pristine_git_object: d6d75ce35b76a077a9ab895d5b79c4a690cf9629 docs/Models/Components/AccountingInvoiceDataType.md: id: 1bc2ea8acd7c - last_write_checksum: sha1:9aff8b14ed75a42deafe63edcdb1f399515aa915 - pristine_git_object: 278ae51936e4f85d8120d2a59229814d46ddb92b + last_write_checksum: sha1:df3284c9f07b553c06d2a447c7d04ef2cee5ff3f + pristine_git_object: 8fdc053e390c3f693150f72d5d2fcadd343a57ae docs/Models/Components/AccountingInvoices.md: id: 6a2473de3233 last_write_checksum: sha1:e8eaa1b4e4b9d2eb76e1a762f5dbb798f5fd448c pristine_git_object: 53fb97207bbb90a73ea70af445602fd62d4b156a docs/Models/Components/AccountingJournal.md: id: 50a971d557f4 - last_write_checksum: sha1:be0b4fca175a4dbda55d66dc773cfb5c5d61da61 - pristine_git_object: 12cfc4880e4829f9060bb147d86434a23f08c12c + last_write_checksum: sha1:29c8cb936f8893e3e493092909f3b0a2ee3628aa + pristine_git_object: 3ddb996343c49bc49cfc7baf774d7edb74dd42dd docs/Models/Components/AccountingJournalEntries.md: id: 6872eaf4c4dc last_write_checksum: sha1:7209456fcf2eceed152b94d23dbf185bfde081f8 pristine_git_object: c6244c8c2da8c5a21ba6d42a728fb63ecef38273 docs/Models/Components/AccountingJournalEntry.md: id: 03ab6792f785 - last_write_checksum: sha1:7f223884ab3e5cb91eb4cae6267a215b28d0c3de - pristine_git_object: 1c8fa5a8d5e6f8f6ca638c0cb6feb66ae39af552 + last_write_checksum: sha1:32b5c5d998e1b667d24b529207d2be72fdc85bed + pristine_git_object: 8b979a959ba7e9a3eb5d040e3f38df2e1df405d7 docs/Models/Components/AccountingJournals.md: id: 13028a2e8cb4 last_write_checksum: sha1:cd6acc84ed89ad615ba639bfc3f3a233519d8630 pristine_git_object: 0eb95f9c9005b1e3eabc7787db4c63be75090157 docs/Models/Components/AccountingPayment.md: id: 42ccc504725b - last_write_checksum: sha1:7c7f56a99efdfa058117f43ad4a4e9a43489b8ae - pristine_git_object: 511112a174c09ea120c8816c44b7b688394d62de + last_write_checksum: sha1:703d3c2cdfdd2864b73653cd4b3fcab1eb4f104f + pristine_git_object: 58e5daaaffaf4311ea3606a8099695f1d6aaa3b0 docs/Models/Components/AccountingPaymentAllocation.md: id: 4015e80ff5c5 last_write_checksum: sha1:24e8e30f59631cd366417e2e40777d3e42f66a07 @@ -3389,36 +3390,36 @@ trackedFiles: pristine_git_object: 55de6dd310c3d70ba1bd55baa80cbfa88174a655 docs/Models/Components/AccountingProfitAndLossReport.md: id: b5f4a0fe1a53 - last_write_checksum: sha1:5b42f3ba713763a27b3961c3b996ffb4ef1d73d2 - pristine_git_object: a9758f67d2e9ca0b647a4fb0aa4e7fc17c2126c9 + last_write_checksum: sha1:48a5c0690e89f5f3271dc28309e5d2df73d988f9 + pristine_git_object: 9ec61b98fe2e0047418cfc814cfe04ebceb0bde5 docs/Models/Components/AccountingRecordRef.md: id: 8d28d240b889 - last_write_checksum: sha1:5d7e97981036c206baceff5643910e697c13bf95 - pristine_git_object: dab67ff25906fe63092f49107710bc0ac0a6a1ac + last_write_checksum: sha1:45c327a28c3e213d7251a950b55410046344a58d + pristine_git_object: 8ecd82c639243b77ea1c78beabd1817070bba14c docs/Models/Components/AccountingSupplier.md: id: d4aea112b674 - last_write_checksum: sha1:9c24e5cb641c9cc3783fc689086b97e86efca806 - pristine_git_object: 7ef5478cea8a32910e388ed9b3268815fb2716d2 + last_write_checksum: sha1:afc63f8641f407c489518001289fb63bcea66b12 + pristine_git_object: 8322542e393b8421e2d997cdf896f743626c8a7f docs/Models/Components/AccountingSuppliers.md: id: e7ed849648b9 last_write_checksum: sha1:6230fb1668e05f289130998cb3aa26838f1d305b pristine_git_object: f02444b5e5d9f08056ed0edff9c3c2e69bd3e007 docs/Models/Components/AccountingTransfer.md: id: 4b3cc43272bf - last_write_checksum: sha1:1432eb12834d5e4619e2231cef3fb24765ef1df9 - pristine_git_object: 099859fde28c1c6f0cfc2554cdabcd962c7f806a + last_write_checksum: sha1:862421840acbb1a3fd9ec483ef0c501496c71c4a + pristine_git_object: 326d8ccb97db74c990a43ed26f362e3e0770b2d8 docs/Models/Components/AccountingTransferStatus.md: id: 110d04ab098b - last_write_checksum: sha1:2c321d362c7cfc21ec2f4056b1ee4d9dfbfa0738 - pristine_git_object: 573466d6a45260ba12eb3503196c72b5fc8e7bd6 + last_write_checksum: sha1:376dd945cff1d2867f05bde69ca965a8a15e0e1d + pristine_git_object: fb30d6c6c9a3fc9a3f99083f5fb5e2eaf85d67da docs/Models/Components/AccountingTransfers.md: id: 6b21ef323c5b last_write_checksum: sha1:1af65e68e25e6d6bd3a605344e47ea5365e83249 pristine_git_object: d1ca937ecc8a2cc47181c228c0504e6c027200d5 docs/Models/Components/Accounts.md: id: 11300c751cce - last_write_checksum: sha1:e11c42d5ccd1254443390d9d348de6036deef5aa - pristine_git_object: c1aa4b8ceaaefceb1f0245cb089468f0b122ae59 + last_write_checksum: sha1:336df330287ad89cb3a9ad8024adb7fe7739eb59 + pristine_git_object: bd1608c537c8395f7828bbe272e339d822810b4d docs/Models/Components/AccountsPayableTracking.md: id: 6c2a0f1948f6 last_write_checksum: sha1:791379b88fc9e86fda8ecf7ee1e65c5433965983 @@ -3433,68 +3434,68 @@ trackedFiles: pristine_git_object: f1af4e28ca3112402acea482b139221c37d63b96 docs/Models/Components/AgedCurrencyOutstanding.md: id: e4fda716d64f - last_write_checksum: sha1:ad5bac9f37c835904af819d9dbd3699732102ae5 - pristine_git_object: c0cdf1b1ea2037863e468478606725df10469d96 + last_write_checksum: sha1:ef68caa47ac3b760bbeee64e08334c39a7665dce + pristine_git_object: cba471e8a3f286389cfce01031074d6338dda634 docs/Models/Components/AgedDebtor.md: id: 65b1ef111b49 last_write_checksum: sha1:7f24160f0e43ae97cf4709aa3a5e7f8524b5a770 pristine_git_object: 3ddbede4f1107111987b404b79d7d31b334b38eb docs/Models/Components/AgedOutstandingAmount.md: id: 9f7df015eb72 - last_write_checksum: sha1:2ac3cde1f411e83dc48327d0f968107b75b7b3b8 - pristine_git_object: b6c3828225362efdc5a7f40758fa815780d32525 + last_write_checksum: sha1:ee493687304fb84897433209ff933aa912657cd6 + pristine_git_object: e3e4457f33375ba1b5bfd95633c2ee5647479a4e docs/Models/Components/AgedOutstandingAmountDetail.md: id: 09ce33086256 last_write_checksum: sha1:cf4b6b38703a093b0f16640ea20f9d1b149378b8 pristine_git_object: a0b9ca335bd484952fc4631a5ccce128989410d1 docs/Models/Components/Allocation.md: id: 9daa379bae1d - last_write_checksum: sha1:27d014ce645c33e190bc033db68ac959a8ab38bb - pristine_git_object: 984112a429b24f5763483546390b97d5ddf0272b + last_write_checksum: sha1:7afca06fefbc3e0cc529297a38e7f93c7fa72503 + pristine_git_object: d3bdba6ef9629d17c7a7d46981b2d4e58146144f docs/Models/Components/Attachments.md: id: 154cc724919d last_write_checksum: sha1:9370e725e25714563d187efd15609710661a5d46 pristine_git_object: e20c317b522304f843f8ec2493886faabde835f8 docs/Models/Components/BalanceSheet.md: id: 3dadd37b9c48 - last_write_checksum: sha1:3be3243bda67f28eba433e6a89bfb5c99c377fbc - pristine_git_object: 960b200ac220a3e0f1ccdd14b34513275d4e364c + last_write_checksum: sha1:dc1b5004a0bc43447d8ef81dfa940fe35fa7902f + pristine_git_object: 0912fe1d2e630e037d00df209ae9ef3059522596 docs/Models/Components/BankAccountRef.md: id: 4972c94d6264 last_write_checksum: sha1:e20e3b246a00f62dc311f37e774f5755fdcd221b pristine_git_object: 4a1989063907155039575acdc26407e2367be156 docs/Models/Components/BankAccountStatus.md: id: 2e04c2652cc7 - last_write_checksum: sha1:141df201e2849300511668af5191641017a6b591 - pristine_git_object: 4ae20d422bec50701e6b3b052a9429969b86fe8b + last_write_checksum: sha1:871036688d35206b6a8bfde117a0d246a877b520 + pristine_git_object: e3b3767efcf52459733b05bbf91087bd3d1d1b5b docs/Models/Components/BankFeedBankAccountMapping.md: id: fa2c334a0577 - last_write_checksum: sha1:e14770a60387a7c58d0296acbc29b17e5ec8a96d - pristine_git_object: e8a25fdb658334a9c2c6bd164a72b2f98d3bd78e + last_write_checksum: sha1:a352d53325cca2ff954331427c8063d8b4e098e7 + pristine_git_object: 4845f0fd08f0bef174d9f59e385b180cc4865987 docs/Models/Components/BankFeedBankAccountMappingResponse.md: id: ed4d25d76592 last_write_checksum: sha1:5268ab920bc64fd7550639d64e24229c31335375 pristine_git_object: 967b729c73931314a7dbbd0f88dae98ec71a543b docs/Models/Components/BankFeedMapping.md: id: 991d489d8586 - last_write_checksum: sha1:8222c7f5b7b6e9172fa81437afa8b1767ad7333a - pristine_git_object: bdf1c0e1b9bc3c2efcfe1473545efcc04bc1e51d + last_write_checksum: sha1:598d64331de7df1bead7ee6ef0b79cc3e22f72c0 + pristine_git_object: d0dcccd0b087b84708c71e5a27ce7d016403a12d docs/Models/Components/BankStatementUploadConfiguration.md: id: 6ed9b56c95c1 last_write_checksum: sha1:024348fdf8dc1b12b2793629419b29c6985ea57f pristine_git_object: 02d0d802745ecff60f59ddfdad6e3c264e80b416 docs/Models/Components/BankTransactionType.md: id: 6d0503da9b0f - last_write_checksum: sha1:b12eae7abb77942bf30ddb7191d74ba34f08a5c7 - pristine_git_object: 749fe41b2c455b66010b8a54e040f58eba72bd59 + last_write_checksum: sha1:2508b3e22a852addbfe4619ab8b7c85522ae3d70 + pristine_git_object: 37743a67b128bbbe8ee826ef47800d12007fe784 docs/Models/Components/BankingAccount.md: id: 101477191bb0 - last_write_checksum: sha1:8230c7ff13620b0dee2f9cd8dfb4144ab8088510 - pristine_git_object: 76cdafe63730a195dcbc944de5af05bace747a36 + last_write_checksum: sha1:aafda5cdbbb42936a1d1703d22a33d7ee82894a9 + pristine_git_object: f3b778adaca380560baadd316095c3e5e10c7e79 docs/Models/Components/BankingAccountBalance.md: id: d28d31eefb10 - last_write_checksum: sha1:6e0a72e32904a570b64e0d0be122a7c77ddc7e8c - pristine_git_object: 3419338a6444b543404c1700ffa13cb8d2975ae9 + last_write_checksum: sha1:1ef5586dc9042eb3fd281b07b2d287026aac351e + pristine_git_object: 41407ccfc31023602d56ee8b38b48e4b97ddcccb docs/Models/Components/BankingAccountBalances.md: id: c0063bc2c1c9 last_write_checksum: sha1:09f8a981c376b4668dc1ec8a6d2429df0b25ea28 @@ -3505,20 +3506,20 @@ trackedFiles: pristine_git_object: faf1fa56681e46e45a797dec0f900875e6dfc7ea docs/Models/Components/BankingTransaction.md: id: ce90d81677ef - last_write_checksum: sha1:1229ae25a60be9453805f185de39bac5426c0d0f - pristine_git_object: 5416a267bc83fb6aaf0b45b10757db61d3278a3d + last_write_checksum: sha1:be6f6d008ed4a7b13e8b0af69b4e3daaf8f2b7e3 + pristine_git_object: e3fc620cff93a8c85b8a8588f3c6634122f05314 docs/Models/Components/BankingTransactionCategories.md: id: 1f343f7675a7 last_write_checksum: sha1:f7864ad11ab009808ae4d5c9917b7248fc653232 pristine_git_object: 6fdfb07f891e56b99d3c97ee2f07527af9886f3d docs/Models/Components/BankingTransactionCategory.md: id: 1619e2bba0e8 - last_write_checksum: sha1:5aefdb2a7779a796551532157a3496a44d7cb716 - pristine_git_object: 4c2f8fa7b4a8289be4d24e1c3dac717565888654 + last_write_checksum: sha1:badad0e8434007f522baead89333ca91c773fdc5 + pristine_git_object: bd53aad807f02f031b6f118f84c7453a83307409 docs/Models/Components/BankingTransactionRef.md: id: e3f74e01719a - last_write_checksum: sha1:a22acbae351d373431163404b14d519f1c337115 - pristine_git_object: af6f5ba1920c500749c0993f4aa052cda2f922cb + last_write_checksum: sha1:228b7f763b075d7d9535bca049f83880abf0a12b + pristine_git_object: 44e30f2392f36582498ee1cf1c96ef9f5e98c87c docs/Models/Components/BankingTransactions.md: id: 68d7dcff7efd last_write_checksum: sha1:97445d643285730bbefa42470ea418ca129f1845 @@ -3529,56 +3530,56 @@ trackedFiles: pristine_git_object: 7768c251fe89a71d8a922960e4b201f4b1c86cc8 docs/Models/Components/BillCreditNoteStatus.md: id: a1972227949c - last_write_checksum: sha1:4492f17f33c984375116d32f25aec140bfa2e8cb - pristine_git_object: 95081e934107ad5a2b860eb066482003457ff8dc + last_write_checksum: sha1:ff03658034ec739b4aec9e39cb512d135cc3bd17 + pristine_git_object: 61a8f1f21867cf75cbf98d2f10fea244da4df0c1 docs/Models/Components/BillLineItem.md: id: c9b2b830a535 last_write_checksum: sha1:cf109811a9c61161d0258a331538d068425c3518 pristine_git_object: 07463f8c8da0fbbc7150d7dc4c95e100ce163775 docs/Models/Components/BillLineItemDataType.md: id: 0721ac4cc20c - last_write_checksum: sha1:a481b9ec4ff21d06a09e4e0bc256bcec56714903 - pristine_git_object: f4098b209f437f4bdae20dc947b8cc9f56b48b17 + last_write_checksum: sha1:6bdcfdee09a0153cd47df8c22147b78bdfe39c78 + pristine_git_object: 059baadbb5b20d75d235a9b21af87a7562fc40aa docs/Models/Components/BillPaymentLine.md: id: b173003f97ea - last_write_checksum: sha1:37118a4f6092398217e244942ee9803564a800e8 - pristine_git_object: 2abf2479a45b973dde7e1065502f6acc5380e0bc + last_write_checksum: sha1:d61e0aadbbed369004d0787c01d909e8f9fd668d + pristine_git_object: 5fdb43fea29bac97b9b5b616851b22bc9fb28813 docs/Models/Components/BillPaymentLineLink.md: id: fba155005c88 last_write_checksum: sha1:08553dd938af060c88e49505d941cba3df9c2fda pristine_git_object: cf7ea93573030681c5d587ec1cc83870fa149bb9 docs/Models/Components/BillPaymentLineLinkType.md: id: 1ba8f0eec1c5 - last_write_checksum: sha1:128306e25444585ee1376ef41517c3b9056a5d3c - pristine_git_object: 19d156f3cc2cae6c6d8a641be192e419228deea9 + last_write_checksum: sha1:b60bfb64287e8dc146226e19f5adad8747eb8bdc + pristine_git_object: 9d45ba7cfa5a839f25a04de5ed0089edb554f125 docs/Models/Components/BillStatus.md: id: 43d9eb047117 - last_write_checksum: sha1:a25f525e131379c124a7debe6bcffe598c0fd690 - pristine_git_object: 6b630d7aefadf8e537d04a527426e225a726eda9 + last_write_checksum: sha1:d0ec5eca1fe0fe0f0e55895eafcd64153ee59411 + pristine_git_object: 89368dbe8dca1ef5672fe6a107db1438a6642653 docs/Models/Components/BilledToType.md: id: 0c4878cfb94d - last_write_checksum: sha1:a298232ae3ae152fed2d1e6d6afbf6f99560de55 - pristine_git_object: 8f24354b142720e77ebfdf78b034e5a1f30233e7 + last_write_checksum: sha1:dd237f1c00269d69f07ba69b3498b1d4002c0c8d + pristine_git_object: 17de5fdecc2b89103dbe51899ab17ab82b868a96 docs/Models/Components/BilledToType1.md: id: 6636468f16d1 - last_write_checksum: sha1:c1040874078c64e0e343677d4845ed4969888c8f - pristine_git_object: 280ec527a4cdd87bd9271b0760a1fec8a3ca1c33 + last_write_checksum: sha1:e9e2ad8c312b1ab45a272cc6f1ca59e429b3135d + pristine_git_object: 39f08ee071a9ff2c1687d679c8671506e7415ee4 docs/Models/Components/CashFlowStatement.md: id: 5fd42a8e13f1 - last_write_checksum: sha1:3450fda22dd36113973f0d083542f51790e66434 - pristine_git_object: 5ca3553f5e8aaa3c4ccfb00c177db597a8b6e1b1 + last_write_checksum: sha1:a02b8527a7d2b2a7adb760a7b4bf445dfcd729c8 + pristine_git_object: 32174a1e643118beee388c60fdc440864046b238 docs/Models/Components/CashFlowTransaction.md: id: 5ed186e67ea2 - last_write_checksum: sha1:f6c0ca457bb79b5de2eaa75fd3e78703e7923b6f - pristine_git_object: 33ba6e46402bbf6d9417a455bbca9951f46f648f + last_write_checksum: sha1:9abac4ffb7fd2e10618293d33d1ceedcff6c07cf + pristine_git_object: 137905a3529a7db985ba5b76ec5637debb061c36 docs/Models/Components/ClientRateLimitWebhook.md: id: 76c3a2ac70a1 - last_write_checksum: sha1:59cbfbd15031c073b3d5c956ade4bc14fc9ec9dc - pristine_git_object: 22d3edca9b70ffe4881bc0954bf8d0f88ac321ef + last_write_checksum: sha1:2484e6e6a26741193199400c161723f5c372ce4c + pristine_git_object: b5ded115e678cd1fba759ce350b25c66bad90f26 docs/Models/Components/ClientRateLimitWebhookPayload.md: id: 56e0e7798a5e - last_write_checksum: sha1:d4139704462019e91c1bf801610e39c3c79fff3a - pristine_git_object: 5cd8406a355d8e34d949669875e3e7a7fc2ccbcf + last_write_checksum: sha1:1a7795dd1007642791299f3ec78d349d1ebb47ec + pristine_git_object: ba85388946a28ad7793134a481f5ae3cd7896f3d docs/Models/Components/CodatFile.md: id: 0cca107479b0 last_write_checksum: sha1:e6c646213692731f42360190fa282d4eb84e6861 @@ -3589,60 +3590,60 @@ trackedFiles: pristine_git_object: 27bba7a8e62b957337c29d9822d27569e0c39aad docs/Models/Components/CommerceAddressType.md: id: 69ddd6f37df3 - last_write_checksum: sha1:c261ebff3ff8c68ce7e4b11234ae192f84c0191a - pristine_git_object: 1ea5a370571a1d1dca0f6a6fd9aae2b25eb0f35e + last_write_checksum: sha1:b5d459c7cd2a66a778233a96cb8d1331e429e77b + pristine_git_object: 32f309e5861c4976c1bcb6fb1820d3bc9a76b02a docs/Models/Components/CommerceCompanyInfo.md: id: 737419aa1275 - last_write_checksum: sha1:fbaa6b8c11e20ee10b10e6210bb819308f303445 - pristine_git_object: a8b6ba5b74662e073195a70776cd68b07e3f076b + last_write_checksum: sha1:c48ca55e75a9c841beef4f7aefc4a7e35f83feb7 + pristine_git_object: 85b6068f34c056e25278b9b2c69244a407cf01ac docs/Models/Components/CommerceCustomer.md: id: 3c7483a57205 - last_write_checksum: sha1:161f858c29d90e73269c0dba97933e9450a825c9 - pristine_git_object: 773d6588964d12a75d0bb6b8af88d940ba3ad106 + last_write_checksum: sha1:aa459bdb807b24f0ef947223c5983ef6d27713f5 + pristine_git_object: e145a8fbf17ae8a7cfe0e09368d2a1b0ce5c7b77 docs/Models/Components/CommerceCustomerRef.md: id: 0479c27c6071 - last_write_checksum: sha1:8df6b518c9416985a558dcf59e942993d8dc6bf5 - pristine_git_object: 2e0421d4a1ae7a0ab2aa93888f5cd57bddfa2bed + last_write_checksum: sha1:bcb6563c51782f488649cde4ad10d6ae6f130bef + pristine_git_object: cc5d8e9e52f1bc5275f5e68690de6f20c70a1ae1 docs/Models/Components/CommerceCustomers.md: id: c097acd13196 last_write_checksum: sha1:f739c2b4ada18f82c0bb38c186a71f8d8c56dba5 pristine_git_object: d00627b68d73d77abab420d239cd6c0f37a62c63 docs/Models/Components/CommerceDispute.md: id: 58769844aa9e - last_write_checksum: sha1:11f8ce6a7077e360b30894df4081843993146012 - pristine_git_object: 6c8029a8897e4f33870872ecd5583761853ea0bf + last_write_checksum: sha1:baeb3b1a0d0ff860060f6fba095876e86289655e + pristine_git_object: 0eec89b1ea5bb10e62e54de00703022618263bd4 docs/Models/Components/CommerceDisputes.md: id: b406f88a2bfe last_write_checksum: sha1:62156540c550a140c1ec88e87f5c57f6bcdf2c31 pristine_git_object: 0ef65d79633751f77d02c080668d51fc5dfdc1c4 docs/Models/Components/CommerceLocation.md: id: 870004a73139 - last_write_checksum: sha1:67369bfc6e870651eefa72418bd0b03543375511 - pristine_git_object: 1d6ba48c3383c53fe4a5fa982046f18b39765c0f + last_write_checksum: sha1:e5f979833768ea175e8ac1d2183c82d3477cf526 + pristine_git_object: b34fa18e73b11d565427e3e45d86b87819c57fcb docs/Models/Components/CommerceLocations.md: id: 3580ed6b8d04 last_write_checksum: sha1:49464018ed1a8b014818895e2fa137dd5be522ac pristine_git_object: e981011fdad0bd5e13659d213917f757cf8a1e5e docs/Models/Components/CommerceOrder.md: id: 4184877c3e8e - last_write_checksum: sha1:a21d200184edc52f9925bea4b043c5f4b3dcb0a8 - pristine_git_object: 11e47b69b0daadc26e7614dac9d96508abf00295 + last_write_checksum: sha1:5c864e3dd0f504cc6a90146fac9984bafe95b0f3 + pristine_git_object: 54ea66f37934f2987101de4ba5a1ec5f6b071edc docs/Models/Components/CommerceOrders.md: id: bfa4c28526ea last_write_checksum: sha1:ff3f290b7f16d77e91e3dcacacc2bddaf42f3511 pristine_git_object: c8cdec269a58038470cc0fc08cf1986ef0da2a70 docs/Models/Components/CommercePayment.md: id: db10579509fa - last_write_checksum: sha1:230800cf665481b3bff341c37f5fb39af22604be - pristine_git_object: 5be6264af1027831c73137c1ec07b885ce349fbb + last_write_checksum: sha1:8f533fd1d1cca93b85d40306a754e3f8a89e2369 + pristine_git_object: dc14a766345db27d311cd706731b22437a0db768 docs/Models/Components/CommercePaymentMethod.md: id: 7fb1da1e49d5 - last_write_checksum: sha1:93e62c2022e44e6f7ff78f47ccdf9338be45dadc - pristine_git_object: 534851f5f3a6e6b8a822a252df12aafb040bb364 + last_write_checksum: sha1:b1fb7deb4ca3d78f14833845675432309c15c8b2 + pristine_git_object: 4250c2db364e51744cf7538a3faa4ac7105495b4 docs/Models/Components/CommercePaymentMethodStatus.md: id: 8a5246b59f1a - last_write_checksum: sha1:162cc8f1ab57bf420598f691d1d98c4ffc1b7521 - pristine_git_object: d8abdbb795c4cc30ad13f1673e649614edab2495 + last_write_checksum: sha1:0f4db593491287aff7782b5dfbb614fde6f31bea + pristine_git_object: 2be95240e1e953857246ecba2c1830ea4a763914 docs/Models/Components/CommercePaymentMethods.md: id: dee96eb0857f last_write_checksum: sha1:1cfaa7d85d92591430656cd4aee775079b9214ff @@ -3653,24 +3654,24 @@ trackedFiles: pristine_git_object: 3130a1bd3a00fa0e598e54f7c85b5657c18d8605 docs/Models/Components/CommerceProduct.md: id: 14600a82170b - last_write_checksum: sha1:6360b87e68df50c4eca84567472d02548e6f9a3b - pristine_git_object: 7b933e04559203d6c63e2a41253ac36fe3de2e61 + last_write_checksum: sha1:7b2d10d8f52d8d0da6de161d40cc6f0db3db212c + pristine_git_object: 9b5be433394be899bbe875f47297d370dd14e3bd docs/Models/Components/CommerceProductCategories.md: id: 4bcd590957b4 last_write_checksum: sha1:6946a8a0d8b579cd1fdbdee59376b3771d89bba6 pristine_git_object: 88b53eda049f8d413ab25d2016346dc70411a0bb docs/Models/Components/CommerceProductCategory.md: id: 42ed4d119450 - last_write_checksum: sha1:e072c49a92ff95ff9445f9cee893a5055a062e22 - pristine_git_object: 9ce4a675d86f4ca21d654a78692d61227e27d983 + last_write_checksum: sha1:fe8592f107fc995ec69a429735d40291115b925b + pristine_git_object: a1c04df82e9d0040e7c47c0327752d5d5e25e4e2 docs/Models/Components/CommerceProducts.md: id: ee4b1355c844 last_write_checksum: sha1:27afe44a83a2e12b97f41db07d58f7ef9856d7fc pristine_git_object: 7b1a91693d31965628523c53672ce0bd8b4d7d3a docs/Models/Components/CommerceRecordRef.md: id: aefffadb4d41 - last_write_checksum: sha1:68a0be8c018172e7f6818d471a872bd0aa3c08ba - pristine_git_object: 5e53f4aefee75b528ee9ceebdb5a14e3ebf55aa7 + last_write_checksum: sha1:92ecbe731676012b3221740969aec3d322fe5dbf + pristine_git_object: 63d916ed153909567db53dcacb0b2cd8896de1bb docs/Models/Components/CommerceReport.md: id: 28b0876d723c last_write_checksum: sha1:824d69a59a8c26a38511709c377f514307f8cce1 @@ -3697,8 +3698,8 @@ trackedFiles: pristine_git_object: cb8b3d4aca6f686dcc28caf07c38f4989b1112dc docs/Models/Components/CommerceTransaction.md: id: 766a1a14f589 - last_write_checksum: sha1:60859a2db42e4aee9ad75bf078d80c73d8672f4c - pristine_git_object: 6eef375782a62668218b76646e64a2ed524c7681 + last_write_checksum: sha1:8f6f11c29383944ebe3cae521720534ff1d033c2 + pristine_git_object: 4a9353dacd7f640a49990131813aa25bc7077a07 docs/Models/Components/CommerceTransactions.md: id: 01a6ad15c271 last_write_checksum: sha1:8babc7b1857ec560e06b0b8ec65b9bbeb3177b4f @@ -3709,8 +3710,8 @@ trackedFiles: pristine_git_object: 8aacbd8d53cd9a85ac67035a6c6eeff3cfd9eddb docs/Models/Components/Company.md: id: 4827695a19b4 - last_write_checksum: sha1:eb2ee82d550055ed38d18d20152f685db4f0c6e7 - pristine_git_object: de73033f8014a3e0913d103b8d5753b7f61ad2a4 + last_write_checksum: sha1:65e05f32b807f82f96436aac0fcfa3bf568c0eb4 + pristine_git_object: ec23bba3af709333b835493fadc86ef257442a89 docs/Models/Components/CompanyReference.md: id: 7e01a182a597 last_write_checksum: sha1:d8d4c91b6a53b56c9f5e2f5870d5f67c948b0409 @@ -3729,60 +3730,60 @@ trackedFiles: pristine_git_object: 2e5fa23d7bb058f3ae24ddb1dd16b618858575c2 docs/Models/Components/Connection.md: id: 5688c7e8f7e9 - last_write_checksum: sha1:cea0ec0dc8a1e1bbc074069d0370a355b249227c - pristine_git_object: 9a9ab3f0bbad4296643755a8c12ed63ebd7e4caf + last_write_checksum: sha1:f037abcb827fc0834129fcdf07a506d089176286 + pristine_git_object: c8cb73dc4ca28acdc4e049e4cc922075c8f36515 docs/Models/Components/Connections.md: id: f7e1a57da8a7 last_write_checksum: sha1:e112155362b0d07c0fc76f7e0f7db1e0e6d5bf6e pristine_git_object: dfabbaca541835f4199581aa6f11e493992bf45f docs/Models/Components/Contact.md: id: 66592acc35f7 - last_write_checksum: sha1:b08e378c2ecc40c674052768bc199070d92a9d86 - pristine_git_object: 41eaab6227d2c1036ac6c0175563f36ef997ab2a + last_write_checksum: sha1:6f3c80d4728b0f7c88f12a8eba66e4614a11c2dd + pristine_git_object: 8511d1483e8293827dc817576c87cfc38f02b1f9 docs/Models/Components/ContactRef.md: id: "380086307149" last_write_checksum: sha1:6f15dde4b066cda9b1f1c658622b22d097a8cbbf pristine_git_object: 0c44cb2d4636f733092cc1042b9542f7d068eb58 docs/Models/Components/ContactRefDataType.md: id: 98056352e9df - last_write_checksum: sha1:a7435a3a291a09e59f6b233bc4fcbcc42a885c2c - pristine_git_object: aab8f232a23befdaef04ab3bf9fb20ddbd3cf0bf + last_write_checksum: sha1:29e7f32fee411e3e4868a0842bb3200d1507c11c + pristine_git_object: 3d33fc93e92fec649f7bc65fec1f43be13be41f4 docs/Models/Components/ContactReference.md: id: 639267d9adb7 last_write_checksum: sha1:722ade737b9b0dc8016770255b7e68b0b7e3d91d pristine_git_object: cff4e3d20b3b911f4c51636e015d28283670e171 docs/Models/Components/CreateBankAccountTransaction.md: id: 7a2e63670cb9 - last_write_checksum: sha1:9b638dcc1b526c60b12d5274418f9a278e79cd24 - pristine_git_object: 9e5e95350d0ec5fc1ca073cfa7ee09c2ca1a0647 + last_write_checksum: sha1:68e5f4b71f741c5f03bf1adaa61180f7f32cf24d + pristine_git_object: 5c93113b43eefd4aedb5b59c23d55575d03ce888 docs/Models/Components/CreditNoteLineItem.md: id: d1afbd035dc8 last_write_checksum: sha1:e1c86dca0ded5b34a0f14ee60d5339e379a79d58 pristine_git_object: c6400241b8145fffe18c42f5c0b1c23d82ce8e69 docs/Models/Components/CreditNoteStatus.md: id: 51f39c364a04 - last_write_checksum: sha1:2ef8065025217e685be59ef0c85f4fddc7ef6879 - pristine_git_object: 41acdfbf72c11b95c1e0aa9ee8b8cf86885a5d3b + last_write_checksum: sha1:d0f100b9d924a19688bb3cb2155318f19f47e798 + pristine_git_object: 4731a4968ebfa48926a80e2d129e5061d8dec274 docs/Models/Components/CustomerStatus.md: id: 70c868344603 - last_write_checksum: sha1:a6175b949fbeb98d58f86a9c4c3cfe8b57e30c52 - pristine_git_object: 228196657a522b7e074c26a0c11c5aa63ea11904 + last_write_checksum: sha1:2defa62df175636c8d7e9386fea1154511ce1f1f + pristine_git_object: d372acce3e74d52ee4eaf4d70b7c1bc1f0df1a51 docs/Models/Components/DataConnectionError.md: id: 5dd8d2166aa9 - last_write_checksum: sha1:0d5d66e5ac8a333c2cd4ed0c314173b2116fce74 - pristine_git_object: fe2a2bdae8b7a19de6be2af3b81e5e2078d14c0b + last_write_checksum: sha1:b4d88a730a6e98e92763c87ed51620b1eeaf45ae + pristine_git_object: 2e7779da343adc3bcde777c9dacc76734a8f223c docs/Models/Components/DataConnectionStatus.md: id: 100db3cb3431 - last_write_checksum: sha1:b4fe05d43957d052510e1a5e916e25bc0175116a - pristine_git_object: 5d13bea516133003653398aacc1e9b963339249f + last_write_checksum: sha1:dc47fdf4aec23b3a4bf07c9cef603c2d65b1fd2e + pristine_git_object: 967229723d5db55a645bbdd4f46723b9f87007af docs/Models/Components/DataIntegrityAmounts.md: id: b3cfd09c6813 - last_write_checksum: sha1:fd264f36fc17effcd946665348052ad0d33a8d18 - pristine_git_object: 4c19baaa8726397fb40dbf5d119edf511b3af7e1 + last_write_checksum: sha1:cb80c9f058fd1004cf3fc32eda53b0432805775e + pristine_git_object: 0225e7dee0e4f55d070997a21e14f3c4e81e3b23 docs/Models/Components/DataIntegrityByAmount.md: id: f320f192237e - last_write_checksum: sha1:a76bcbf04fe017e23e6c810c543e5513df4b3b34 - pristine_git_object: ea2aa9eb3dd08dcc12cb3c2cec7d356f4b7bf6ca + last_write_checksum: sha1:4fa36e7ab818016460ee2960993bcda61222a89f + pristine_git_object: 25248826d4bfa418a56101f2dbfe793ad4689f16 docs/Models/Components/DataIntegrityByCount.md: id: 7f41b716684a last_write_checksum: sha1:5221be2bc2c4a7613fc3f6786d7bd624b115ba5d @@ -3793,32 +3794,32 @@ trackedFiles: pristine_git_object: 2007acef6dbd90f66a67697c06669bab2682bc23 docs/Models/Components/DataIntegrityDataType.md: id: 27b18f3efda7 - last_write_checksum: sha1:3d052d48739d9917016154610144c94d1787b74a - pristine_git_object: 7f820fa928bde029d15bc0145d338a55198f6f45 + last_write_checksum: sha1:843746a60ba16f1e3b01fef2b3266347c5cb9bcf + pristine_git_object: 2a59630e3cbf3a0b1792ffeb16e485213d3d5e56 docs/Models/Components/DataIntegrityDates.md: id: e1d0690cba7a - last_write_checksum: sha1:24b912814d24acaea4b00e1ec6617b2791b7437f - pristine_git_object: 30faedfaeffd93c8c783d1a2e9b1148122f0a796 + last_write_checksum: sha1:c30fda2255a7695cd6603f275bb68f3d2fc72ae1 + pristine_git_object: c20f63c5dc0fe747b7b4114f62b72bb8e5d9b6d8 docs/Models/Components/DataIntegrityDetail.md: id: fd0462f3d74d - last_write_checksum: sha1:16a07fc1d839c808e0f16ec8ace73f31852014af - pristine_git_object: 58701a6f0bcdf9e2de6dff21377a7fa091d9f2e8 + last_write_checksum: sha1:c05c7ddcf58507ac6185846de402789e1b2e3387 + pristine_git_object: c36ad66f06d5c44e66664aa4aec30c0dcf66df4c docs/Models/Components/DataIntegrityDetails.md: id: c5ee5fd4b042 last_write_checksum: sha1:4873ad5e6ced4b16681b74f2e7f22605f3448d5d pristine_git_object: a0f2b93a40762a7d43a440ed778e97f1170af23b docs/Models/Components/DataIntegrityMatch.md: id: 6105a400f994 - last_write_checksum: sha1:343b45cd68abdb23eda676e022a68c46e5ce9b8d - pristine_git_object: 5dd81f1b2e1c134dfe4ce2cb1543b389d69220af + last_write_checksum: sha1:073ed6a39a947d4648cf4c772ccb7185768e6def + pristine_git_object: 15d26292f037a95fe467cc88c1b1e720ef14bd35 docs/Models/Components/DataIntegrityStatus.md: id: 0b38c65fe9c2 last_write_checksum: sha1:c1d96d770ee0652e24e82697a52283db1ac3dfe0 pristine_git_object: 88a8f3c96b15aed889bd82999366c1aefd175fef docs/Models/Components/DataIntegrityStatusInfo.md: id: 02b78f8b4c4c - last_write_checksum: sha1:697524e61d629f599eb31834cee14dd6c0a72d5f - pristine_git_object: 15eea4ba9251aefa2ef5fab7d736365d105cbd26 + last_write_checksum: sha1:9186ba35d3588aa38526ca8e9db923f2635a55d9 + pristine_git_object: 044c865f81120f9f9bb310469663612abbb3fc3f docs/Models/Components/DataIntegrityStatuses.md: id: 8e037c6a2035 last_write_checksum: sha1:5226c7c8bf685837ebe1c25af2794fd1601bb4dc @@ -3837,44 +3838,44 @@ trackedFiles: pristine_git_object: 3c0a97860d91d476e84f4094a431bc3167def4d3 docs/Models/Components/DataStatus.md: id: 0711ec31c484 - last_write_checksum: sha1:35d9763a3f097c76695a3594a5a6f2bdf67b1311 - pristine_git_object: 46aed60c58db6e9af16dd405c997504b1c45f0ab + last_write_checksum: sha1:9b87ae1251554d0cd1f4e87554c9e696a89734b4 + pristine_git_object: 800c638efdd0c95df98ae965da29a345d80b9448 docs/Models/Components/DataType.md: id: ea9ccd5a7c4d - last_write_checksum: sha1:daf79b7b459f751a44e0c912b91f22a91f3a942a - pristine_git_object: 4f6ed34172739dfabc1ced9d796293ee50eefc6f + last_write_checksum: sha1:c91f84e17f895ba8ec440d23fb5ba577f385b0ed + pristine_git_object: 9febaaa54298f0207e7f664e162664138a16e272 docs/Models/Components/DataTypes.md: id: 5686eb82a4b9 - last_write_checksum: sha1:bffbeb6aa82618eacf3905db9c6efc7c7a43be55 - pristine_git_object: 3ea6fa56e9bad0f99cd9c97ffe74b5b7c82daedf + last_write_checksum: sha1:acc7cfa8bb454483544014eb7f8c9bf18e8fc525 + pristine_git_object: e17ee255c03639f9c92c153398dc1e4172ad3d91 docs/Models/Components/DatasetStatus.md: id: dacf1151ffb2 - last_write_checksum: sha1:24cc3c452ee06486397c6528b099855d3f688966 - pristine_git_object: d5bf9440fc23ed1d12845f00d60f0d911b7d1bcb + last_write_checksum: sha1:ab89d86b27b3a65dfe748d42511f3453473aff93 + pristine_git_object: d2f83e856a7e2be59f90b8df11b08f9f714a00bd docs/Models/Components/DirectCostLineItem.md: id: 424e0bfdd651 last_write_checksum: sha1:1c9210bcd4bd99ae39291018124904622eb2c9f7 pristine_git_object: 46abb4289b873bacaec60104e4d2edafde6f58a0 docs/Models/Components/DirectCostPrototype.md: id: 81b4d8a81df7 - last_write_checksum: sha1:cd577a09a3cce9d9873db1cbd69ded1b48955f91 - pristine_git_object: 12c9d521fe36f5fd3514047bf4330b9707527053 + last_write_checksum: sha1:638faaa8e41d01f470a5792c2752a5c9f9ba1abf + pristine_git_object: 94e6cbe7b9efd3a1c7fa0123d344892c47744f93 docs/Models/Components/DirectIncomeLineItem.md: id: 192f1562764f last_write_checksum: sha1:7cfea44200f6325f8147bc81dffe7b0cef05b6c5 pristine_git_object: 1afe37787ff59352b9950cb0420bc0c369deefda docs/Models/Components/DisputeStatus.md: id: 0418e2d9c799 - last_write_checksum: sha1:87c3f743068be6f605bea2a87b8bc97877456e95 - pristine_git_object: e30ad79e3e1f43cbe57294c6a9388ce6cc3fafad + last_write_checksum: sha1:26dd898a89fc8980b08867d19b78266dc23182dc + pristine_git_object: bcb4645ac9f934bb66f0ed32095c5f5e52fdebf6 docs/Models/Components/EndUploadSessionRequest.md: id: 14dbc62688f0 last_write_checksum: sha1:a76e99da115627d8a1268f31a304179977b93a3e pristine_git_object: b94bcf1e524278100a3903c7767b3daeb6f5dc58 docs/Models/Components/EndUploadSessionRequestStatus.md: id: 3b87cc7507de - last_write_checksum: sha1:91ecf0c2c00b74195fe3c597ec220d4069b0d893 - pristine_git_object: f3dc9d2559ac24ebb176e59aa4d036c3877afa82 + last_write_checksum: sha1:9c2eb70db62660fa846ed5804b79f98464839811 + pristine_git_object: 06d1a15b817b83f4a3db6b7d39947ae7b14db853 docs/Models/Components/EnhancedCashFlowItem.md: id: 4866c0fa125a last_write_checksum: sha1:32714cb758e95a05110c54dbddc16e2dd7eeb92c @@ -3889,8 +3890,8 @@ trackedFiles: pristine_git_object: 3fc7f56f8c4301f5323b517389e5e71df54b25ae docs/Models/Components/EnhancedInvoiceReportItem.md: id: 4c89864b47e3 - last_write_checksum: sha1:44e16593e2a3b170af09d990320f29589015e59f - pristine_git_object: dd4a7f27178b958eff2a09dd26ec331e5a4c4c68 + last_write_checksum: sha1:46b91320761a7facec84fe0741beb3e3df8b3e46 + pristine_git_object: ab514a3e04c6cd1cf47c37a5aa871b06571686c0 docs/Models/Components/EnhancedInvoicesReport.md: id: 2c2cac247fff last_write_checksum: sha1:f25201fd378df60ef1667408ccb387f08ed15ee3 @@ -3901,12 +3902,12 @@ trackedFiles: pristine_git_object: ad28f463722c6b7c867ab46866c9d4d231d6db2a docs/Models/Components/EnhancedReportInfo.md: id: be21c31b9b6e - last_write_checksum: sha1:f4064019718edadac3c6ce5456fdb300c58a815e - pristine_git_object: b9636330c737d0c59a0e4a41792308845351c866 + last_write_checksum: sha1:66a3e2d7c89a41761ea3ae968b168dca5bc0bdaa + pristine_git_object: ad01057172caa746d7b909e7aa7b0f12ccac35e5 docs/Models/Components/ErrorStatus.md: id: 8de8545283c4 - last_write_checksum: sha1:54db65bad80e1edaecafa188d720645ba04cf00a - pristine_git_object: 9dc6625538bc288b5d0290e56d43ef5d84b0e676 + last_write_checksum: sha1:d7727d2e2db3bd0e7febb0a3e8938bc7335affc2 + pristine_git_object: 1b1f72f35dd52707e60a4b835f3c6e6fbb66b185 docs/Models/Components/ErrorValidation.md: id: b9d95ce89516 last_write_checksum: sha1:677582395d374eef93c9fab9ec1e069e6bdc1530 @@ -3917,16 +3918,16 @@ trackedFiles: pristine_git_object: 6e0b6e5e3945b1fa7ad710c2b30d977332e20abe docs/Models/Components/ExcelReportTypes.md: id: c32d858253f5 - last_write_checksum: sha1:d1c6da598c2b85dd5b53a5c34e228725fff086af - pristine_git_object: 9be175f1efc994e24d07e38f126279d5c4d3d929 + last_write_checksum: sha1:ca997416d0df7ebdcae36bd5a41edf127c0658dd + pristine_git_object: fc5de185f1c8fe387f4cc059ea2e04466987864d docs/Models/Components/ExcelStatus.md: id: acdf1137dcb2 - last_write_checksum: sha1:363404b38c82fde65ec1299c8558cb61635f7867 - pristine_git_object: cb9b4b40a88ab1eee69586395e7b2ba8035185a8 + last_write_checksum: sha1:60e0ebd120e702b0822512449f546b2006339630 + pristine_git_object: bae20bbd3d692587ac0673cfe215cf5dd82a52f8 docs/Models/Components/File.md: id: 5814b032764f - last_write_checksum: sha1:977041fcb49e4cfa3e39ff7b934723b78e272f31 - pristine_git_object: d576bd807b8638bf21948133be5bb01f992cd921 + last_write_checksum: sha1:7df4ac2d9de2ce3b00a11dcd7647acdae49244a9 + pristine_git_object: f6fe888b5da4d80246e919ba46622c9a528ea0c3 docs/Models/Components/FileUpload.md: id: d748b5467853 last_write_checksum: sha1:128c828c4a6a5bf9f0f4affc872fd17a8260a725 @@ -3937,16 +3938,16 @@ trackedFiles: pristine_git_object: ca171430470c4cefd9b63ff1872f9d4e02c6f083 docs/Models/Components/IntegrityStatus.md: id: a5418fd789c2 - last_write_checksum: sha1:0ae9601a358e57f3477cd44ab4ba9994b92153d8 - pristine_git_object: 2ac8a35fff4c764a902d31de5fbbbefe8955ec68 + last_write_checksum: sha1:4dfdef64ef9ef1a8a72c08bd85f1174b4683732e + pristine_git_object: 348694215e4e93a59a5d902d9597f1d53faab4d4 docs/Models/Components/InvoiceLineItem.md: id: 3c0bc78c8116 last_write_checksum: sha1:5dab9faefb74c7274236fd6fbf59c8a8758c6dd2 pristine_git_object: 79cc5646444d6c12c4a364e3f4ad9968e4057bfa docs/Models/Components/InvoiceStatus.md: id: 5138cb519dd5 - last_write_checksum: sha1:5d474b21490bd67693b1c84d9bd73af9f2b42bd1 - pristine_git_object: f222c06be65d6334551c11391cf1613211654a78 + last_write_checksum: sha1:55674ac4a6e4970659c20ebfc663d3adec9b9231 + pristine_git_object: 0a31e0678187c5970485393f45a35e92dc33f73f docs/Models/Components/ItemRef.md: id: 46c5142a9b17 last_write_checksum: sha1:93c71a52beb0169d3683fafc423e527b2652ff81 @@ -3965,16 +3966,16 @@ trackedFiles: pristine_git_object: 013d4f2e477cc8cb9c380014570381c1d0af800c docs/Models/Components/JournalEntryRecordRefDataType.md: id: e1c9ffbd5b08 - last_write_checksum: sha1:a4bec81339d6c9f815f69e13e073d4f74d4a5273 - pristine_git_object: 818b825fa80be5813d4cdd20221256dd9fb79942 + last_write_checksum: sha1:1dcadc2f333cedce0e6a9aec4442527c9566fed6 + pristine_git_object: 750216fa7c38d79bbed474189b8be757ab031086 docs/Models/Components/JournalLine.md: id: 9f4c7c7029af last_write_checksum: sha1:4c40b2b730a3e540f9313faf3070b87f2b6dd99e pristine_git_object: 78441d7a7456671ad9e52d401d3ebafc6bca959d docs/Models/Components/JournalLineDataType.md: id: 25f197354792 - last_write_checksum: sha1:ebfde6bc0a38d12f665f54ad89affb48c71e0a8a - pristine_git_object: 83aab476b5a565d16e604f9d8025f2e862d7f44f + last_write_checksum: sha1:a8a0589ef0e429604ed1133f91a5a12a35329360 + pristine_git_object: dac029923ad1a700d67e718c50e8e24f59305484 docs/Models/Components/JournalLineTracking.md: id: aa05fa1b47f3 last_write_checksum: sha1:681246a500f701c28b5317ccd6df33d83fb6881d @@ -3985,8 +3986,8 @@ trackedFiles: pristine_git_object: 775d96e77135ca17da4a4ac50a619341fb41989d docs/Models/Components/JournalStatus.md: id: 6f6ac747e642 - last_write_checksum: sha1:2ddcda7cce293ac63c142ddd00e66e40e2da03f3 - pristine_git_object: 86c1f1108985c5b0ca5285c09a60a625da04f3ef + last_write_checksum: sha1:7fb29f5288756339073a6371752b4b845bfa8105 + pristine_git_object: 254161ea98691172c6112f4ed6ad80e4f7faab41 docs/Models/Components/LendingCustomerRef.md: id: 7c3c2fe35b23 last_write_checksum: sha1:2a47e54ff31a1e48b5c6b8f50bbbb28b7cd80679 @@ -4005,40 +4006,40 @@ trackedFiles: pristine_git_object: 482a7640fec04082f6eaa5411aad9e4c2bee1c0f docs/Models/Components/LoanSummaryIntegrationType.md: id: 8e72c297f946 - last_write_checksum: sha1:06e93ab1dcb4a9adb2dacbb62978d28f9e89055a - pristine_git_object: 9d796264c1678622b18f793ec96c6cf8ddba5f07 + last_write_checksum: sha1:b03e4cd11b330b6ea4d6480bc1bae5f3dfdb459f + pristine_git_object: b7db526d9809e9417f273554c6be0cd842db31c8 docs/Models/Components/LoanSummaryRecordRef.md: id: d3e7eeb20d19 last_write_checksum: sha1:43c79ee5acddb0186c29b1190e24978d70be20c2 pristine_git_object: 10df9f3aec269cc3134a569f59d966cbe8473886 docs/Models/Components/LoanSummaryRecordRefType.md: id: 8bd3f5f58fd7 - last_write_checksum: sha1:4161e76dff7d0156e5c23d56a801a44cb9c455c2 - pristine_git_object: 7d45d54c98163289a0d78e824b0c3bd425836e09 + last_write_checksum: sha1:3f2252cc607fe8d1cc251369dd716904bc76c1b6 + pristine_git_object: dd3e50d703aea05aa0242c421b38638a2e4c7636 docs/Models/Components/LoanSummaryReportInfo.md: id: 0a8ad39d7fc6 - last_write_checksum: sha1:cd429d9523cba93cdd32032eabb42bbac3bae9d3 - pristine_git_object: efd576102c7ea3ade58f7ddffe409ec4d1e6df83 + last_write_checksum: sha1:c3eae05af726f13701e002252360b3872cedd6ff + pristine_git_object: d3cfb3b5894a0fe980980579e3dea3bda7946165 docs/Models/Components/LoanSummaryReportItem.md: id: bc63075c13fc - last_write_checksum: sha1:8504015c42e65c7e8d11676621eabd11b688eaa0 - pristine_git_object: b3f86d10cb64d3633c5ceda8e83333760412d35e + last_write_checksum: sha1:c16449ff4dbfb6f796421510cc4291856322c2d7 + pristine_git_object: efa7069286093bcd67bb1da810c0c2f02302ebb8 docs/Models/Components/LoanTransactionType.md: id: 2ae68243f5d1 - last_write_checksum: sha1:0fc2f543cde00d8660c418973e25122cbccf2763 - pristine_git_object: af7b32ab86298cbf2bc8b567fe5dfee6d4943395 + last_write_checksum: sha1:d9cbe35444ba38f1b642cfac85d65e9ba84e85da + pristine_git_object: e103b2ee070d4efac7e9073a3b0eb606f273d042 docs/Models/Components/LoanTransactions.md: id: 884d2c6f8988 last_write_checksum: sha1:7719edb2db660c2f9e39a15f02d2b0c74a011fbe pristine_git_object: 90ba77b251fce0833f1d607c8e588c4039787ab5 docs/Models/Components/LoanTransactionsReportInfo.md: id: 2f4edb57e3bd - last_write_checksum: sha1:758af320637f40b3324c9560a22f2d0f5ff77499 - pristine_git_object: d5ee5bdc3e452c8a024c85cc793552bb2f8d5f69 + last_write_checksum: sha1:9bd5b29e1bc5d168a178650c57311ba2dd134fb4 + pristine_git_object: d735470254e2e6c90bc4025f2c6688749736ab23 docs/Models/Components/LocationRef.md: id: dc99067b98ac - last_write_checksum: sha1:f76b077cc54f4d3a51599938fe6db82e8c527ce9 - pristine_git_object: 0c036aba198f3a98021fc1e43eae7c982bf1a2fc + last_write_checksum: sha1:e5eb1598c473d6edba3b36a23304ebda13fb4023 + pristine_git_object: 8e30aad4d832eeb881035a6911cb14e12b674577 docs/Models/Components/Metadata.md: id: 5b37a8eb1a69 last_write_checksum: sha1:cf72e3408eb8b26e434c121af2b28d0645ba640f @@ -4049,56 +4050,56 @@ trackedFiles: pristine_git_object: 06ada0c35d6bd20a2f4b9fe1ddec53ebf3dbe789 docs/Models/Components/OrderLineItem.md: id: 340075cd3e20 - last_write_checksum: sha1:9673b91fd135f93793c5e4a7915bd9f15f33bfc8 - pristine_git_object: bea1f45f624194d1249061db648465ec762f50af + last_write_checksum: sha1:d1c3d3c1f5f216fc59d4cadde557438a15971ad6 + pristine_git_object: 7d8c994d06b3577dea9bc521dba6ae371b3590e8 docs/Models/Components/Path.md: id: fd3916ad0a4e - last_write_checksum: sha1:fe0fb5d34fce3eaa34310293f3a62932b32e15ce - pristine_git_object: 3677418ab5eacdf7d4280696232d79fe1883fcdb + last_write_checksum: sha1:c4b8e35d92e65fe0fdd4feb81ca3de27709704dd + pristine_git_object: c1b8d9c9a5fa750c964cff4c0fa43afb5ebf2451 docs/Models/Components/Payment.md: id: 52f805a36cbb - last_write_checksum: sha1:06e1c1e77a0501835450b29e64844519d2e90c33 - pristine_git_object: dd4b4b74d5d7a698d44344f03f360ad47717084a + last_write_checksum: sha1:b61807672fb2bd9ec25d1ec3f9c439070a631173 + pristine_git_object: d03e466ef746d27dd10f80bbb17111f24df4bac8 docs/Models/Components/PaymentAllocationPayment.md: id: 4bce1e662749 - last_write_checksum: sha1:5948dd8ac9cbd598aef5f24832345d139edd0de8 - pristine_git_object: b36fbe8781b6bc7d923063fd37738b6b13a14ecc + last_write_checksum: sha1:4a937d8d5b28dfe6108c12da40e55db4812d9cd5 + pristine_git_object: d59ac4fed8d90ba85434001f88641390adaf0b17 docs/Models/Components/PaymentLine.md: id: f012725b2140 - last_write_checksum: sha1:9118fd9dd85665eb584931d79569a495cddfb9cb - pristine_git_object: d7ddd19d225adc58efb2e293b4837d586e74cf91 + last_write_checksum: sha1:20131fec4a608ed9264c3a5d1de12de63946ea87 + pristine_git_object: 119e004034bd7d52bf9cffbba72ee901f87df9cc docs/Models/Components/PaymentLineLink.md: id: 4f42e71e55f6 last_write_checksum: sha1:e72ca384b9a8f40fb9ac3cff7f61bba23e76e092 pristine_git_object: c4e75b5de25e38ce64fa89abd78030b846bcdb88 docs/Models/Components/PaymentLinkType.md: id: 5320408e57d3 - last_write_checksum: sha1:4312199d9e46d07d1ba320026f60d950855cd019 - pristine_git_object: a705ea78eb64a000457216053389aa37f19d5f31 + last_write_checksum: sha1:9ff665cb863c66f92a367428b121ebfd7a5b0aad + pristine_git_object: 9048aa3e538c95b3a72fc06a31de3110d5b8735a docs/Models/Components/PaymentMethodRef.md: id: f66f700a55f2 last_write_checksum: sha1:2fd2de6f0fe060cbaa54f9dc5f4e7bfaf76cf1c7 pristine_git_object: 4d937f4367cf6dd0c0bcccde9677155d48a52897 docs/Models/Components/PaymentRef.md: id: 076091147ca5 - last_write_checksum: sha1:5116f4c1bca0c73b37f3d0b36b88f0f41eedbfdf - pristine_git_object: 92e3455b57c0c29e33a95e09a5497f13653d25fd + last_write_checksum: sha1:56feba496e07a0572eea244c07e130613373ac2e + pristine_git_object: 9d5dc2bed82e32b772e45366c519799362a714dc docs/Models/Components/PaymentStatus.md: id: 4ba2dbdbfc8f - last_write_checksum: sha1:867af4749272c9b5aa458e308582dcdb60b93fe2 - pristine_git_object: 7509d3f5e568250ff65511f02ea4dfe3a95f6df3 + last_write_checksum: sha1:e358bd642bd3390199de1579851b371c79da8176 + pristine_git_object: 1c87f9ee8f00581264a0027048cd77d6ac2911bf docs/Models/Components/PaymentType.md: id: d7966ebde9dd - last_write_checksum: sha1:4b360fe3446a42bccc774b1362247256e560a072 - pristine_git_object: 10be107dcbf088ece1b4fd3bfad0d855ec201fea + last_write_checksum: sha1:e9687f452e16baa4e533ccd748fa366e35a10863 + pristine_git_object: a71d480143f835b651f62af5a8683cfae41cbfd7 docs/Models/Components/PeriodUnit.md: id: a925a220b121 - last_write_checksum: sha1:f2ca2c716fa08d7fffb1c49552892ebb6990fd97 - pristine_git_object: d15352d78c510902e7b0bcbceda69f34045ad42b + last_write_checksum: sha1:58f0591f926fff6bd5b03436a4f6a806eda6d83d + pristine_git_object: a51e86c45b61fcfe71ea8a3e231c301324a97194 docs/Models/Components/PhoneNumber.md: id: 727bf0dd3b4e - last_write_checksum: sha1:e7aae995eb0786c02a13c0753b4123ac674ad7d4 - pristine_git_object: a2c00cae4a4a8f35a0fd287b32ae35173246268f + last_write_checksum: sha1:a13c8e38a0a6da358e9cf89e1478b70da081e468 + pristine_git_object: 4f8e3322b6056e3520bbac069a254407f3aa1981 docs/Models/Components/ProductInventory.md: id: 5fdfb1f2731f last_write_checksum: sha1:b270ab3fe95f13196ce990677f5c796bbe22135f @@ -4109,48 +4110,48 @@ trackedFiles: pristine_git_object: 3f6d7998915c3657e2f18327bf1ed91896460add docs/Models/Components/ProductPrice.md: id: fed045151cb4 - last_write_checksum: sha1:375a007fe3cf409b2d3522de8ee3d7bc7aa0f3d6 - pristine_git_object: 6fc6f2a02663bd8d995302b201f9857ef983a35e + last_write_checksum: sha1:53e25d6777b76f3cdaa7639ea80d58e138717640 + pristine_git_object: 8f71c050920d37920108bc251d436de20b57b313 docs/Models/Components/ProductRef.md: id: 2ae357b5c4c9 - last_write_checksum: sha1:f47c9c9829ff7fd09f244e6b4e5dfd415a4b4ddd - pristine_git_object: 13bb14daed3112c2a1de7b2d1378cd698340deba + last_write_checksum: sha1:0911c23d5e9df615645fd04ab45a45e0d4b0bb0b + pristine_git_object: f8d017895651e174598397ea6e5d3de41716daf9 docs/Models/Components/ProductVariant.md: id: be4faede84ac - last_write_checksum: sha1:4604517e32378b6511dcd11af25d6b7daf98d258 - pristine_git_object: c3a2c539b60391a30827afb0353563ac0c08b50f + last_write_checksum: sha1:861290918db924e36802a5e37d31c4b4a9b319bc + pristine_git_object: c21a7e14a100b93085c3b6e8adc675ec36049cbc docs/Models/Components/ProductVariantRef.md: id: 96cfcae7025e - last_write_checksum: sha1:8207ece914b762a958cbefc6ce8d9d259d3daaea - pristine_git_object: 3d8c462eab26e1ac79ce73f237b7b0b358b472bb + last_write_checksum: sha1:66904b1c7e9b6ffc7715c4e8f0df5d4f18ddfcf2 + pristine_git_object: 66cbb33bd3708d039bdc44004e2dc135430d7701 docs/Models/Components/ProductVariantStatus.md: id: 03c9036353f0 - last_write_checksum: sha1:310b9a55451948b01d25c8bbf7c351534837e2c3 - pristine_git_object: d443d83cad046b5f31c7ff54f01871fa42980aed + last_write_checksum: sha1:11b500b44777e71b61ecc75df864dd06b63862a8 + pristine_git_object: 3cfc01f7ecd6220adcf722960bb0183d219cf340 docs/Models/Components/ProfitAndLossReport.md: id: 5eaae52fc66b - last_write_checksum: sha1:af3bf2d17dc4290ade5f0541e6775152303e107f - pristine_git_object: d4f5290bf8388a482f6a4450450ead0898aa24ff + last_write_checksum: sha1:a6192c152f01de30f769b285f6d61d71ac82bbfb + pristine_git_object: 13e3c173005bb2d3c096e34b0f726f7132a59300 docs/Models/Components/ProjectRef.md: id: 554f28d1824c last_write_checksum: sha1:512943a1478e5b201937c7ae7a5060bfc1ed5be7 pristine_git_object: 43d81ed77b280f428f9bc2c41fdcf77e31f03924 docs/Models/Components/PropertieAccountType.md: id: 818e50c9eea8 - last_write_checksum: sha1:997aaec8644087584b8e0698dabffa17ce19d900 - pristine_git_object: 0cf70a60acf82ddd216d990419d56d169be90c7d + last_write_checksum: sha1:363bc94312b1d3f47f5873240ea33c4607560881 + pristine_git_object: 600d9b852097aea41e65cc626efb3cf248fc9f1b docs/Models/Components/PropertieDataType.md: id: 762ec38da488 - last_write_checksum: sha1:99dc3a362168b64db858497a3198f87c539af510 - pristine_git_object: 1defb94d66790f74f6a82c8344e7e100f2d7b452 + last_write_checksum: sha1:6b829762daf0fdd90ac284c51c118e924a51cecf + pristine_git_object: 1bf4a33f66e9326922d98ba9976f6b993813eb1f docs/Models/Components/PropertieItemRef.md: id: 4073f46dd335 last_write_checksum: sha1:a9942d7fc12d077cbd6b812c2c5c31c6f965c2d4 pristine_git_object: 9381f45e6a9001a9fc2f52d9e299abd254637060 docs/Models/Components/PullOperation.md: id: a8fc1e3b5979 - last_write_checksum: sha1:61beb3ec2cd715f53bf2e871e888af7bb04cfd9b - pristine_git_object: babc4322a41afa1a26af37ddb435a28a964e12f8 + last_write_checksum: sha1:3212e7fa1f8a349658670aa49d809c07b5817d25 + pristine_git_object: 936c87ec5b596a13e1e465d77d255ad11b4324b9 docs/Models/Components/PullOperations.md: id: e0267625338f last_write_checksum: sha1:0128b4a63904dcf68e352a0c4a4a96294e810776 @@ -4161,16 +4162,16 @@ trackedFiles: pristine_git_object: 2bde9606f2743bd282090c86da1dad17f4aa74d9 docs/Models/Components/PushChangeType.md: id: 5685effee77b - last_write_checksum: sha1:18ec22aca07ce19b41a703ad1cd57154089f9112 - pristine_git_object: 7585e9c8cf7ae495dd24a7da9b7ba4a1b4bf1452 + last_write_checksum: sha1:3f0e4cc0d7a73d8eff95fdf44fce4ea828aee298 + pristine_git_object: ba892bca1c780bca13946df0e46e378b11f6412b docs/Models/Components/PushFieldValidation.md: id: 9607e156634c last_write_checksum: sha1:ad48b5af8f4beeb07de2735aba150068b7f9a67c pristine_git_object: 1b11ccb06268027c20a6846aba856aaca3df5a1c docs/Models/Components/PushOperation.md: id: 9ae4cf214bf3 - last_write_checksum: sha1:72b45375bad5e9ce889155a525c3a012a8b843f1 - pristine_git_object: d8010b6efa0732051402a26fc8b8dfa6039f3ad1 + last_write_checksum: sha1:5865d39364dd19f7f4772efaf7160a95fd39255f + pristine_git_object: e3a760fb2f2a13b81631ed8e613889912f9752ee docs/Models/Components/PushOperationChange.md: id: edcf91f1325f last_write_checksum: sha1:ee2c15c62c0d6d8f0162132f565c2109478b6774 @@ -4181,8 +4182,8 @@ trackedFiles: pristine_git_object: 484517235eb18da7da15156e98d5b2986dd41868 docs/Models/Components/PushOperationStatus.md: id: 3359930e9d1a - last_write_checksum: sha1:33fd1e78d2677a1d351510a53e2add8c200da2d3 - pristine_git_object: 4e041b534abc59050686f121dcd3852b4e61dab5 + last_write_checksum: sha1:d57b0a340c1a0e7fe4c54f735023400bcb333461 + pristine_git_object: c7d3a5b3dc733ab31e1771aa29ef045480195e5f docs/Models/Components/PushOperations.md: id: 3dfee1c26472 last_write_checksum: sha1:ccc4d07173cfc456bc71de81715be4e1bc4b76f7 @@ -4201,8 +4202,8 @@ trackedFiles: pristine_git_object: 30d421effdca873f3c4047fab0741f8b54153e0e docs/Models/Components/PushOptionType.md: id: 8aa224aff3cf - last_write_checksum: sha1:c733fb80305dde395b3ab35c9f736d366bd901ca - pristine_git_object: f1bb3708829f9e73977f820d3da9e2c834a0e365 + last_write_checksum: sha1:30abe4d8b09978e046644748f6bb5f061fe15173 + pristine_git_object: e227214e173f5932d1cfbf5f2c009799f11d46c4 docs/Models/Components/PushValidationInfo.md: id: a47e1d5b7c43 last_write_checksum: sha1:7221d753ed7ecccff1ccede4bebcedc70c8c0dca @@ -4213,8 +4214,8 @@ trackedFiles: pristine_git_object: cc0286cf756493648ee639b8d3f26034eb8fdf41 docs/Models/Components/ReportBasis.md: id: c3a6b0e8728e - last_write_checksum: sha1:0ff5175003ec5e923b3c72d7dd319bbc94076cba - pristine_git_object: ac3d9627622c86c1d6aa69ce2f34a483327a8b8c + last_write_checksum: sha1:6d5ec41c87069055b2780f84250b1607f3acb2c5 + pristine_git_object: 5e5fee849bf8decdab7f0f4339cfd176d863ea15 docs/Models/Components/ReportComponentMeasure.md: id: 75e7766d714a last_write_checksum: sha1:982840a035341f63fa9e12d5488c63e07bc63485 @@ -4229,40 +4230,40 @@ trackedFiles: pristine_git_object: 4fe15374d14a6d7e9f4245f0524c865ce1e41651 docs/Models/Components/ReportInput.md: id: 3207e75afc39 - last_write_checksum: sha1:68116bbd4ba63fc22ca9e76710aeaad6a46692c4 - pristine_git_object: 1e1e6a2f0f6927f6738ec5d704620bc6f9a8a252 + last_write_checksum: sha1:655415d197a6aed1dcde0176a956677abf9acc5d + pristine_git_object: f9e7b611ebbf5e2af64de948b847ae28e71718fa docs/Models/Components/ReportItem.md: id: dc5e30af7b80 - last_write_checksum: sha1:8fc049f6f7c87a8e03ab1db6becf5aa35616f187 - pristine_git_object: cf5f2cce01dba73f671d6c0b62df63d3d070f4a3 + last_write_checksum: sha1:27ca878f345fd2f587b862c6020ccf52e02961d8 + pristine_git_object: 90e35ee7a7767a69b7ec39f2aa3a5926af1af37b docs/Models/Components/ReportItems.md: id: fcf313bb98ef - last_write_checksum: sha1:c38543bc88a05716c5da6ddb841e4d711f313153 - pristine_git_object: 1326ea9da622b798b0542f252be117d12ea4c7e6 + last_write_checksum: sha1:d5eb06e17f2e23f0e473249d07616a0a3afe1c5b + pristine_git_object: da3190b9ae9f49df498a4198c778cd09f83c9fe4 docs/Models/Components/ReportLine.md: id: 04d92730b042 last_write_checksum: sha1:5b1e1a8d442359a146f9788d78d8a1a0b22ed30e pristine_git_object: 8c8ba38bfe184ec01e7af39a44f5964d5b352d91 docs/Models/Components/ReportOperation.md: id: 5da3a9e0577c - last_write_checksum: sha1:b153b17517bc263613d609aac56b56dc1f6f61bc - pristine_git_object: 4241adead7b61c9c3b116da6cd840e9fb5cdfe28 + last_write_checksum: sha1:c4679e434408fb34d45458a837ac0675ce932f3b + pristine_git_object: f42537506ed3c76d68a66d43fc99f78359684282 docs/Models/Components/ReportOperationStatus.md: id: 3cce12cde5d7 - last_write_checksum: sha1:f6102e10a9688314aeaa941e743792a682e62708 - pristine_git_object: e3ad61b7009d0fcf1aeb5b660045fdeefa422d0f + last_write_checksum: sha1:0739ab052691ade588a08d30d475e6fcc7212484 + pristine_git_object: e2fea2f42e4e2df9d055fd2b46ad90b76bf52dae docs/Models/Components/ReportOperationType.md: id: 1185f9428b0b - last_write_checksum: sha1:fd026b3b35d200b205a80531eb432fc17815acec - pristine_git_object: dfbf3c68225e7bfaf40be7a58508f410b21b20a3 + last_write_checksum: sha1:2313f390657c4628e841c975b2839ae55987fc5b + pristine_git_object: f9908c641c39813758fd4d8cac19cc6b8c2b7b27 docs/Models/Components/ReportSourceReference.md: id: 37252adb0c78 last_write_checksum: sha1:c5af53fca3bba97bc9b6d6aad411d067a9ec5506 pristine_git_object: 879b93cdd35b69dbdbc1ed78f9ca0fca7c5436cf docs/Models/Components/ReportType.md: id: ac974f34db52 - last_write_checksum: sha1:3df0bf9cd7f58b8bd82390edb51d9bf849f149d2 - pristine_git_object: 2f6c136b6d58d3f0eaf73d69ebceafa8371e8f66 + last_write_checksum: sha1:5ba76a8e54fcba882930317e8844ce3929e4ffd0 + pristine_git_object: 3fe468c606d17aaef0014612013cd3c448d47928 docs/Models/Components/Reports.md: id: 4e3059304e5b last_write_checksum: sha1:254ad9ed540fdc63a88c6ae9b8ac3878bfce8052 @@ -4273,80 +4274,80 @@ trackedFiles: pristine_git_object: 3bc6d6273f33c2e22eaea9ace4e19b0e943158e8 docs/Models/Components/RoutingInfoType.md: id: 5c05bae28595 - last_write_checksum: sha1:4126e42526be8379ade2cc3cc5feb68538783638 - pristine_git_object: 232fa657b790842b55e7951850a1bd67b96ce390 + last_write_checksum: sha1:91832789478ea03230950f640d7a85167ecd5959 + pristine_git_object: d89ea301c8ec810ea809dfab2dee00a8b56a2384 docs/Models/Components/SalesOrderReference.md: id: 376df1d1376b last_write_checksum: sha1:2c2ec0150ddfd4b98a54f2b19c9aecb6ce26ba99 pristine_git_object: 83a9e6156571d9fd76c2c820a88c04f8de17f9c6 docs/Models/Components/Schema.md: id: d171f8ca7d08 - last_write_checksum: sha1:8bbf54ea7b4682e093965c6908207834a69cd612 - pristine_git_object: b9c178a6b30e2ddcbc2d30b1a97b2e059ed2b303 + last_write_checksum: sha1:8dfb41f5baa371881ce48d10ae4c0cc265250fc7 + pristine_git_object: 7ad742effdec893a8be529322603df0a5bd801f4 docs/Models/Components/Security.md: id: 7bcd54fda13a last_write_checksum: sha1:afb3c4b0cb11e752dd6bf6890c9331d4d0adc0cd pristine_git_object: a997c0213ebb03783bfda0a7559d0e1f0fd7d463 docs/Models/Components/ServiceCharge.md: id: ce3ee35830f5 - last_write_checksum: sha1:416408872acc5ff6a29c4b161527250f8051d135 - pristine_git_object: 2be9db5249c26eaeedce3ae392760f3ca4f71247 + last_write_checksum: sha1:b474467492e4acba58a77c78ec16aeb6ee692f3c + pristine_git_object: 536c246ecdf7d7418578be567161c2368c3003c8 docs/Models/Components/ServiceChargeType.md: id: de5437643206 - last_write_checksum: sha1:b1b768a8ea13e17e768b3496f36861182392d266 - pristine_git_object: 4fbe44a372f6d8d97963b71854026950be579a13 + last_write_checksum: sha1:ebd45c9dd9600f3334c10180e3237cec8cecda09 + pristine_git_object: 8d57a865570b493b698b9f313e3d691ae6199587 docs/Models/Components/Source.md: id: def1b71a1b02 - last_write_checksum: sha1:7a0abce30520d69884cb009286b8e4a58b92fb23 - pristine_git_object: a005650356260adbad17711e78627f4b5f95d041 + last_write_checksum: sha1:32f80f478ac5d40193d6fb7071517b08403dd7b5 + pristine_git_object: 8a12f16dc422fdd0c7061cc152efd5d9f7bcc40e docs/Models/Components/SourceAccount.md: id: edbab536ea8e - last_write_checksum: sha1:3a56e955706ab698522562ac9ed3ad7dbee115a8 - pristine_git_object: b22d21be421b8b54f9e8d1f4b5bda8d23f3a1848 + last_write_checksum: sha1:d8f6fdc016bbf60784570045be257acc70f14133 + pristine_git_object: e712fc97ff74e75da0aee78e692247c7664fbdc1 docs/Models/Components/SourceAccountPrototype.md: id: 5a96e422d15e - last_write_checksum: sha1:2927440a74aafccebfd59cc21536dcb255c6752f - pristine_git_object: 9153044f488df05a4fc3ae24207eca09d1e83298 + last_write_checksum: sha1:eef120e54297ba3879abf7e12963758cd9365d2d + pristine_git_object: 60030a98b02b93658b5a97f84548351fc524ce49 docs/Models/Components/SourceAccountStatus.md: id: 4b9e51d56b13 - last_write_checksum: sha1:fd7217814ab267c44580c2982727441b53f59d77 - pristine_git_object: b10dbe8de055204ad269417ad976009e9f484a6c + last_write_checksum: sha1:e369059438aa146081bea5e9f6a6121e8ef2b7f7 + pristine_git_object: d25a78bd3cbbb201be74c645e8aa34771e46a0e0 docs/Models/Components/SourceAccountV2.md: id: f782cd3efc27 - last_write_checksum: sha1:fe0a3e5b989826611c096652b455bcfb4d96ed84 - pristine_git_object: 6da7d070f8153371cd6135f105644890c694cf8e + last_write_checksum: sha1:bc5052ecfd7c1453593c4e2f94d2c0ce7d822399 + pristine_git_object: 89b55f82b65a04d0299eba18e932ceaed3a69ca0 docs/Models/Components/SourceAccountV2AccountType.md: id: 9615b8165382 - last_write_checksum: sha1:8be5adb697720f4a5ae24e9e28d2899246dfabb5 - pristine_git_object: 827c490bdf2db2dc43ee274cacc0a5505ea6d147 + last_write_checksum: sha1:4e4b3d6309fe8375839c270c3a30d5c508750ddb + pristine_git_object: 26f9c7f07ad3602a7a0207366e8301c13c33b66c docs/Models/Components/SourceAccountV2Prototype.md: id: a3f73f6b2669 - last_write_checksum: sha1:5b8eded7730c34f6842c0d7e0013ca6def51c29b - pristine_git_object: 120a01d9016b6ac78acd633bd5ed7a5f37865173 + last_write_checksum: sha1:499ec34d274de12717a40da8b77e7611a10114d3 + pristine_git_object: fa067a530806ac476ee7ca5e878753670b621954 docs/Models/Components/SourceAccountV2Status.md: id: 7379578a1acf - last_write_checksum: sha1:cb83f07738cba0b9186766d6cd679257968deed2 - pristine_git_object: db69a1326a2ae8820088fd9876a9557d1b0cacaa + last_write_checksum: sha1:00c02f54ab45b5ba79ffa64018f39d21b3b7e766 + pristine_git_object: a7e00f417e9a5d0e84ca20a526b2f175a55da1f1 docs/Models/Components/SourceRef.md: id: fe20e3689655 last_write_checksum: sha1:bcd707ebb16726d495595ee85f02fc69d428f8ea pristine_git_object: b5e3404248b85c2f9b64fcec9bb649d61e0b07cb docs/Models/Components/SourceType.md: id: c28bbe36cebc - last_write_checksum: sha1:f03d269bb54c4c8c38078a56ace7aba84193e83d - pristine_git_object: 3ddd34f70f3d4f0233402b8450a8002d16904e84 + last_write_checksum: sha1:e5fbd4d786f895b9b5c443efa1f4ba4945b5ab7a + pristine_git_object: e6d07f55274634443c7c4df0e8d165560bcf5c72 docs/Models/Components/StartUploadSessionRequest.md: id: b4032ba0fb1b last_write_checksum: sha1:0e50621fcdf100a627b0682077d8f976e7bbc41a pristine_git_object: ad0adf1aac2338888310578f16dd6edfac8ea36e docs/Models/Components/StartUploadSessionRequestDataType.md: id: 457a57689172 - last_write_checksum: sha1:1ed3af282de0bec3f43f77a3574c476be5ce90af - pristine_git_object: 3d7782f67fcd9769653bf9df1b6274076e50f52e + last_write_checksum: sha1:c812779b63ff1006d91d76fa5f112b463940ff79 + pristine_git_object: 96153c56b173ce80a567086aeb92d2aaa1ebd187 docs/Models/Components/Status.md: id: 71d0264ee613 - last_write_checksum: sha1:3ef7557d13c818e213f9406ec88a8530e8bc43b2 - pristine_git_object: c15395bab7aeb02cb2913330509f975010e509d3 + last_write_checksum: sha1:05f7f56ad7a389823c5bad777bc5b99209466343 + pristine_git_object: 966970913e42abc5a9c30e3f6c7565af5aab6796 docs/Models/Components/SupplementalData.md: id: 6df6a4f00739 last_write_checksum: sha1:c28abaeeee700c566fb4ee1288f22f8f9e2a7ad5 @@ -4357,8 +4358,8 @@ trackedFiles: pristine_git_object: ccbce3052ed5c3d132e507b438794e8457f8b370 docs/Models/Components/SupplierStatus.md: id: bcdaa17ab65f - last_write_checksum: sha1:3daf809a3b86d6c3c605f4bb4470837d3e091f00 - pristine_git_object: 328b27e13caa24656927d381050c965d48fda507 + last_write_checksum: sha1:8bb5446ef539d971caf63a685dfb9d0232a97fee + pristine_git_object: 2160ff04ff4960f03c0c26d91a63621e1858899e docs/Models/Components/TargetAccountOption.md: id: 0f2d30cbea3c last_write_checksum: sha1:95cc4544a76464083c7b98f208f74a4443eba81e @@ -4369,8 +4370,8 @@ trackedFiles: pristine_git_object: 1e43d46cadceb0430ee60ef512d41ed7101b5ab7 docs/Models/Components/TaxComponentRef.md: id: "344159363871" - last_write_checksum: sha1:7c4070d2d6c56d3df8f4754423ef1240b1d36df2 - pristine_git_object: e6fd79972f0b5cacfd3414cbc02a1ab3fa9d5e2a + last_write_checksum: sha1:a6959048199f76e20ff39fe1f36635d2a1f6c065 + pristine_git_object: 9321d769e245efdbcc8ae99cf40a0bb0e0e13c69 docs/Models/Components/TaxRateRef.md: id: f00c28cd2751 last_write_checksum: sha1:12330eb02319ae4c7b03b5e09f94620144b6d824 @@ -4393,8 +4394,8 @@ trackedFiles: pristine_git_object: 79691e8aecaee56907fef9379ba251a2620e465f docs/Models/Components/TrackingRecordRefDataType.md: id: ee2d97871cd2 - last_write_checksum: sha1:3a3d1a19caec9669fb5b41f3fb25fa48a2376902 - pristine_git_object: 371456315d69f2bcfeae24e47d8dee25559a6416 + last_write_checksum: sha1:5f7ca56059083602031c4e03faf40a1db7593780 + pristine_git_object: ab20140d04bd8a27e33d27eec4083b4d5e5d46f9 docs/Models/Components/TransactionCategory.md: id: d85c58aa9899 last_write_checksum: sha1:5f46e728744544064381021768990744ede31d61 @@ -4405,32 +4406,32 @@ trackedFiles: pristine_git_object: 2f77247999f00f6fc83537b60b51d9347cc62c5f docs/Models/Components/TransactionCategoryStatus.md: id: d3f1a316951c - last_write_checksum: sha1:2202e3eb398e2141f6cae2942f30db84ed6d5e07 - pristine_git_object: af57627a66f524bc06630bf5b90d60ecfd236ba1 + last_write_checksum: sha1:a22bf9de04f8f16d8c632924f4244a5d9a2b6534 + pristine_git_object: 2a4b21f679366c079deb074ec9462fb98e48202c docs/Models/Components/TransactionCode.md: id: 9e4103f31861 - last_write_checksum: sha1:9b90a236490eec2e363ece48c50c3b743bea533b - pristine_git_object: a9233e1dc50dd5680612e8fa1f4da02814ee9446 + last_write_checksum: sha1:2e235729020ec988d6317c9892ab34008c43664c + pristine_git_object: 628c89f3ba9915f44779dc62099c5d4ae5c22811 docs/Models/Components/TransactionSourceRef.md: id: 17f7cc4697cc - last_write_checksum: sha1:c4832995738d231978cce7e80064b4d4da8d6494 - pristine_git_object: d5974109f37d169c05f397463b5270629fe41bdb + last_write_checksum: sha1:959c3c3fce62347968c1fb1c6be393338f49d332 + pristine_git_object: ccad994716c417843f37a8d5abcf35d1946779b7 docs/Models/Components/TransactionSourceType.md: id: db181ee1ab42 - last_write_checksum: sha1:6c7f4a1f662ad9cd87dcc4bc174da9564f6a22c4 - pristine_git_object: b0110df81a5f1307bec17347a6c203b0d14c7523 + last_write_checksum: sha1:173298c3f3f6d4102a156897bf48d419dd5064ef + pristine_git_object: 23a1ccf544cefbc46dd070b49660b9a5080d957b docs/Models/Components/TransactionType.md: id: 556898f9ef43 - last_write_checksum: sha1:f30145227f9344b1e220fd5a21556445f90ffd50 - pristine_git_object: c32344890685e7aaef687f44c4004995995a1ec7 + last_write_checksum: sha1:a4355e77e8ead4c11dcff89033f93cce27f42f9a + pristine_git_object: c80d8c2e94c100a97a8d03153dab1394cea8b3fb docs/Models/Components/TransferAccount.md: id: a305d332645c - last_write_checksum: sha1:e3da874e6055c47ffa5adfbcfdac43deb903c114 - pristine_git_object: c31781a8e5ca13335612e2ba2692dbfe5ea4543f + last_write_checksum: sha1:271e6929e1ba45b3cc3d6aa513b1822b528ee7dc + pristine_git_object: 4d334a5e307dcfb9710c16331939b4e0dd8d931d docs/Models/Components/Type.md: id: 78fd88144819 - last_write_checksum: sha1:454854f79d794f0a5cd50439027f876bf5622e5d - pristine_git_object: 023a8fb3760aa2745307349ea57a7f261cc4e34d + last_write_checksum: sha1:49ff1345a44403d303f28fd89ac1b6f1e38e691f + pristine_git_object: 39f76e1483e225f9e78d4a9ab853511adfbbd17b docs/Models/Components/ValidDataTypeLinks.md: id: becca358e044 last_write_checksum: sha1:ea8ac2833efcedad217010e022990882a3840638 @@ -4449,8 +4450,8 @@ trackedFiles: pristine_git_object: 22d77b10234433b1648abb5610cea8c12ac6e0cc docs/Models/Components/WebLinkType.md: id: 9a3d48434805 - last_write_checksum: sha1:8c07d80f970c641060c49edbc1a98e7c080cc50c - pristine_git_object: a091ba93e792bfb0e908ec431d10a5ea339b3aff + last_write_checksum: sha1:457917e5cc23faf2ec56b57163b094ee48967baf + pristine_git_object: f5de1509f87a6b942089456756d310cb99e371e3 docs/Models/Components/WithholdingTax.md: id: be63f00d41c4 last_write_checksum: sha1:85ae8a61770e2c2123af3ffb41ee1abf96f4b011 @@ -4461,8 +4462,8 @@ trackedFiles: pristine_git_object: efa7759940c1b21c0a969323e2908105dff9f6f1 docs/Models/Components/ZeroDataType.md: id: 98a8a306f4b9 - last_write_checksum: sha1:08f4af31a7f9bd8163103882b1565bd0583edf22 - pristine_git_object: 99f13572e2b9c3e6084da53c603c2150457f9c97 + last_write_checksum: sha1:ef3a8b49c969464008c2ba88f942f5c2531ca4f3 + pristine_git_object: 8ea193ffd50533403b07081801373de1ad27c881 docs/Models/Errors/ErrorMessage.md: id: 59d72a2b78b9 last_write_checksum: sha1:aede0aa82c9fba75a2496535d5cea95c8180f73c @@ -4493,8 +4494,8 @@ trackedFiles: pristine_git_object: 10f5008ecaaa815be51a24989b46a3f5c136444e docs/Models/Requests/CreateBankTransactionsRequest.md: id: 6fd23e0cc417 - last_write_checksum: sha1:47dddde5aed32bb63b5fe22b62fe0114bf35f76a - pristine_git_object: 3cf1acaf56b555c93dd5d7452dd3a4b5fe0c8cb4 + last_write_checksum: sha1:b343f2196fd15d949bbbfc2a861b9238e6db8c3d + pristine_git_object: be7cbae150e48dd4f5505e57ea572fde1cef661f docs/Models/Requests/CreateBankTransactionsResponse.md: id: 09d7b9fdafd4 last_write_checksum: sha1:012e96d507d5ff545fb0c269679528e51724bedc @@ -4581,56 +4582,56 @@ trackedFiles: pristine_git_object: ce373caba7e53b86fa3a74ff11c52914beeb22d2 docs/Models/Requests/DownloadAccountingBillAttachmentRequest.md: id: d52258d8a4b0 - last_write_checksum: sha1:bacd8db2e6ca081c9364c24ccd7875bcb23a4ef2 - pristine_git_object: 9b9d6e90f82f00e2ba2338c2c84757126c7c8aaa + last_write_checksum: sha1:b24efdbef56d6590c1f34d923da6d78ee28b79fe + pristine_git_object: 55ed2b45d1b2d09014cf6c0a2d8ea561d4a482a0 docs/Models/Requests/DownloadAccountingBillAttachmentResponse.md: id: afcdca04fbea last_write_checksum: sha1:5722ad062d4c29171ecc5615bdff112de580932a pristine_git_object: ab7806f70762f4b8deed510ec70025cf4503c738 docs/Models/Requests/DownloadAccountingCustomerAttachmentRequest.md: id: fcbdf3219375 - last_write_checksum: sha1:9860124623c475d540da6edd322d8ccaa8493863 - pristine_git_object: f9795b7d3e44c02dc82ef181837d4d1d035c497b + last_write_checksum: sha1:8fa5ab71f97c741a314666fa4c4805177a0ec636 + pristine_git_object: 6be358a62e7081af8b07bd21aba28d8af9959eec docs/Models/Requests/DownloadAccountingCustomerAttachmentResponse.md: id: dea9da8626b3 last_write_checksum: sha1:33798d8c29220798af1ed725cedd50c5245c11f5 pristine_git_object: 67a428542063c2da17e73975b823d8e815d3afa9 docs/Models/Requests/DownloadAccountingDirectCostAttachmentRequest.md: id: 5996b8ed9437 - last_write_checksum: sha1:982f83721ccec4867655c954a4b119b53ffb45fb - pristine_git_object: 3fdc9e21025083065d3ffba656c72511e9062416 + last_write_checksum: sha1:2772a0d384204417bf686855cd21517e21abe3b0 + pristine_git_object: 8ab8350a32ec79b6fead2a3183d875b2a5801d4f docs/Models/Requests/DownloadAccountingDirectCostAttachmentResponse.md: id: 97033f604b94 last_write_checksum: sha1:bfc9522ba2473f76fde16098b0bde51319fb8ca1 pristine_git_object: 382b63e8ade5fc58516b66cf149e8377cf136160 docs/Models/Requests/DownloadAccountingDirectIncomeAttachmentRequest.md: id: f194871363fd - last_write_checksum: sha1:557353ed229adbcfb9806ddda5de6ce7d9aea421 - pristine_git_object: dd1442ec2e719cb75997a50611eedfaf6846239a + last_write_checksum: sha1:78dc879b11e71db426f72bd8312f8fb13a097c8c + pristine_git_object: 3102f95d981a9f1450a102f9cd12812969dcc328 docs/Models/Requests/DownloadAccountingDirectIncomeAttachmentResponse.md: id: dc8ca61b759c last_write_checksum: sha1:1056d17b02e241d90d54b871374660e128ff7bd9 pristine_git_object: 588232dc117d2773d59712d5a8f27fba7d2571a4 docs/Models/Requests/DownloadAccountingInvoiceAttachmentRequest.md: id: 97cc6fbc491e - last_write_checksum: sha1:be80a4ab238e5ba41fb89cb2808058f5d95cde0b - pristine_git_object: 2d95962ee62361d316d091f193f69bf3b5df5434 + last_write_checksum: sha1:c9e19e630e91b6ef4809b46522f8f9688b990694 + pristine_git_object: 89e1bf137a7d45c775c7591a283fda7cac0d6f7c docs/Models/Requests/DownloadAccountingInvoiceAttachmentResponse.md: id: a6138ea2cec9 last_write_checksum: sha1:1fa0b62613e21564dc45b3e0711cd6d1cb1c8e23 pristine_git_object: 5bc9aabdcd2e403839b68a97bcc9094e3bea0443 docs/Models/Requests/DownloadAccountingInvoicePdfRequest.md: id: 1a923b49d1cb - last_write_checksum: sha1:2ac22069a752f5bcdb0520c9b2ce373be450533e - pristine_git_object: a747ae3281fbf00c0e3d74757801ee20536ef457 + last_write_checksum: sha1:0b257953fdef99b34baf7185cdf69d535cfd9a31 + pristine_git_object: 44e2a7d45285e6b641d5fd10b7223386a5cd78a1 docs/Models/Requests/DownloadAccountingInvoicePdfResponse.md: id: 3e59954bdf6b last_write_checksum: sha1:53fc233b673ff37b14abd062aeda2c2f03f76723 pristine_git_object: 7e082a94df1351176fdd250b21e419f838600049 docs/Models/Requests/DownloadAccountingSupplierAttachmentRequest.md: id: ace823c5e5ac - last_write_checksum: sha1:a0a054e2c94be6527c968d9613cb17d8ef271b8d - pristine_git_object: 64ad7d5bd74d58ff29809d34c592affb05f684c3 + last_write_checksum: sha1:b86e5d9b0c1e1c9efe9e2ffa03738ce579f79d0a + pristine_git_object: 0047eccc5c6aa5cacb8dc971f5f1006340ad5aa0 docs/Models/Requests/DownloadAccountingSupplierAttachmentResponse.md: id: 1afd66120396 last_write_checksum: sha1:22f7e55dd3a231e96b28be17884983266bf3eedd @@ -4645,8 +4646,8 @@ trackedFiles: pristine_git_object: 08805bd35e45a589d96718c09cc3e2a957a14676 docs/Models/Requests/DownloadFilesRequest.md: id: 4bcb01a366ac - last_write_checksum: sha1:c1385ce679627628b563a1bb37b9a28ac16f259f - pristine_git_object: 304f559d80bc1b82df057c87bdb5595f69928443 + last_write_checksum: sha1:17db01f48a6c7476a1548a94c9bc3fa7ddc62854 + pristine_git_object: 90b51135e383d4834a17c66d8255e9d09b7a26d8 docs/Models/Requests/DownloadFilesResponse.md: id: 2dc9d8ca5258 last_write_checksum: sha1:70a2e088fac7bdd81f9f535c4ba998faef5f38ed @@ -4669,8 +4670,8 @@ trackedFiles: pristine_git_object: c25d941d4e526cc85988d8217fa16539a41afd71 docs/Models/Requests/GenerateLoanSummaryQueryParamSourceType.md: id: 2fe772c02413 - last_write_checksum: sha1:b32227734da0b95561f39205da96472ebe5b3268 - pristine_git_object: 2431d74935831608d81a9b0137b7fbc0ea869cdc + last_write_checksum: sha1:200b46786accb393b68c2c746d3f47b8be0c0582 + pristine_git_object: 70a1bd9d03ac47e1dd07979cdbe53251278dbd54 docs/Models/Requests/GenerateLoanSummaryRequest.md: id: 0e849c73a1f5 last_write_checksum: sha1:b083fc70af7c6f2ec6b693e14838664b37e150dc @@ -4697,8 +4698,8 @@ trackedFiles: pristine_git_object: 5bf10023aa8fa288acf43280bd0ff936868a7b96 docs/Models/Requests/GetAccountingAccountRequest.md: id: f6ed66245779 - last_write_checksum: sha1:59b9e022513f71b0bb96f1a85df47045ad25391f - pristine_git_object: 1cb86db5952524ba28633ba018ee5d93d5b78a36 + last_write_checksum: sha1:9504cae166de1f16b36ec0d093df11c212250996 + pristine_git_object: 7ad74f4cfbf77a73afea7d6119821c54557564fc docs/Models/Requests/GetAccountingAccountResponse.md: id: 928e44524b8f last_write_checksum: sha1:c146ce887776640b824c27851b50f95278be5fa1 @@ -4729,56 +4730,56 @@ trackedFiles: pristine_git_object: be19fcc773318c67a23a27a58ce75f47a60a1f72 docs/Models/Requests/GetAccountingBalanceSheetRequest.md: id: d86913c298bd - last_write_checksum: sha1:72f7475314c81fad238ad11557958ae3aa7c8092 - pristine_git_object: c5e5f6475d82c02a91d8da4160a5ebf9af3dac33 + last_write_checksum: sha1:57d8cf73c04ef43a2b1cf8c4dfb3adf4eb6dc3f4 + pristine_git_object: d41b37effd0abe1f922348d65e11923a52676377 docs/Models/Requests/GetAccountingBalanceSheetResponse.md: id: f58acc9e4fbd last_write_checksum: sha1:b868e5b05abd5f0302b4765bc6664f535f72728a pristine_git_object: 570cfe198a97a02d0305d39e302b7af5ab92a78d docs/Models/Requests/GetAccountingBankAccountRequest.md: id: 93f9aaba7b65 - last_write_checksum: sha1:4bc1a0942e2cf0d179b2b380bfa480454a470bb8 - pristine_git_object: 1704f0573c29e19f81b0ca1a5267cf85d39ed73c + last_write_checksum: sha1:14fa650bf1cdcfae0fb13c2b87878a9198ae94c9 + pristine_git_object: 20012dc06c0cfd49954a28f660627d51a78f99a8 docs/Models/Requests/GetAccountingBankAccountResponse.md: id: a4dc6d17a5c0 last_write_checksum: sha1:8bcdef48c247e6bf6125ca473ba3a260dbad76cb pristine_git_object: 6df001116cc3a7a30c76ceb0116c3be19d2fb5f4 docs/Models/Requests/GetAccountingBillAttachmentRequest.md: id: a99a72581b1f - last_write_checksum: sha1:c038a7837fe1d5994378ebbb8da22f4fc040eafe - pristine_git_object: 363abc664ec4e2843eca559c2b6f6bd089e70936 + last_write_checksum: sha1:79c65a8cac19c08a20c23e60a424beb7dfa18d34 + pristine_git_object: 4f73a91f1a5b8145a770d989950d8355733565b6 docs/Models/Requests/GetAccountingBillAttachmentResponse.md: id: 7ac7d62f5225 last_write_checksum: sha1:52082df758b8e0edb87e26ac061409fd17691b80 pristine_git_object: d70b204c59e5dc61f427a3fed5eff6d19a50ce12 docs/Models/Requests/GetAccountingBillCreditNoteRequest.md: id: 815e3b99bee8 - last_write_checksum: sha1:7cd7ada29dde2fdacfe3d28a2fda5eb9328974ec - pristine_git_object: 3564ab51f2f9ceb1da7744f8c9ece154a3797aa1 + last_write_checksum: sha1:572a5a19be7f40c46fc636c56edb2080eafc8086 + pristine_git_object: 5e503498ab2077c259da9375d6f04425db68e848 docs/Models/Requests/GetAccountingBillCreditNoteResponse.md: id: b84b9e941512 last_write_checksum: sha1:4fe87dfa58ab53994a73de585bc1ffe1133a7362 pristine_git_object: ff158f2f387271d366a1316ab78ec48951d96ad5 docs/Models/Requests/GetAccountingBillPaymentRequest.md: id: 8b311bc85d07 - last_write_checksum: sha1:a3bf5f70e57cac6fa3208db79f007f0180146579 - pristine_git_object: c1c6e9815a6a5dc5a03d463805fad82a73b4f7f7 + last_write_checksum: sha1:8edbcd00f5b1edc8e4835496c613728f59e439f4 + pristine_git_object: 9c818971d2cb97e68f24f8fe249f7155e546ba32 docs/Models/Requests/GetAccountingBillPaymentResponse.md: id: b26b53ad85aa - last_write_checksum: sha1:cc74ccf0600bbb78f6df43d4dc18943ce57fda10 - pristine_git_object: 1eac691edc3408cf05eac90c4dfd367f6841de67 + last_write_checksum: sha1:e44e0afb59c644a3502514c675f95cc1b6d42070 + pristine_git_object: bf4d7f7106b687b85576f631031106a052ac934d docs/Models/Requests/GetAccountingBillRequest.md: id: 9a99f8a0c646 - last_write_checksum: sha1:cee62d9e980eaa85b91a84474afa2a709003e229 - pristine_git_object: f2937fe709d278162a1c1553a4f3cdf9a8ab9177 + last_write_checksum: sha1:d522bcab6de5c8720539eb31b101bb62a1ed8dab + pristine_git_object: 7322ba955b07677861d6b04f0c86603d7fe4357d docs/Models/Requests/GetAccountingBillResponse.md: id: ec583a43eeaa last_write_checksum: sha1:07779ab12e9714559faa38fd7a8aa3ee522c4d65 pristine_git_object: 7302343847572660b0ca3528875398ca01201dd4 docs/Models/Requests/GetAccountingCashFlowStatementRequest.md: id: 4ce310ad11d4 - last_write_checksum: sha1:9dbf0023e171be69d6ebb0a0fadae5650f87737c - pristine_git_object: fd2403010da37beb3c0d1c43ddf079d17221dc68 + last_write_checksum: sha1:98f36506645238409c06e43b720fe1d355747f27 + pristine_git_object: 08722df241dac9aa002c1a07b3542c3fab35f3b7 docs/Models/Requests/GetAccountingCashFlowStatementResponse.md: id: 880b2f849fb2 last_write_checksum: sha1:5d09c1e9366b49410f337a00455495efecda8bc4 @@ -4793,72 +4794,72 @@ trackedFiles: pristine_git_object: 13aeea7c672d1f377c4979ffc349a8bc62380e89 docs/Models/Requests/GetAccountingCustomerAttachmentRequest.md: id: adccc1344173 - last_write_checksum: sha1:59bc926008aeebe80e56489128e24c36ce978f55 - pristine_git_object: fb835f8e429ce285bd7b1341bd0c37e55c690dc2 + last_write_checksum: sha1:0127675e4083eaf8ae1617bbbe3d9dab4b1686b6 + pristine_git_object: 50329cc5ff41534c1c8726c5e08cc4f40a22081d docs/Models/Requests/GetAccountingCustomerAttachmentResponse.md: id: 2b918e647947 last_write_checksum: sha1:be7a27b97943741eff487c0e3bd867f23252552f pristine_git_object: baf0727c05b8b52a0e65e2c32bf421145fa8a330 docs/Models/Requests/GetAccountingCustomerRequest.md: id: 107d57d16cf0 - last_write_checksum: sha1:e752856284ed6f77c34303533c7ccf5b79a90ef3 - pristine_git_object: 38611a6cc9d7bba23a01f58f7b5349736ba162d8 + last_write_checksum: sha1:706749e7d22c0e1de055cf5cb1fd3f229f7eb4b1 + pristine_git_object: a44d7b601b35179cdc41502efa22bf1e01b6395c docs/Models/Requests/GetAccountingCustomerResponse.md: id: 0b3094e648aa last_write_checksum: sha1:20f3b4af8c3728705554b2fd2ab178e17d0a6391 pristine_git_object: e4ec978fc7d0771a6bbeca44fdfe4768aeaef001 docs/Models/Requests/GetAccountingDirectCostAttachmentRequest.md: id: 39ecac51ada7 - last_write_checksum: sha1:e057706a8b3164362350c7f9f98458bda69ce05f - pristine_git_object: e0f95423b0463a6bbf3c99b06a1558e7a167050d + last_write_checksum: sha1:05f888c9410e650739bcb7dbe54723c764f27e2f + pristine_git_object: 54552ce66debb98f53b877a5cf0ebb33867f75bb docs/Models/Requests/GetAccountingDirectCostAttachmentResponse.md: id: eacf0bd9e503 last_write_checksum: sha1:b2c7f7041cfcffdb0522bb903e65b76b7bef1f8b pristine_git_object: 40b6e676c3097ea738f1cc10d27c3700daaa8e51 docs/Models/Requests/GetAccountingDirectCostRequest.md: id: 9381cc537200 - last_write_checksum: sha1:a940674e8ed36c6a2f2807b4e9770e91de055acb - pristine_git_object: 32f080726735baa1135773cd920c132f31266ec1 + last_write_checksum: sha1:96a0eba7a94b09f679b31cf40ceaf2c1dba6347b + pristine_git_object: da971ed6ceeba9b3f2b597d9540385beb0b28cd4 docs/Models/Requests/GetAccountingDirectCostResponse.md: id: 7fccd41ee4f6 last_write_checksum: sha1:d1b628fb1b862b6da2fd0408640f8c619edfb76f pristine_git_object: ade04132859af4638ddf0253dd8a2d777be6e1ba docs/Models/Requests/GetAccountingDirectIncomeAttachmentRequest.md: id: eff90de8cbd4 - last_write_checksum: sha1:4d37ed0508bc492558076ef53f504552fd0973df - pristine_git_object: 7bca0a06b7384f16321ac61c494425b873089cef + last_write_checksum: sha1:7a25833da3ef7cf08b2aad9ba072402eba00158f + pristine_git_object: 65247e118293cd8762ddde2fbd86f323733280db docs/Models/Requests/GetAccountingDirectIncomeAttachmentResponse.md: id: 50447a21b418 last_write_checksum: sha1:58b38e25ab87f0124b44ffb41f943bc74470d935 pristine_git_object: 7fcec491df50d06096cdffd659967ae5c6dea4bc docs/Models/Requests/GetAccountingDirectIncomeRequest.md: id: 5ce2e45e3063 - last_write_checksum: sha1:d3b3ff3c19164524bf036dc88d5acb9e445c0ca2 - pristine_git_object: a017b93390352a76699da4bd1321b9f3e26fd1db + last_write_checksum: sha1:ee45fbf0a01cb58436fc611e98059f307ae475b7 + pristine_git_object: 182a0b084720de2305dc6984579092ed520e1b10 docs/Models/Requests/GetAccountingDirectIncomeResponse.md: id: e2fa99839b36 last_write_checksum: sha1:f1b32df8cf8534e41223875edd9bb32c01c8f082 pristine_git_object: 91cd438bccc2646562ea883cbd4535e731f81ce2 docs/Models/Requests/GetAccountingInvoiceAttachmentRequest.md: id: 2ed5f5e5fbd9 - last_write_checksum: sha1:70aedb75929b3aad29d458d82656e19c0a8b44e8 - pristine_git_object: 8aa416d982ca66751421b24677f2ec4a8ce96d6c + last_write_checksum: sha1:bed47cd6dd672c2bb0ca1bf1f404d4a562ec3f81 + pristine_git_object: 18f755f4687925e5fb9487ff3cbb2497a98d239f docs/Models/Requests/GetAccountingInvoiceAttachmentResponse.md: id: d0afcefe32a9 last_write_checksum: sha1:b8e5926116180c34f1c412fe2ef58097810954df pristine_git_object: f84188432de20eac6dc76019ed1f323b85ffbfcf docs/Models/Requests/GetAccountingInvoiceRequest.md: id: 575f358f4f2a - last_write_checksum: sha1:ebdc74091f2296818322c97f8c2026d229e3dca5 - pristine_git_object: 41908d49c2a7b8e647d9d881bcb036c50b210f1b + last_write_checksum: sha1:4f76c308bac0c9dfb234edf93787e4ee47b1c67b + pristine_git_object: a26c9df60a253c8c9993e86706f78d5602a02100 docs/Models/Requests/GetAccountingInvoiceResponse.md: id: 7500aa2a6c20 last_write_checksum: sha1:b11675633c47747279bd569fc80bf2f45da40916 pristine_git_object: 63868b9fcaae00cccd4086de91ec7d9477768cc5 docs/Models/Requests/GetAccountingJournalEntryRequest.md: id: 792cf3232d4f - last_write_checksum: sha1:bc74910aebfc407f78db9129bd9d8072fe0ef862 - pristine_git_object: 38204c3c0aaee63729de2ce89f1591279e87d3b9 + last_write_checksum: sha1:98f9de76bf61e64c90d22dd9eb997f315b1cce84 + pristine_git_object: 338c09714c495ee98be9812524196ad6403554e9 docs/Models/Requests/GetAccountingJournalEntryResponse.md: id: 93db9f1fe63f last_write_checksum: sha1:058f3956cee1eeeba93324132b523eb6c403f484 @@ -4873,8 +4874,8 @@ trackedFiles: pristine_git_object: 890405b8a1135a4d8c0a00021c4e128bb421d01c docs/Models/Requests/GetAccountingPaymentRequest.md: id: ead7d78873f5 - last_write_checksum: sha1:22719d4d9c986496756aa350a809aed530f853e7 - pristine_git_object: 7c1a9555ecc86043fb56da2b43faabf1aee573e5 + last_write_checksum: sha1:c162204f2ad9f4d295bce80fecdee105297429bb + pristine_git_object: c3a8111b61eb451c7979058fe5d0266bc05ad6db docs/Models/Requests/GetAccountingPaymentResponse.md: id: b3d88c9a220f last_write_checksum: sha1:c58b9e7c7a9c5d996c798cd1c0e4a5032c91d19e @@ -4889,32 +4890,32 @@ trackedFiles: pristine_git_object: 349e2290b6634c6b021d78d45904a1c442cd4241 docs/Models/Requests/GetAccountingProfitAndLossRequest.md: id: 18a65531010c - last_write_checksum: sha1:1e6ed6409afd36414d18547fd1998f6f898cf196 - pristine_git_object: 77b9ab9643c2fac4b8541afe7807e1c0f35f1d3f + last_write_checksum: sha1:3b29a94aba678616071f58fe30a8eaa102f0a0c3 + pristine_git_object: a955d00348e340e937c887f7dc014f17ce118675 docs/Models/Requests/GetAccountingProfitAndLossResponse.md: id: 56b4bf5dfb94 last_write_checksum: sha1:d2750bd5919c3108439c8f52fc2e49590d1133ca pristine_git_object: f79baee406b4ab9811aa911b8b1c8d089c1c81be docs/Models/Requests/GetAccountingSupplierAttachmentRequest.md: id: debc3d59767b - last_write_checksum: sha1:67cba53416a1ed8c76b3edaef3101495a0591ab2 - pristine_git_object: d72155469c3704ea441463a3fa09bd6f5f117cf3 + last_write_checksum: sha1:0b3a235b883ebdf53f9181438d69cfbfed7d650d + pristine_git_object: b144e3bea18d3b122c1a8fda9b135f16439dea69 docs/Models/Requests/GetAccountingSupplierAttachmentResponse.md: id: 37a05f838fd5 last_write_checksum: sha1:3ccc4ea88c368e43b2dc1078ac44bd1d6652b346 pristine_git_object: 389d61da0f291b1b8d713f9bff6af4d8b43ba0bc docs/Models/Requests/GetAccountingSupplierRequest.md: id: a17cc70bdc4a - last_write_checksum: sha1:687d85e5ccb1dd1ffcd370c3d847db2c66033587 - pristine_git_object: 403ca6b0054e7a8d79936baf1596b92fa2a2d0db + last_write_checksum: sha1:097d40aeb7cdb2c0c775ecc282fec2746b47d7e8 + pristine_git_object: a8656cac31f9b8ea5110ee7879f4d3e32a8c6f7b docs/Models/Requests/GetAccountingSupplierResponse.md: id: 86d0d552909b last_write_checksum: sha1:c1640632a3d285e80454350ef3be410a5d3b228e pristine_git_object: c8c5084a81592269ac4ea1fc7e4be6e2f118b3d7 docs/Models/Requests/GetAccountingTransferRequest.md: id: b0ba6512d861 - last_write_checksum: sha1:ada3551ee013b213e33a433ee0096b44ba370944 - pristine_git_object: 6450b4b472ac1f6fe83955d6939f037d1a81461e + last_write_checksum: sha1:36dda2ca48eb57b8bb6a414d057fda6a30487b3d + pristine_git_object: 46f6e235bd866106f49b0e4eb4079278e5f8d92e docs/Models/Requests/GetAccountingTransferResponse.md: id: 8a0e44112d1e last_write_checksum: sha1:c6ae45aed36d76e020dfd34424e721c67c08ad04 @@ -4937,8 +4938,8 @@ trackedFiles: pristine_git_object: 5170d29125007970843edf0f979d8fa57ee5fed3 docs/Models/Requests/GetBankingAccountRequest.md: id: 4898fb30916a - last_write_checksum: sha1:9ae95ce4c6b3a30d1a4da2f8eff36e74252229d5 - pristine_git_object: 4cc80e8c791f0f3a7fa18dc44bf54ae09a69972f + last_write_checksum: sha1:bd7f68c452626773e8113e9b274acd13eb8a15aa + pristine_git_object: cd4d2701476aaae30fa0fb87164ce9bbda54483c docs/Models/Requests/GetBankingAccountResponse.md: id: 94580a3615af last_write_checksum: sha1:441839145a5b1114e3088ae779d317ea30a47589 @@ -4985,8 +4986,8 @@ trackedFiles: pristine_git_object: ada318b0db926c971314c2b5a3475c49a8ea84be docs/Models/Requests/GetCommerceCustomerRequest.md: id: 073ab69bad09 - last_write_checksum: sha1:000fbbeb6b6c1208683e2973085477841ac95ccd - pristine_git_object: 0b5d95a98836714e74f478b1f57d850c5ac5ebbb + last_write_checksum: sha1:e2f537bd53d5f408308b039e9acba3bc75e2423d + pristine_git_object: 44917f9cdad562fa0015739e042f60e75fc7d829 docs/Models/Requests/GetCommerceCustomerResponse.md: id: c9975544c098 last_write_checksum: sha1:52cfbe01a30c6a8dace37be7bb9ef91f007ed91a @@ -5001,8 +5002,8 @@ trackedFiles: pristine_git_object: bd7c2d8b35ffaab41bfd642589532fb7d49afc79 docs/Models/Requests/GetCommerceDisputeRequest.md: id: 13ada2592efb - last_write_checksum: sha1:50eb6d9dad7a6ea0e1ceee9bfa181f304422ff90 - pristine_git_object: d8067a5a1e5e0f17f2dd623d8dfc1591cba2922b + last_write_checksum: sha1:5ee9f8b68aebfe72521230e4ef94bf0f9d712af0 + pristine_git_object: 4c210e7f735660283d508dcb8a9214ae4cb71ba7 docs/Models/Requests/GetCommerceDisputeResponse.md: id: b6db0b0dd4aa last_write_checksum: sha1:7a774ef8a38a2d52677202e6008b1f607187f07e @@ -5017,16 +5018,16 @@ trackedFiles: pristine_git_object: 51f83c4ba485342e9c440b95cfa378942ff29b02 docs/Models/Requests/GetCommerceLocationRequest.md: id: fb329bea462c - last_write_checksum: sha1:83633982b6b6db137c3d238f33e11cf110f234d8 - pristine_git_object: 9d761662958ac7c590fb93cd6a6fdaf893d4b32d + last_write_checksum: sha1:24df04c7dc6b98d4310097491e093f078298b597 + pristine_git_object: 973c8dccd77e8ef25f51c073306e19e3c78acce1 docs/Models/Requests/GetCommerceLocationResponse.md: id: a1154f11d966 last_write_checksum: sha1:255667aa3497e435b86ea00c5e6d37c4da4fa6c3 pristine_git_object: d980ce98bc75b3e32854b48eb9f566720f091bcc docs/Models/Requests/GetCommerceOrderRequest.md: id: 4c2435b22593 - last_write_checksum: sha1:09d114a00b012b9333d23eb31c2e678abe01905f - pristine_git_object: a92cb8c834f1bf3de2936a0b36556233802c719d + last_write_checksum: sha1:832c1911fac5de8d93a26d5774ee9a82b0ce019e + pristine_git_object: 4ec11e101e2fba50fe1ee89e3b0a3e77c95d3be1 docs/Models/Requests/GetCommerceOrderResponse.md: id: 61be77e506a4 last_write_checksum: sha1:cce70d732c5c69f3478ffe0c9c269c4f942a5041 @@ -5041,32 +5042,32 @@ trackedFiles: pristine_git_object: 75b7ecbbe2a6eb93b64961fcce4714f64075ef09 docs/Models/Requests/GetCommercePaymentMethodRequest.md: id: a5092608e242 - last_write_checksum: sha1:e746d007940ffc3a02e1d388bd1ad2fcead00278 - pristine_git_object: 1ba1c5e07a9056b9bce88a32b288efab739eab94 + last_write_checksum: sha1:3998e70d37c2f1da4950be25df64b0cea5367197 + pristine_git_object: b292a168f5498228242660d3af6ecd3bd11bd87a docs/Models/Requests/GetCommercePaymentMethodResponse.md: id: 46673c1b79df last_write_checksum: sha1:d90a6d611c280f15d2ea998b2f5a79a3c1db687d pristine_git_object: be4cc8fb8c454e5cf032ea5d7ef804d3121ca774 docs/Models/Requests/GetCommercePaymentRequest.md: id: c4dc88333116 - last_write_checksum: sha1:6169dbcde7d99a631e95163a2177633fa0955f87 - pristine_git_object: 92445f3c35f10ed01c51342647c1c4b43509a2fb + last_write_checksum: sha1:c9ac581debe3e137e26c64dcf588a89d57786e09 + pristine_git_object: f4b9f382d4fb4edffc85306832c3d9c154b7efc3 docs/Models/Requests/GetCommercePaymentResponse.md: id: ee55bb870c9b last_write_checksum: sha1:47ebaa16e42c6a3bd0bc3d2d8192efa4a60181ef pristine_git_object: 0435842f2dab364fb1d0bbf753c0493b43dc0c15 docs/Models/Requests/GetCommerceProductCategoryRequest.md: id: 037e8fa805fb - last_write_checksum: sha1:f55eddabacd7990b4937432618e8d3568ba1081d - pristine_git_object: e50963d7fad2f0440816c0d7ddfebb3890328129 + last_write_checksum: sha1:183a27424580f802655137ccb5259f92b0f237c3 + pristine_git_object: aa5ea09c43bff3a8314cd8c4a1cc5d28f9462026 docs/Models/Requests/GetCommerceProductCategoryResponse.md: id: 3f2a294575ed last_write_checksum: sha1:c71cfb78a1b2c6edeb6a89224819799817d9e425 pristine_git_object: 2b32e676b72ce9d1fe720800103177106b64e867 docs/Models/Requests/GetCommerceProductRequest.md: id: 48a2b471f9f2 - last_write_checksum: sha1:646c3de4d1357f7bc02fde194332cbed0b912ee7 - pristine_git_object: 96f6bc3c07242bc60ce3d2ec0f55749ac5da9ebe + last_write_checksum: sha1:d60e2958ede7202dbe79240214ec9e9acf1eb0d5 + pristine_git_object: 514e8fd5bf4b314510c3f7dbe4ebe0551e356fed docs/Models/Requests/GetCommerceProductResponse.md: id: d6c7859982db last_write_checksum: sha1:f38b7ec7a0456a291d166f06db56094e1122fd16 @@ -5097,8 +5098,8 @@ trackedFiles: pristine_git_object: 628185bd7f3ccf26f92fd40e293e7cc8de10efa8 docs/Models/Requests/GetCommerceTransactionRequest.md: id: f81c782c78c9 - last_write_checksum: sha1:f68e56596c03e6da770c00565d3d2218a0e1e0a1 - pristine_git_object: 9c7490cb628cd096ed883e71720f4a97ed40049b + last_write_checksum: sha1:210c050196b7a3320bdd994951219fcd1d2cf789 + pristine_git_object: bfc1fe818aa6bba9fdf5fa1291dd5802b640bc2a docs/Models/Requests/GetCommerceTransactionResponse.md: id: d7bc6bc6dc07 last_write_checksum: sha1:36ce47d374416c7414e395ae565772925776f92e @@ -5121,8 +5122,8 @@ trackedFiles: pristine_git_object: 84db1bc0b7b7dc5382b105e701892b7d6b7cdeb1 docs/Models/Requests/GetCreateBankTransactionsModelRequest.md: id: 18cfe73a3654 - last_write_checksum: sha1:f7d027cd04acf3653c0054a0598c36a2efb07100 - pristine_git_object: 8fda6965ba2f04d3d3412d23c8617bffe76c6d38 + last_write_checksum: sha1:4428bd16f11177ecf0ac9a74b3d9da362e2cb6f1 + pristine_git_object: c4b972fd7ac82d652bf73a21ef97221fa1b76568 docs/Models/Requests/GetCreateBankTransactionsModelResponse.md: id: e3716b3cee69 last_write_checksum: sha1:7431f1110fbcc9866642092e4102f2d74f25a9ff @@ -5221,8 +5222,8 @@ trackedFiles: pristine_git_object: b34e9bce54175f8c78aef71da1f0fc0e1d4145c5 docs/Models/Requests/GetLoanSummaryQueryParamSourceType.md: id: a1dca29be10c - last_write_checksum: sha1:75aa10e9b5199182af1b3ec4a8cf4627fe089b62 - pristine_git_object: 990ee90b4af3f42e3673ccf0c6721e750bf39674 + last_write_checksum: sha1:ac02c0581f2001dfc6d89b110e550a0b081e6e88 + pristine_git_object: 536d48244be14c75eca21464312672b927addd5e docs/Models/Requests/GetLoanSummaryRequest.md: id: 85d2dfd5498c last_write_checksum: sha1:789130102173ece4ae3abedd102cd5930956ec14 @@ -5273,8 +5274,8 @@ trackedFiles: pristine_git_object: 9c6d5a302e8dc7a5e26a3f6de382d7d7dff45686 docs/Models/Requests/ListAccountingBankAccountTransactionsRequest.md: id: 5a05eab6583c - last_write_checksum: sha1:f27d9accf8cc99af3d468a54018c2c5fc493996d - pristine_git_object: b120cbaaf3a16fc3e6761bf31798872a0f4b44ab + last_write_checksum: sha1:51901f0551285b8b2277756ed63977dc98b6f2f2 + pristine_git_object: e05836ba3e1566a529b4875ebc04c65cf3b6661b docs/Models/Requests/ListAccountingBankAccountTransactionsResponse.md: id: 61c4bbc96176 last_write_checksum: sha1:3787900d92b0e1cf6af9f78ea4fa2c1f0ea3caa5 @@ -5289,8 +5290,8 @@ trackedFiles: pristine_git_object: f966bb959a41cdda77d3cb05c47973df2a04d085 docs/Models/Requests/ListAccountingBillAttachmentsRequest.md: id: cfbb9f16a52b - last_write_checksum: sha1:649a3c343c1a3ff4ce4216c163dd11054a4a1f81 - pristine_git_object: 1f377d8c79657639595b954b09f39b97a557604d + last_write_checksum: sha1:252146efa53d30ae95f4a657742a559da3ad55b9 + pristine_git_object: 56a127fa0de4b10ad052f0a2b9979cd9b01e35ae docs/Models/Requests/ListAccountingBillAttachmentsResponse.md: id: ef88a8110daf last_write_checksum: sha1:a0952f6426ece440cd9436fa7e9a4458d4f15603 @@ -5329,8 +5330,8 @@ trackedFiles: pristine_git_object: e90c53ffa729e3b7fbf1ab2c415f7b990fdafd2f docs/Models/Requests/ListAccountingCustomerAttachmentsRequest.md: id: 5331ade29262 - last_write_checksum: sha1:453901de7e68431eed47badd31a041901accc617 - pristine_git_object: 10afac71c26d6dd99a412e0ec57fbbb9eb932668 + last_write_checksum: sha1:d55eb038b5a758276d89e0ede84c73c27e7637e2 + pristine_git_object: 9a33f6d53b88f81744adb111cb51c9495f8f1a5d docs/Models/Requests/ListAccountingCustomerAttachmentsResponse.md: id: 0afe2f9fecdd last_write_checksum: sha1:b0904534a198fd1a148a7c578bee689bcce5664a @@ -5345,8 +5346,8 @@ trackedFiles: pristine_git_object: 08268f45ed97eebfa135fbd43bbe31a09089dd16 docs/Models/Requests/ListAccountingDirectCostAttachmentsRequest.md: id: 0862dd01102e - last_write_checksum: sha1:f3316101662c7a473a110737fd427516140d4c76 - pristine_git_object: 0c163709a503a0e2cec8daf6b9fe866ced3d03ec + last_write_checksum: sha1:c6dbf51f99779f758ba967af7ad576a18405cc22 + pristine_git_object: b668c765cfa5d5455abf9f2d5795d7cd8c0c3035 docs/Models/Requests/ListAccountingDirectCostAttachmentsResponse.md: id: dfab9a43f2e2 last_write_checksum: sha1:be339be18cc80faca3bbbc673fb1c12d37e67959 @@ -5361,8 +5362,8 @@ trackedFiles: pristine_git_object: e53fa8190e86cb3e0fd3136349aae6ed119d8297 docs/Models/Requests/ListAccountingDirectIncomeAttachmentsRequest.md: id: 84d8bfe79eba - last_write_checksum: sha1:01d4bc734467e2ef0cf842a15ed389bdce586e06 - pristine_git_object: cc9efc955496fcd2e05930a8941cbb71d122ddb1 + last_write_checksum: sha1:d09151abdd6c0a493bbf2e137003c041875cc72f + pristine_git_object: 3491230ef614ed2b2ef1f4f4f891da06908afb9d docs/Models/Requests/ListAccountingDirectIncomeAttachmentsResponse.md: id: 70b96be70fb1 last_write_checksum: sha1:aece6d617fbdc7a1e32fc69888f08618edec2500 @@ -5377,8 +5378,8 @@ trackedFiles: pristine_git_object: a7cefd5fcd04d01c8b355dd76defda3d2e5b5842 docs/Models/Requests/ListAccountingInvoiceAttachmentsRequest.md: id: 941daa49ca00 - last_write_checksum: sha1:df879b010dc5e2caccb956ecc9e7ee07bb7d04d5 - pristine_git_object: 292612cd52c375654d896da8dc9c21857a54e830 + last_write_checksum: sha1:efb773be2d0cf40d41ebad1baf3a9ef6508df9e1 + pristine_git_object: 9a91fcdfa168a14870ed1a10dbe0a652f7ff2e25 docs/Models/Requests/ListAccountingInvoiceAttachmentsResponse.md: id: cf9d2cd8733b last_write_checksum: sha1:f7781bdf4146d94a84fcaa18d712e1768bbd97cb @@ -5417,8 +5418,8 @@ trackedFiles: pristine_git_object: 4c31aa2172c3f02e2d4aa2ee32b3539ecb18b805 docs/Models/Requests/ListAccountingSupplierAttachmentsRequest.md: id: 83c6b0988f1d - last_write_checksum: sha1:afd82d63deb03f6ebc230fc96805c117fbe469ae - pristine_git_object: 14de60ecadb44a6861d44809fb5d1b5621d90d4b + last_write_checksum: sha1:931d13d6aedbe469542518d0addbe4213e0c144f + pristine_git_object: 182a9d7da72fb6171e4e0a5563a1606e7f253d46 docs/Models/Requests/ListAccountingSupplierAttachmentsResponse.md: id: 11637ccf257d last_write_checksum: sha1:eaa3142220e082c1aa040c8f138d4d40da2bb1ba @@ -5617,8 +5618,8 @@ trackedFiles: pristine_git_object: df9f72ffa781ed4af1ef9372c3e5a2b9e66700ea docs/Models/Requests/QueryParamSourceType.md: id: ed85bdf2fb9b - last_write_checksum: sha1:ee8788cf6c0311422d0e77c265dde80c7910a0cc - pristine_git_object: 02da63641bbce465346822e2868c0ff066b94d36 + last_write_checksum: sha1:c06e379abd75d9f093b2c7b02922895146cb4f6b + pristine_git_object: b18e7dac14d4dc46ff6140508034cdf685b1b4f4 docs/Models/Requests/RefreshAllDataTypesRequest.md: id: a8841e256a98 last_write_checksum: sha1:facedf74757a0d440c3b8aba8e66780b36195ece @@ -5653,8 +5654,8 @@ trackedFiles: pristine_git_object: 0ba4805aa891b4772eb39b8cce586a0592fa73f5 docs/Models/Requests/SourceType.md: id: eea6e422354f - last_write_checksum: sha1:407d2ec200d906841fc4dbec5eda5485cb243205 - pristine_git_object: ea13cb9d511343d4484dabb56700b1d0d3c4448c + last_write_checksum: sha1:37a76267531a9eb29cfa121ef9ca61edf7a44373 + pristine_git_object: a01e343437b09ccf607e2853876bb77d10a37347 docs/Models/Requests/StartBankStatementUploadSessionRequest.md: id: 3c420fd4cccd last_write_checksum: sha1:ccd9a41a8a8b3d9746b3d2a30deec4bdcec28d2d @@ -5725,8 +5726,8 @@ trackedFiles: pristine_git_object: b21e837f8e05e0d971f08da76de6dbf00b7a0ebe docs/Models/Webhooks/ReportsCreditModelGenerateSuccessfulReportGenerationWebhook.md: id: 59a092bb9ebb - last_write_checksum: sha1:e66e95f9c24b0a198494c3e215d2cdab4526b76e - pristine_git_object: 70bca90781969b7c3322743b62c8671f203e510a + last_write_checksum: sha1:310d5eaadc2dd6db62e05c229657096615f43dba + pristine_git_object: 61e83fe5cc481a999a1556d6e14d9fa6e3b2111a docs/Models/Webhooks/ReportsCreditModelGenerateSuccessfulResponse.md: id: ddeba001210e last_write_checksum: sha1:dfd47e4ce8b73fc377d2eaabb6e6dbed965f8a04 @@ -5737,144 +5738,144 @@ trackedFiles: pristine_git_object: 323c553f0f4e8d13edf0db803aeac4dc99d8227f docs/sdks/accountbalances/README.md: id: fc17ae4b2cc5 - last_write_checksum: sha1:712ada397788f4a5c4243084be797b6f007f2889 - pristine_git_object: bdde70fc5edbbe95e038ed7927ae19c80c42eafc + last_write_checksum: sha1:b893bd37e2ac1ea2b04383700ffd7162e74c5f67 + pristine_git_object: 826e8edae23c2dafd603178f0e4855f0f7b20b5e docs/sdks/accountingbankdata/README.md: id: 085b34b19801 - last_write_checksum: sha1:0a5731a776f5b826f9f651941e22c562984595d6 - pristine_git_object: deedab2d2df1a2aedd9666113e114542a51fa2c1 + last_write_checksum: sha1:d4e50188afc7b318fee4c5fe03007e0bce930932 + pristine_git_object: 3102912e10944225f0c357c30dfb02c4925da5fe docs/sdks/accounts/README.md: id: d6c754b1ca96 - last_write_checksum: sha1:3417e53f645c79eecaad6cfb30fc422c32b257e3 - pristine_git_object: 98a3a3d83508fec9d62db88d72c81699f389494a + last_write_checksum: sha1:f3b4ef68776d61965ed0660d0a1cbcc241ed5a11 + pristine_git_object: 3be9a3fd97d0ff6c24052d7606df9f84db213fc1 docs/sdks/accounttransactions/README.md: id: 2bc776ad1ad6 - last_write_checksum: sha1:c07a411926366ebbe4873140b38bfd10dbf77087 - pristine_git_object: e87559ce066b9f1e0c06a5f2d5b4b88de2850970 + last_write_checksum: sha1:73708d7c7df772833b816b3e752ffacc3918a9ce + pristine_git_object: fa3914e56917c1305325903979f0b43bb5ba18ca docs/sdks/balancesheet/README.md: id: b360644f6413 - last_write_checksum: sha1:6d2f4831411349411c79dcc111aa13c52207a751 - pristine_git_object: 037a25588dc06dc302acdafb8257e2ab81bb77d8 + last_write_checksum: sha1:b3c57505b4d8fc3734b7e3c24e5d675e276f379d + pristine_git_object: bda0d1ac22181706d4cce44bdeab747f248fc41a docs/sdks/bankaccounts/README.md: id: 510ffee224ea - last_write_checksum: sha1:5ff9e942a42ff44da267ef0eeb886867b5dfcd79 - pristine_git_object: bc7cbc169a70cbf0fc3e42add389a78cc698cf72 + last_write_checksum: sha1:a2c5b401ff5d543a5d8f80d47c8563ffea5d36f1 + pristine_git_object: 77ad29465de156bed78edb9b669ed2f073151037 docs/sdks/bankstatements/README.md: id: 367be2ea83cc - last_write_checksum: sha1:f56af94dd5fbea65d3fc10646f656ad6bb11532e - pristine_git_object: 1ae8e569255a8eeb8ceb2051af467fda4812a165 + last_write_checksum: sha1:ee7bce55e05a5cafee70bf0fb5e23324d05d4c4e + pristine_git_object: 57965bae09e008f159a29ee9c71c2190376181e4 docs/sdks/banktransactions/README.md: id: 4d2b2b0db893 - last_write_checksum: sha1:6d24410cee953027ec315ac39a72b0905aefdbab - pristine_git_object: d155e184b90edbbfa6adf7df818f55091d56f25d + last_write_checksum: sha1:6ab53ca1bbc17bb568c4cc6eb77938b88c98f5c7 + pristine_git_object: bce83c5205c3ce80888513369a96139823fbdfed docs/sdks/billcreditnotes/README.md: id: 9f712b3a2216 - last_write_checksum: sha1:a44827ffee3184bf86a841c65e7aef0195864ade - pristine_git_object: 90187fd74c656d5c632e4e493e5866f70ec7760f + last_write_checksum: sha1:23390fa448048a4a9ff55195f7e3740aec435a0c + pristine_git_object: 2055def5f7fdd76f3cec43001cec6f98a77e24ea docs/sdks/billpayments/README.md: id: 9436cf9c44bd - last_write_checksum: sha1:c83700635863316493b2521d8011173cb0cc8d3c - pristine_git_object: f851223c536c9cb99e5668a6f81f74637fac74fe + last_write_checksum: sha1:fc9a7f8d2fdec48a96177ccac95c69b69150df64 + pristine_git_object: d7cb7e68c5f127951418364da89df1aa3795aabf docs/sdks/bills/README.md: id: 2a9c97966ab7 - last_write_checksum: sha1:3819c9c7f1d06c81738253112acaba9370f93457 - pristine_git_object: f6c214fb4c9c3541d286e9c403c9964f07b75dbe + last_write_checksum: sha1:c951004759665b8f1b1f6cc3544d858f5991047d + pristine_git_object: 7538cbb5aa6ffc30cc28505d61733c6913f3c1fb docs/sdks/cashflow/README.md: id: 811ea28e72fa - last_write_checksum: sha1:98ea39525a4611741c986713cd2845563ecd8aae - pristine_git_object: 71b60b687ef209491ebc83cfb8b0a7667a7db44c + last_write_checksum: sha1:628adc1c0554916bda20718a1cb8a34bfbdd9ce4 + pristine_git_object: 6b27757c9aca9e7a9c1b788a82147cfc094e8211 docs/sdks/categorizedstatement/README.md: id: 1976d2dc6b6b - last_write_checksum: sha1:c9883a0a25e1ea21add487f6f660e3fdec2fe022 - pristine_git_object: 1352afa8967c2f1e21237a8222aaabb9b3ac2e15 + last_write_checksum: sha1:9061eccac5db4f5d6996d1f94583f3e55fde32fc + pristine_git_object: 4605b41dc456ce6b3188eb9f6c99ee1126c4e5f9 docs/sdks/codatlendingaccounts/README.md: id: 0863fc22c6d0 - last_write_checksum: sha1:15d5d6861a86d41ca42998cdafec50b4d98f4e15 - pristine_git_object: 0e30b973e83f7bf0a952db5f2fd31d21773efa89 + last_write_checksum: sha1:3e711d7fa8a8d16aa5dfce415432c4cada01aed2 + pristine_git_object: e3c058b9951a0b7947f2763f78b2626729ebe669 docs/sdks/codatlendingbankingaccounts/README.md: id: ba36c0f2ad4b - last_write_checksum: sha1:d5fc28fbaf09c366b539632d83d7d17da37ef5a4 - pristine_git_object: 27dd1704f57a8cac0c1d7d8985d54f134a5c9137 + last_write_checksum: sha1:4eba8118d37945336bd30c46a4c3d930fe222a43 + pristine_git_object: 84b128232297b6cdf2e087a5d418aca7b6d5280d docs/sdks/codatlendingcustomers/README.md: id: 215de0060dff - last_write_checksum: sha1:342a16712b3931b5d74f06ec036c43b0e2e2d179 - pristine_git_object: a4ed32c6e88c77657584a1e8f4ca35c063d5c6a5 + last_write_checksum: sha1:544f9191cf6ede0e2778094a1a217c9e44226806 + pristine_git_object: 5037bcae0276cec8c116d83246d86ea827023b46 docs/sdks/codatlendingdirectcosts/README.md: id: 5ce0ac8aa3b3 - last_write_checksum: sha1:6a0e88b0ea9d74ec53bcf54cca1d58faad13e052 - pristine_git_object: 9fc64b9b313adbb943ae4ef1699ef55d36e3d9f7 + last_write_checksum: sha1:4ee4594bf5dfdf55c1c5c035c31d6fae3f969da1 + pristine_git_object: 4083d302314c433f0cf73d21d509529ffd854a49 docs/sdks/codatlendingloanwritebackaccounts/README.md: id: fd66aa26e517 - last_write_checksum: sha1:b08c61882f2cc42b3e811caed53529571c8e9302 - pristine_git_object: 03877aac3c3dc5d7425f5c267ca6904fa3c4388c + last_write_checksum: sha1:54a4b06a4840a403e64e781086ba3104659bc467 + pristine_git_object: a4dd6a85dbc340bb635a2a82a48b0ab5b28ec483 docs/sdks/codatlendingloanwritebackpayments/README.md: id: 9cc1197f1729 - last_write_checksum: sha1:536865d5e86b576484d9d2e5cf5b19bf2a9f760d - pristine_git_object: adef5c47c40199fd8b03ab8ea7ef2c444d23889d + last_write_checksum: sha1:4bc8bcc075611ff46cccf58a8c2efdf4a5b30b31 + pristine_git_object: dd567f263b4c5e6381294562d70f38444638c66c docs/sdks/codatlendingpayments/README.md: id: 3f8c449427a2 - last_write_checksum: sha1:fb405dbd4398d1fd8dac9d16b6df70208be0b264 - pristine_git_object: fd8917501b45ece3561481f98458a64194ef8542 + last_write_checksum: sha1:cbea1f2851b3427fb829fe25c16a95b5b8ba36f7 + pristine_git_object: 3b03e6d37a0583f0e87090550408d64d7556731b docs/sdks/codatlendingreports/README.md: id: cb899625316c - last_write_checksum: sha1:9b26daaeef14ee965e1bc9cbea452941804ea7d4 - pristine_git_object: c04b17d1752b93a31d5eb6369ee0afba8fd944c1 + last_write_checksum: sha1:a8d70a233bc788654180cc5458d14bff4c272407 + pristine_git_object: 465ecb44b92832a7f8ed77b99dcdb3fd8ebdfea1 docs/sdks/codatlendingsalestransactions/README.md: id: ab0da5c0acd4 - last_write_checksum: sha1:3383969ad092c1016a17da220b25edf33c7fcc17 - pristine_git_object: 647183480ebc24727aec04a4361c0f045208fc19 + last_write_checksum: sha1:2a2351c49c46abec1266fe2aa0f7e57707123ad0 + pristine_git_object: 333a97920543183d29f105dbbb03f32124aab270 docs/sdks/codatlendingsuppliers/README.md: id: 01d513a71eae - last_write_checksum: sha1:3531e4abf94fc881ac58724738fb3801d10314ff - pristine_git_object: 81c771993c2063b34f6538512a058db004d9edf7 + last_write_checksum: sha1:19597e88b4022c2c963d62e4085368fe00b3eb1d + pristine_git_object: 93718b2c9163ce44a44393d54664c41a40664627 docs/sdks/codatlendingtransactions/README.md: id: 3d7bd081ed2a - last_write_checksum: sha1:185884fc3bc1c201a116a3e2627d53f5ec67af05 - pristine_git_object: 57295bdfc2ce462233138373f9e0414119f7d0d5 + last_write_checksum: sha1:7253471297cdf65c7f9f4c9173a2710bf39baf89 + pristine_git_object: c3115abf7c31a610aa1e542008d166f4ffc59db6 docs/sdks/codatlendingtransfers/README.md: id: 7eb84908e77f - last_write_checksum: sha1:d460ac908862399d875fc9863f15c0785580653f - pristine_git_object: c6022e8c5f4c72c7078683bff1e0c8ef8e8d5bdf + last_write_checksum: sha1:94606d5d47e1345ebb85006d53b9a6502e3454ce + pristine_git_object: 2cf532d85a753697b743dc34cd8ad6380ef3b226 docs/sdks/companies/README.md: id: 67e8a49afa67 - last_write_checksum: sha1:d4ff357371dea184afab92bb97f8a94383648833 - pristine_git_object: df415942c2072df7c2eba56ff5a812ffcd769ce8 + last_write_checksum: sha1:8f63add9f61da78af558a3676eca491b59bfb75e + pristine_git_object: 339363f273ca2001c9b94aff7d827c4f6e275d1c docs/sdks/companyinfo/README.md: id: 198b84d5c0c5 - last_write_checksum: sha1:4e600514537b7f67acad79f802d0e21e4b3d122b - pristine_git_object: 6e5d787d69229808841898b0b97a51da375bd251 + last_write_checksum: sha1:5fcb620848efefaac687204c6727b7d788faca99 + pristine_git_object: 32af9c393b7726ed8acef5cffd46658b1b18d112 docs/sdks/connections/README.md: id: 3ef8931411ea - last_write_checksum: sha1:e4d99d9164f8114162eb4ab998b06a49a4ff9e8c - pristine_git_object: 7f553de6da3e89faa262c6b97cfd85bf0678aa00 + last_write_checksum: sha1:227f32cd648cbc6706f09b354f650668b8bc990f + pristine_git_object: cdcc3b93500f8a34c456b387c5f03f1ebeefa11d docs/sdks/createoperations/README.md: id: 885340aa3721 last_write_checksum: sha1:a45aca08c2ca1a8784e7cc88790b13032b5123e4 pristine_git_object: 46ff198d543c7e2ea4735a49bfa7d2308965b77c docs/sdks/creditnotes/README.md: id: 2d6d27cce955 - last_write_checksum: sha1:c757cb641b6fb417ec3edaa8c6a734cf4dfed448 - pristine_git_object: ad866fe2e1cb1ce0dc04b2afc3555d4691b97186 + last_write_checksum: sha1:41c13f2adac47e8cf5bb4369e024441af6ec3adb + pristine_git_object: 7c1449d1e86f9d6009708fd4caa7ad1e2db27171 docs/sdks/customers/README.md: id: 9332759cffc2 - last_write_checksum: sha1:6321d5fe7c535a9470b69d4d715c6c2a7b06ac45 - pristine_git_object: 0aab2b6d8855d70a6266b781690f5d877128bda6 + last_write_checksum: sha1:999186ad29c8b567f1c97dc4df051c98911bd43f + pristine_git_object: 27cc8253d2887af5d5fdb7539097c555172422f9 docs/sdks/dataintegrity/README.md: id: 8d747fc58581 last_write_checksum: sha1:0e9f050b5d724e09c69361fa2ebbb2c900e4fbcc pristine_git_object: 1cf6817a51e619e950392146474ec9188c74058a docs/sdks/directcosts/README.md: id: 81abe301abd2 - last_write_checksum: sha1:07c837b43af2b6cfb4b39402e57e0a8792df35d5 - pristine_git_object: 9e3b8c6250b7c3b1d108d31bb49578df2fb7a2b7 + last_write_checksum: sha1:6293c8b33929f5996062091a80585b843e923632 + pristine_git_object: 9b277eb11005047937530a4eb6375c8cf2cb3f3e docs/sdks/directincomes/README.md: id: 697e9d8b3057 - last_write_checksum: sha1:9df0a7bf5641a063e5e288ecb3a94d0264b7a69f - pristine_git_object: 13a0635be4e4f199c25d16b0a510fe361c58a6fe + last_write_checksum: sha1:ed269910f801bd459d4f077d3e987f4b188cce3f + pristine_git_object: eb736d6f0f4d4e9ead432fd0a73ed795270452a8 docs/sdks/disputes/README.md: id: 5b14d189cefd - last_write_checksum: sha1:f7a4b2b4fff84139aface275198c5951f8b23ac9 - pristine_git_object: 435237b403fb2c1b7c56b6852f21d4025bd33c11 + last_write_checksum: sha1:b575bdaad660bd03ae452516d9f2542a240cea4c + pristine_git_object: ed563c7cc1ad29b4271fad531e8ca3b7e3d1deed docs/sdks/excelreports/README.md: id: a93037f0199b last_write_checksum: sha1:3bc36d83c28039575ebea4cf083e6ff90ee6635c @@ -5885,64 +5886,64 @@ trackedFiles: pristine_git_object: 738c5f0ba4a7c59651a5fc0583a0d49ff6519a43 docs/sdks/invoices/README.md: id: a3f76a06eded - last_write_checksum: sha1:27a36e8f8da79fe9e6723a49a58062294095aa33 - pristine_git_object: 446171d891b196ed6a29849ee80c9a5975747ba5 + last_write_checksum: sha1:438ae60d485c29a102d313379d18eb093bf7b777 + pristine_git_object: e1c6a400ffa88a9858dc5608568b9183cc21f578 docs/sdks/journalentries/README.md: id: 7723a6f499f0 - last_write_checksum: sha1:e89c1aeff9bfaff26a55fc0060b4ab5112c24960 - pristine_git_object: a933a575552bde49cddb7f5a13dbf4d415b23d71 + last_write_checksum: sha1:4814cc2478301df3161824be071559f909d74bec + pristine_git_object: ab1fa68f6f53e4ab69f8251020f99efab199e887 docs/sdks/journals/README.md: id: 255f988e78fc - last_write_checksum: sha1:56c37ca23c9801e24f1b153d7585c56a77740bce - pristine_git_object: 9bb56e64d8052d80d6fca3d893ee91ae0b5627bc + last_write_checksum: sha1:3ff214941809223c48aa2c9110678875bde049a1 + pristine_git_object: f5bd2f183b13e6c5961742aa4125613579bf7e6a docs/sdks/liabilities/README.md: id: c5e7f6b0e7bf last_write_checksum: sha1:644d82d221e77a692a57de02d863c6888bc5b15e pristine_git_object: 9c179c2e0379dd82d58d0626d59e31ab13b7535a docs/sdks/locations/README.md: id: 18f4bc68d8e9 - last_write_checksum: sha1:91a967434a2876e81583bd0d806734d91c535efc - pristine_git_object: 6208f2fc6532d01a7c504986c214d957baf31e32 + last_write_checksum: sha1:af68bc26fb476f6339208dee2ad3ddbf590e5881 + pristine_git_object: c18ecc8525b342614bc9951ce6a759450c5fbcc0 docs/sdks/managedata/README.md: id: 5fccd800fae5 - last_write_checksum: sha1:27aa2d5a01ce246d2244560fc529aba15b8409f5 - pristine_git_object: 2b34ed831fd9289953859f84f7f2264c8da23677 + last_write_checksum: sha1:44ee4690453ce16e8abaf251cdadc8c11351734b + pristine_git_object: 1f79f00ccd85a556c1aa0d5eaba9272fc37fe3f8 docs/sdks/managereports/README.md: id: 4e77e498ae11 - last_write_checksum: sha1:346267d9726ddd6f9dee1e27423f813531cb4e4b - pristine_git_object: ed0f64496abb94cba60fc28f6389bb31ae86d1a2 + last_write_checksum: sha1:e5abc71d41e296623c29fc06806ef1ab7fd55859 + pristine_git_object: f562bc8a3ad356cc3557444a3c0c9c0b10974f8f docs/sdks/metrics/README.md: id: a8545d964e21 last_write_checksum: sha1:ad06f276127b5783a4d891510592431ffc88532f pristine_git_object: 9a97ca68091e49b03d7dd9e242685ce588a4e8d2 docs/sdks/orders/README.md: id: fc5b2caf3cb2 - last_write_checksum: sha1:98adcd5343dba8c4f6433730d04fd1987cd7f59c - pristine_git_object: 768221a6736506da2beb895ac9a5d1836cd208ab + last_write_checksum: sha1:50489eb1aaeeb527118db2e72c5ac893679ed2cc + pristine_git_object: 435cd2a1c67870648f090af5f80d3f5fc11bf7d6 docs/sdks/paymentmethods/README.md: id: 98b2df26035c - last_write_checksum: sha1:4a56de94162716aa7ee02ba351f0468094167789 - pristine_git_object: 6556b1b76c0e0d814e62fe32c41c25d362506370 + last_write_checksum: sha1:9f535a86c3e547e0d323406b00e92a86dacbe94d + pristine_git_object: 2ac0b53815c21831306e17d08c743b92bb7087b5 docs/sdks/payments/README.md: id: 0ddb15ec8c20 - last_write_checksum: sha1:6546281a09665b3f89f6d434981a93eb5dbe76f7 - pristine_git_object: 519507f44859bab04ea582a17655aba163c37147 + last_write_checksum: sha1:77eee853b6bd27646b95b0ae53ea77aa6bcd53ce + pristine_git_object: 44c5ef4b42071ce38dc3f1752d07f0a5dc53afd8 docs/sdks/productcategories/README.md: id: 12bcba957d63 - last_write_checksum: sha1:28ba47e0537171f45491dcaf41196a09e1667222 - pristine_git_object: 0136528672f8cded948044ea2a13e1af769fac50 + last_write_checksum: sha1:7ddb42f5c2055432fe7298757f845eb5415f9f80 + pristine_git_object: 4d038eda774c1604d3d3db1ff6a2617bbaf26dde docs/sdks/products/README.md: id: af06255e12ab - last_write_checksum: sha1:bb0d0aa3deb4960f5e86e608547dc373931236b5 - pristine_git_object: ce4931836f09ffbde833bae384e041ee31f0c7e3 + last_write_checksum: sha1:70847c7717dcadb4466226cd65202b5ff5cb6cd2 + pristine_git_object: e02c6fff12418db9715ddfd8757c0edfcebef707 docs/sdks/profitandloss/README.md: id: d782c67c7753 - last_write_checksum: sha1:93aee3a3be9b10c1074c26dffc3e3421e3356a6f - pristine_git_object: cc1025f774a0a5a0af7e33a28d4f4925336fb305 + last_write_checksum: sha1:5b39e26c4a512d3437d536a340301fed0692a760 + pristine_git_object: bbf727b6d4e1b2fdf10f00152099b9d7d5b744ca docs/sdks/pulloperations/README.md: id: 472049941a82 - last_write_checksum: sha1:76a64598ea7005374fc2a9d1d06a141aa8e7d594 - pristine_git_object: 624179369174ffe9f4f5824b3374345ddd186b5b + last_write_checksum: sha1:ed935729b3288ae14ff33a8d0cd5a77763cbf90c + pristine_git_object: aa9db7be551550f26a074222ed337a1e360f6bae docs/sdks/refresh/README.md: id: 7cd2d2e66f4d last_write_checksum: sha1:6f9c40c18fa59fbaea5750950a40f52dc0febdd5 @@ -5953,20 +5954,20 @@ trackedFiles: pristine_git_object: c0e5f78f6f4aed7e80926c496c15790a816600ca docs/sdks/sourceaccounts/README.md: id: 19ba068a7927 - last_write_checksum: sha1:ad340e6dfda3fc18b06d80095adf72fd39cb9070 - pristine_git_object: e36f4b64eecb879fc74743c387a3b147c84313bb + last_write_checksum: sha1:cd6fca042223b9b2f483e7b7457d1abce24fa430 + pristine_git_object: 1990154bd008775a9f8cbce13cb13764d82a1617 docs/sdks/suppliers/README.md: id: 85867190cd79 - last_write_checksum: sha1:4d3cdca3f2fe06bfe6b7da8c51592e430fa8eea5 - pristine_git_object: 657e49943e845a58451f89e8f5110dd246a8e74c + last_write_checksum: sha1:eb101c5e2a50f2c5bcf941321a47b74a8cb7b8c5 + pristine_git_object: ef9f66d5e0c5c3a62e4ccce781538210f218dcab docs/sdks/transactioncategories/README.md: id: cefdcd16b0bb - last_write_checksum: sha1:3541f7911a42fb7de259ff4472322584eb4be9d2 - pristine_git_object: 832d9d3b6fe9f81819a41dafdf83900dcb60ce67 + last_write_checksum: sha1:069ce5c550923a550be83a63a19379d05666d58a + pristine_git_object: b23623e96303569ba5df98d5e326df31e62d8f68 docs/sdks/transfers/README.md: id: f56918861798 - last_write_checksum: sha1:1d5bb1a8d1078bde9d3bd6353d99ff61d36b20b7 - pristine_git_object: 5bea57fe09cab685901ffe37e74c471f808fe1ae + last_write_checksum: sha1:ea7e4036a9f59fc22fd499a8ef43e16e97f599f3 + pristine_git_object: fa208399a315e95bf4d5e479afa42efa0397e510 global.json: id: 908e72401bf4 last_write_checksum: sha1:3161b880f51cd74e7d1dea069b541d8bf4736dc9 @@ -17521,7 +17522,15 @@ examplesVersion: 1.0.2 generatedTests: {} releaseNotes: | ## Csharp SDK Changes: - * `Codat.lending.Banking.CategorizedStatement.Get()`: `response.reportItems[].Transactions[].IsRecurring` **Added** + * `Codat.lending.Companies.List()`: `response.results[].DataConnections[].IntegrationKey` **Changed** + * `Codat.lending.Companies.Create()`: `response.dataConnections[].IntegrationKey` **Changed** + * `Codat.lending.Companies.Replace()`: `response.dataConnections[].IntegrationKey` **Changed** + * `Codat.lending.Companies.Update()`: `response.dataConnections[].IntegrationKey` **Changed** + * `Codat.lending.Companies.Get()`: `response.dataConnections[].IntegrationKey` **Changed** + * `Codat.lending.Connections.List()`: `response.results[].IntegrationKey` **Changed** + * `Codat.lending.Connections.Create()`: `response.integrationKey` **Changed** + * `Codat.lending.Connections.Get()`: `response.integrationKey` **Changed** + * `Codat.lending.Connections.Unlink()`: `response.integrationKey` **Changed** generatedFiles: - .gitattributes - CONTRIBUTING.md diff --git a/lending/.speakeasy/gen.yaml b/lending/.speakeasy/gen.yaml index 5b45ac7c..6858dc8d 100644 --- a/lending/.speakeasy/gen.yaml +++ b/lending/.speakeasy/gen.yaml @@ -14,6 +14,7 @@ generation: securityFeb2025: false sharedErrorComponentsApr2025: false sharedNestedComponentsJan2026: false + nameOverrideFeb2026: false auth: oAuth2ClientCredentialsEnabled: false oAuth2PasswordEnabled: false @@ -28,7 +29,7 @@ generation: generateNewTests: false skipResponseBodyAssertions: false csharp: - version: 10.0.1 + version: 10.0.2 additionalDependencies: [] author: Codat baseErrorName: CodatLendingException @@ -38,6 +39,7 @@ csharp: disableNamespacePascalCasingApr2024: true dotnetVersion: net8.0 enableCancellationToken: false + enableFormatting: false enableSourceLink: false flattenGlobalSecurity: true flatteningOrder: "" @@ -59,6 +61,7 @@ csharp: outputModelSuffix: output packageName: Codat.Lending packageTags: "" + respectTitlesForPrimitiveUnionMembers: false responseFormat: envelope sourceDirectory: "" useNodatime: true diff --git a/lending/Codat/Lending/AccountBalances.cs b/lending/Codat/Lending/AccountBalances.cs index ea8c7a40..ac9e0ea4 100644 --- a/lending/Codat/Lending/AccountBalances.cs +++ b/lending/Codat/Lending/AccountBalances.cs @@ -92,6 +92,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -151,9 +156,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/AccountTransactions.cs b/lending/Codat/Lending/AccountTransactions.cs index 68331c6e..89d83ce5 100644 --- a/lending/Codat/Lending/AccountTransactions.cs +++ b/lending/Codat/Lending/AccountTransactions.cs @@ -115,6 +115,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -174,9 +179,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -302,6 +307,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -361,9 +371,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/AccountingBankData.cs b/lending/Codat/Lending/AccountingBankData.cs index 1f29f351..6ce62f28 100644 --- a/lending/Codat/Lending/AccountingBankData.cs +++ b/lending/Codat/Lending/AccountingBankData.cs @@ -106,6 +106,11 @@ public async Task ListTransactio var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -165,9 +170,9 @@ public async Task ListTransactio } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/Accounts.cs b/lending/Codat/Lending/Accounts.cs index 2782c2d5..bf04f395 100644 --- a/lending/Codat/Lending/Accounts.cs +++ b/lending/Codat/Lending/Accounts.cs @@ -115,6 +115,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -174,9 +179,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -302,6 +307,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -361,9 +371,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/BalanceSheet.cs b/lending/Codat/Lending/BalanceSheet.cs index 456650b6..cafeba48 100644 --- a/lending/Codat/Lending/BalanceSheet.cs +++ b/lending/Codat/Lending/BalanceSheet.cs @@ -107,6 +107,11 @@ public async Task GetCategorizedAc var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -166,9 +171,9 @@ public async Task GetCategorizedAc } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -290,6 +295,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -349,9 +359,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/BankAccounts.cs b/lending/Codat/Lending/BankAccounts.cs index e3f34878..4d839b19 100644 --- a/lending/Codat/Lending/BankAccounts.cs +++ b/lending/Codat/Lending/BankAccounts.cs @@ -121,6 +121,11 @@ public async Task GetCreateUpdateMode var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -180,9 +185,9 @@ public async Task GetCreateUpdateMode } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -310,6 +315,11 @@ public async Task CreateAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + var serializedBody = RequestBodySerializer.Serialize(request, "AccountingBankAccount", "json", true, true); if (serializedBody != null) { @@ -375,9 +385,9 @@ public async Task CreateAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/BankStatements.cs b/lending/Codat/Lending/BankStatements.cs index 398a465f..5f9814a5 100644 --- a/lending/Codat/Lending/BankStatements.cs +++ b/lending/Codat/Lending/BankStatements.cs @@ -186,6 +186,11 @@ public async Task GetUploadConfigu var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -245,9 +250,9 @@ public async Task GetUploadConfigu } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -373,6 +378,11 @@ public async Task SetUploadConfigu var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + var serializedBody = RequestBodySerializer.Serialize(request, "BankStatementUploadConfiguration", "json", false, true); if (serializedBody != null) { @@ -438,9 +448,9 @@ public async Task SetUploadConfigu } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -566,6 +576,11 @@ public async Task StartUploadSessionAs var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + var serializedBody = RequestBodySerializer.Serialize(request, "StartUploadSessionRequest", "json", false, true); if (serializedBody != null) { @@ -631,9 +646,9 @@ public async Task StartUploadSessionAs } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -757,6 +772,11 @@ public async Task UploadBankStatementDataAsync var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + var serializedBody = RequestBodySerializer.Serialize(request, "RequestBody", "json", false, false); if (serializedBody != null) { @@ -822,9 +842,9 @@ public async Task UploadBankStatementDataAsync } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -930,6 +950,11 @@ public async Task EndUploadSessionAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + var serializedBody = RequestBodySerializer.Serialize(request, "EndUploadSessionRequest", "json", false, true); if (serializedBody != null) { @@ -995,9 +1020,9 @@ public async Task EndUploadSessionAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/BankTransactions.cs b/lending/Codat/Lending/BankTransactions.cs index 672375d9..8902eaf4 100644 --- a/lending/Codat/Lending/BankTransactions.cs +++ b/lending/Codat/Lending/BankTransactions.cs @@ -121,6 +121,11 @@ public async Task GetCreateModelAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -180,9 +185,9 @@ public async Task GetCreateModelAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -310,6 +315,11 @@ public async Task CreateAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + var serializedBody = RequestBodySerializer.Serialize(request, "AccountingCreateBankTransactions", "json", false, true); if (serializedBody != null) { @@ -375,9 +385,9 @@ public async Task CreateAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/BillCreditNotes.cs b/lending/Codat/Lending/BillCreditNotes.cs index d85dbc4b..6efe957e 100644 --- a/lending/Codat/Lending/BillCreditNotes.cs +++ b/lending/Codat/Lending/BillCreditNotes.cs @@ -115,6 +115,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -174,9 +179,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -302,6 +307,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -361,9 +371,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/BillPayments.cs b/lending/Codat/Lending/BillPayments.cs index 80446e5a..147898b8 100644 --- a/lending/Codat/Lending/BillPayments.cs +++ b/lending/Codat/Lending/BillPayments.cs @@ -115,6 +115,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -174,9 +179,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -302,6 +307,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -361,9 +371,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/Bills.cs b/lending/Codat/Lending/Bills.cs index 23548427..b839e6c6 100644 --- a/lending/Codat/Lending/Bills.cs +++ b/lending/Codat/Lending/Bills.cs @@ -190,6 +190,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -249,9 +254,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -381,6 +386,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -440,9 +450,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -566,6 +576,11 @@ public async Task ListAttachmentsAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -625,9 +640,9 @@ public async Task ListAttachmentsAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -751,6 +766,11 @@ public async Task GetAttachmentAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -810,9 +830,9 @@ public async Task GetAttachmentAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -936,6 +956,11 @@ public async Task DownloadAttachmentA var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/octet-stream"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -995,9 +1020,9 @@ public async Task DownloadAttachmentA } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/CashFlow.cs b/lending/Codat/Lending/CashFlow.cs index e43b8e3b..405751c3 100644 --- a/lending/Codat/Lending/CashFlow.cs +++ b/lending/Codat/Lending/CashFlow.cs @@ -84,6 +84,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -143,9 +148,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/CategorizedStatement.cs b/lending/Codat/Lending/CategorizedStatement.cs index b4be1965..eac75986 100644 --- a/lending/Codat/Lending/CategorizedStatement.cs +++ b/lending/Codat/Lending/CategorizedStatement.cs @@ -92,6 +92,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -151,9 +156,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/Codat.Lending.csproj b/lending/Codat/Lending/Codat.Lending.csproj index c88d4649..87a79ba9 100644 --- a/lending/Codat/Lending/Codat.Lending.csproj +++ b/lending/Codat/Lending/Codat.Lending.csproj @@ -3,7 +3,7 @@ true Codat.Lending - 10.0.1 + 10.0.2 net8.0 Codat Copyright (c) Codat 2026 diff --git a/lending/Codat/Lending/CodatLendingAccounts.cs b/lending/Codat/Lending/CodatLendingAccounts.cs index bb5ca19a..a1ba067c 100644 --- a/lending/Codat/Lending/CodatLendingAccounts.cs +++ b/lending/Codat/Lending/CodatLendingAccounts.cs @@ -115,6 +115,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -174,9 +179,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -302,6 +307,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -361,9 +371,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/CodatLendingBankingAccounts.cs b/lending/Codat/Lending/CodatLendingBankingAccounts.cs index d8b41658..cf1cf87d 100644 --- a/lending/Codat/Lending/CodatLendingBankingAccounts.cs +++ b/lending/Codat/Lending/CodatLendingBankingAccounts.cs @@ -115,6 +115,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -174,9 +179,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -302,6 +307,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -361,9 +371,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/CodatLendingCustomers.cs b/lending/Codat/Lending/CodatLendingCustomers.cs index c1074376..ed4f4693 100644 --- a/lending/Codat/Lending/CodatLendingCustomers.cs +++ b/lending/Codat/Lending/CodatLendingCustomers.cs @@ -115,6 +115,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -174,9 +179,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -302,6 +307,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -361,9 +371,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/CodatLendingDirectCosts.cs b/lending/Codat/Lending/CodatLendingDirectCosts.cs index 77998db8..535df396 100644 --- a/lending/Codat/Lending/CodatLendingDirectCosts.cs +++ b/lending/Codat/Lending/CodatLendingDirectCosts.cs @@ -121,6 +121,11 @@ public async Task GetCreateModelAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -180,9 +185,9 @@ public async Task GetCreateModelAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -310,6 +315,11 @@ public async Task CreateAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + var serializedBody = RequestBodySerializer.Serialize(request, "DirectCostPrototype", "json", false, true); if (serializedBody != null) { @@ -375,9 +385,9 @@ public async Task CreateAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/CodatLendingLoanWritebackAccounts.cs b/lending/Codat/Lending/CodatLendingLoanWritebackAccounts.cs index 2ee069d7..8eaf78c5 100644 --- a/lending/Codat/Lending/CodatLendingLoanWritebackAccounts.cs +++ b/lending/Codat/Lending/CodatLendingLoanWritebackAccounts.cs @@ -118,6 +118,11 @@ public async Task GetCreateModelAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -177,9 +182,9 @@ public async Task GetCreateModelAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -307,6 +312,11 @@ public async Task CreateAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + var serializedBody = RequestBodySerializer.Serialize(request, "AccountPrototype", "json", false, true); if (serializedBody != null) { @@ -372,9 +382,9 @@ public async Task CreateAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/CodatLendingLoanWritebackPayments.cs b/lending/Codat/Lending/CodatLendingLoanWritebackPayments.cs index d920ee12..1bbcd6ff 100644 --- a/lending/Codat/Lending/CodatLendingLoanWritebackPayments.cs +++ b/lending/Codat/Lending/CodatLendingLoanWritebackPayments.cs @@ -118,6 +118,11 @@ public async Task GetCreateModelAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -177,9 +182,9 @@ public async Task GetCreateModelAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -307,6 +312,11 @@ public async Task CreateAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + var serializedBody = RequestBodySerializer.Serialize(request, "AccountingPayment", "json", true, true); if (serializedBody != null) { @@ -372,9 +382,9 @@ public async Task CreateAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/CodatLendingPayments.cs b/lending/Codat/Lending/CodatLendingPayments.cs index 93480b4b..5c9d9662 100644 --- a/lending/Codat/Lending/CodatLendingPayments.cs +++ b/lending/Codat/Lending/CodatLendingPayments.cs @@ -115,6 +115,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -174,9 +179,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -302,6 +307,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -361,9 +371,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/CodatLendingReports.cs b/lending/Codat/Lending/CodatLendingReports.cs index 4b242d04..950612b0 100644 --- a/lending/Codat/Lending/CodatLendingReports.cs +++ b/lending/Codat/Lending/CodatLendingReports.cs @@ -141,6 +141,11 @@ public async Task IsAgedDebtorsAvailableA var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -200,9 +205,9 @@ public async Task IsAgedDebtorsAvailableA } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -324,6 +329,11 @@ public async Task GetAgedDebtorsAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -383,9 +393,9 @@ public async Task GetAgedDebtorsAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -507,6 +517,11 @@ public async Task IsAgedCreditorsAvaila var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -566,9 +581,9 @@ public async Task IsAgedCreditorsAvaila } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -690,6 +705,11 @@ public async Task GetAgedCreditorsAsy var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -749,9 +769,9 @@ public async Task GetAgedCreditorsAsy } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/CodatLendingSalesTransactions.cs b/lending/Codat/Lending/CodatLendingSalesTransactions.cs index 79c5c493..63832e32 100644 --- a/lending/Codat/Lending/CodatLendingSalesTransactions.cs +++ b/lending/Codat/Lending/CodatLendingSalesTransactions.cs @@ -115,6 +115,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -174,9 +179,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -302,6 +307,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -361,9 +371,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/CodatLendingSuppliers.cs b/lending/Codat/Lending/CodatLendingSuppliers.cs index 38888f78..810f58a9 100644 --- a/lending/Codat/Lending/CodatLendingSuppliers.cs +++ b/lending/Codat/Lending/CodatLendingSuppliers.cs @@ -118,6 +118,11 @@ public async Task GetCreateUpdateModelAs var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -177,9 +182,9 @@ public async Task GetCreateUpdateModelAs } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -307,6 +312,11 @@ public async Task CreateAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + var serializedBody = RequestBodySerializer.Serialize(request, "AccountingSupplier", "json", true, true); if (serializedBody != null) { @@ -372,9 +382,9 @@ public async Task CreateAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/CodatLendingTransactions.cs b/lending/Codat/Lending/CodatLendingTransactions.cs index 36ea629c..dcabf119 100644 --- a/lending/Codat/Lending/CodatLendingTransactions.cs +++ b/lending/Codat/Lending/CodatLendingTransactions.cs @@ -115,6 +115,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -174,9 +179,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -302,6 +307,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -361,9 +371,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/CodatLendingTransfers.cs b/lending/Codat/Lending/CodatLendingTransfers.cs index a00d2977..20ca53a1 100644 --- a/lending/Codat/Lending/CodatLendingTransfers.cs +++ b/lending/Codat/Lending/CodatLendingTransfers.cs @@ -118,6 +118,11 @@ public async Task GetCreateModelAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -177,9 +182,9 @@ public async Task GetCreateModelAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -307,6 +312,11 @@ public async Task CreateAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + var serializedBody = RequestBodySerializer.Serialize(request, "AccountingTransfer", "json", true, true); if (serializedBody != null) { @@ -372,9 +382,9 @@ public async Task CreateAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/Companies.cs b/lending/Codat/Lending/Companies.cs index 324feedc..1ea9edcf 100644 --- a/lending/Codat/Lending/Companies.cs +++ b/lending/Codat/Lending/Companies.cs @@ -218,6 +218,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -277,9 +282,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -403,6 +408,11 @@ public async Task CreateAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + var serializedBody = RequestBodySerializer.Serialize(request, "Request", "json", false, true); if (serializedBody != null) { @@ -468,9 +478,9 @@ public async Task CreateAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -595,6 +605,11 @@ public async Task ReplaceAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Put, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + var serializedBody = RequestBodySerializer.Serialize(request, "CompanyRequestBody", "json", false, true); if (serializedBody != null) { @@ -660,9 +675,9 @@ public async Task ReplaceAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -788,6 +803,11 @@ public async Task UpdateAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Patch, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + var serializedBody = RequestBodySerializer.Serialize(request, "CompanyUpdateRequest", "json", false, true); if (serializedBody != null) { @@ -853,9 +873,9 @@ public async Task UpdateAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -980,6 +1000,11 @@ public async Task DeleteAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Delete, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -1039,9 +1064,9 @@ public async Task DeleteAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -1145,6 +1170,11 @@ public async Task GetAsync(GetCompanyRequest request, Retry var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -1204,9 +1234,9 @@ public async Task GetAsync(GetCompanyRequest request, Retry } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/CompanyInfo.cs b/lending/Codat/Lending/CompanyInfo.cs index 118828ff..b855e1d8 100644 --- a/lending/Codat/Lending/CompanyInfo.cs +++ b/lending/Codat/Lending/CompanyInfo.cs @@ -113,6 +113,11 @@ public async Task GetAccountingProfileAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -172,9 +177,9 @@ public async Task GetAccountingProfileAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -300,6 +305,11 @@ public async Task GetCommerceProfileAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -359,9 +369,9 @@ public async Task GetCommerceProfileAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/Connections.cs b/lending/Codat/Lending/Connections.cs index a9e94918..340504e9 100644 --- a/lending/Codat/Lending/Connections.cs +++ b/lending/Codat/Lending/Connections.cs @@ -163,6 +163,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -222,9 +227,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -348,6 +353,11 @@ public async Task CreateAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + var serializedBody = RequestBodySerializer.Serialize(request, "RequestBody", "json", false, true); if (serializedBody != null) { @@ -413,9 +423,9 @@ public async Task CreateAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -534,6 +544,11 @@ public async Task GetAsync(GetConnectionRequest request, var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -593,9 +608,9 @@ public async Task GetAsync(GetConnectionRequest request, } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -718,6 +733,11 @@ public async Task DeleteAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Delete, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -777,9 +797,9 @@ public async Task DeleteAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -883,6 +903,11 @@ public async Task UnlinkAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Patch, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + var serializedBody = RequestBodySerializer.Serialize(request, "RequestBody", "json", false, true); if (serializedBody != null) { @@ -948,9 +973,9 @@ public async Task UnlinkAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/CreateOperations.cs b/lending/Codat/Lending/CreateOperations.cs index 04b9befd..d9e507a5 100644 --- a/lending/Codat/Lending/CreateOperations.cs +++ b/lending/Codat/Lending/CreateOperations.cs @@ -103,6 +103,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -162,9 +167,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -286,6 +291,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -345,9 +355,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/CreditNotes.cs b/lending/Codat/Lending/CreditNotes.cs index 82d53cfb..4a1712ae 100644 --- a/lending/Codat/Lending/CreditNotes.cs +++ b/lending/Codat/Lending/CreditNotes.cs @@ -115,6 +115,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -174,9 +179,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -302,6 +307,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -361,9 +371,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/Customers.cs b/lending/Codat/Lending/Customers.cs index 506a16ba..e78dc64b 100644 --- a/lending/Codat/Lending/Customers.cs +++ b/lending/Codat/Lending/Customers.cs @@ -178,6 +178,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -237,9 +242,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -365,6 +370,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -424,9 +434,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -550,6 +560,11 @@ public async Task ListAttachmentsAsy var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -609,9 +624,9 @@ public async Task ListAttachmentsAsy } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -735,6 +750,11 @@ public async Task GetAttachmentAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -794,9 +814,9 @@ public async Task GetAttachmentAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -920,6 +940,11 @@ public async Task DownloadAttachm var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/octet-stream"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -979,9 +1004,9 @@ public async Task DownloadAttachm } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/DataIntegrity.cs b/lending/Codat/Lending/DataIntegrity.cs index 80641bbd..c36dbed3 100644 --- a/lending/Codat/Lending/DataIntegrity.cs +++ b/lending/Codat/Lending/DataIntegrity.cs @@ -148,6 +148,11 @@ public async Task StatusAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -207,9 +212,9 @@ public async Task StatusAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -335,6 +340,11 @@ public async Task SummariesAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -394,9 +404,9 @@ public async Task SummariesAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -520,6 +530,11 @@ public async Task DetailsAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -579,9 +594,9 @@ public async Task DetailsAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/DirectCosts.cs b/lending/Codat/Lending/DirectCosts.cs index ed0abc02..dd2c27a0 100644 --- a/lending/Codat/Lending/DirectCosts.cs +++ b/lending/Codat/Lending/DirectCosts.cs @@ -178,6 +178,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -237,9 +242,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -365,6 +370,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -424,9 +434,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -550,6 +560,11 @@ public async Task GetAttachmentAsync var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -609,9 +624,9 @@ public async Task GetAttachmentAsync } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -735,6 +750,11 @@ public async Task DownloadAttac var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/octet-stream"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -794,9 +814,9 @@ public async Task DownloadAttac } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -909,6 +929,11 @@ public async Task ListAttachmentsA var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -968,9 +993,9 @@ public async Task ListAttachmentsA } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/DirectIncomes.cs b/lending/Codat/Lending/DirectIncomes.cs index d543291d..1f6cf730 100644 --- a/lending/Codat/Lending/DirectIncomes.cs +++ b/lending/Codat/Lending/DirectIncomes.cs @@ -178,6 +178,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -237,9 +242,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -365,6 +370,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -424,9 +434,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -550,6 +560,11 @@ public async Task GetAttachmentAsy var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -609,9 +624,9 @@ public async Task GetAttachmentAsy } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -735,6 +750,11 @@ public async Task DownloadAtt var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/octet-stream"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -794,9 +814,9 @@ public async Task DownloadAtt } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -909,6 +929,11 @@ public async Task ListAttachment var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -968,9 +993,9 @@ public async Task ListAttachment } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/Disputes.cs b/lending/Codat/Lending/Disputes.cs index c7827ced..4f1f3c53 100644 --- a/lending/Codat/Lending/Disputes.cs +++ b/lending/Codat/Lending/Disputes.cs @@ -115,6 +115,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -174,9 +179,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -302,6 +307,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -361,9 +371,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/ExcelReports.cs b/lending/Codat/Lending/ExcelReports.cs index 332de610..2bd5a215 100644 --- a/lending/Codat/Lending/ExcelReports.cs +++ b/lending/Codat/Lending/ExcelReports.cs @@ -162,6 +162,11 @@ public async Task GenerateAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -221,9 +226,9 @@ public async Task GenerateAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -349,6 +354,11 @@ public async Task GetStatusAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -408,9 +418,9 @@ public async Task GetStatusAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -536,6 +546,11 @@ public async Task DownloadAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/octet-stream"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -595,9 +610,9 @@ public async Task DownloadAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/FileUpload.cs b/lending/Codat/Lending/FileUpload.cs index 47efe95b..1f848fa0 100644 --- a/lending/Codat/Lending/FileUpload.cs +++ b/lending/Codat/Lending/FileUpload.cs @@ -125,6 +125,11 @@ public async Task ListUploadedAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -184,9 +189,9 @@ public async Task ListUploadedAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -308,6 +313,11 @@ public async Task DownloadAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/octet-stream"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -367,9 +377,9 @@ public async Task DownloadAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -483,6 +493,11 @@ public async Task UploadAsync(UploadFilesRequest request, var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + var serializedBody = RequestBodySerializer.Serialize(request, "FileUpload", "multipart", false, true); if (serializedBody != null) { @@ -548,9 +563,9 @@ public async Task UploadAsync(UploadFilesRequest request, } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/Invoices.cs b/lending/Codat/Lending/Invoices.cs index 9cda2c8a..ecad71fa 100644 --- a/lending/Codat/Lending/Invoices.cs +++ b/lending/Codat/Lending/Invoices.cs @@ -227,6 +227,11 @@ public async Task ListReconciledAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -286,9 +291,9 @@ public async Task ListReconciledAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -425,6 +430,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -484,9 +494,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -616,6 +626,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -675,9 +690,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -799,6 +814,11 @@ public async Task DownloadPdfAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/pdf"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -858,9 +878,9 @@ public async Task DownloadPdfAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -973,6 +993,11 @@ public async Task ListAttachmentsAsyn var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -1032,9 +1057,9 @@ public async Task ListAttachmentsAsyn } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -1158,6 +1183,11 @@ public async Task GetAttachmentAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -1217,9 +1247,9 @@ public async Task GetAttachmentAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -1343,6 +1373,11 @@ public async Task DownloadAttachme var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/octet-stream"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -1402,9 +1437,9 @@ public async Task DownloadAttachme } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/JournalEntries.cs b/lending/Codat/Lending/JournalEntries.cs index c5739e71..8a938560 100644 --- a/lending/Codat/Lending/JournalEntries.cs +++ b/lending/Codat/Lending/JournalEntries.cs @@ -115,6 +115,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -174,9 +179,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -302,6 +307,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -361,9 +371,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/Journals.cs b/lending/Codat/Lending/Journals.cs index 20a2e756..f0975eb5 100644 --- a/lending/Codat/Lending/Journals.cs +++ b/lending/Codat/Lending/Journals.cs @@ -115,6 +115,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -174,9 +179,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -302,6 +307,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -361,9 +371,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/Liabilities.cs b/lending/Codat/Lending/Liabilities.cs index 1766819e..7c78ac82 100644 --- a/lending/Codat/Lending/Liabilities.cs +++ b/lending/Codat/Lending/Liabilities.cs @@ -167,6 +167,11 @@ public async Task GenerateLoanTransactionsAsy var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -226,9 +231,9 @@ public async Task GenerateLoanTransactionsAsy } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -336,6 +341,11 @@ public async Task ListLoanTransactionsAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -395,9 +405,9 @@ public async Task ListLoanTransactionsAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -523,6 +533,11 @@ public async Task GenerateLoanSummaryAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -582,9 +597,9 @@ public async Task GenerateLoanSummaryAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -692,6 +707,11 @@ public async Task GetLoanSummaryAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -751,9 +771,9 @@ public async Task GetLoanSummaryAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/Locations.cs b/lending/Codat/Lending/Locations.cs index 684ded21..d87f0005 100644 --- a/lending/Codat/Lending/Locations.cs +++ b/lending/Codat/Lending/Locations.cs @@ -115,6 +115,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -174,9 +179,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -302,6 +307,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -361,9 +371,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/ManageData.cs b/lending/Codat/Lending/ManageData.cs index 80fbda9d..0e205bf7 100644 --- a/lending/Codat/Lending/ManageData.cs +++ b/lending/Codat/Lending/ManageData.cs @@ -98,6 +98,11 @@ public async Task GetStatusAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -157,9 +162,9 @@ public async Task GetStatusAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/ManageReports.cs b/lending/Codat/Lending/ManageReports.cs index 511a60dc..8c523668 100644 --- a/lending/Codat/Lending/ManageReports.cs +++ b/lending/Codat/Lending/ManageReports.cs @@ -110,6 +110,11 @@ public async Task GenerateReportAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -169,9 +174,9 @@ public async Task GenerateReportAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -293,6 +298,11 @@ public async Task ListReportsAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -352,9 +362,9 @@ public async Task ListReportsAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/Metrics.cs b/lending/Codat/Lending/Metrics.cs index ab2bd601..480e7c92 100644 --- a/lending/Codat/Lending/Metrics.cs +++ b/lending/Codat/Lending/Metrics.cs @@ -209,6 +209,11 @@ public async Task GetRevenueAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -268,9 +273,9 @@ public async Task GetRevenueAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -420,6 +425,11 @@ public async Task GetCustomerReten var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -479,9 +489,9 @@ public async Task GetCustomerReten } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -622,6 +632,11 @@ public async Task GetLifetimeValueAsyn var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -681,9 +696,9 @@ public async Task GetLifetimeValueAsyn } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/Models/Components/Connection.cs b/lending/Codat/Lending/Models/Components/Connection.cs index 6a329fb2..e3bc3408 100644 --- a/lending/Codat/Lending/Models/Components/Connection.cs +++ b/lending/Codat/Lending/Models/Components/Connection.cs @@ -44,7 +44,7 @@ public class Connection /// 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. /// [JsonProperty("integrationKey")] - public string IntegrationKey { get; set; } = default!; + public string? IntegrationKey { get; set; } /// /// 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`. diff --git a/lending/Codat/Lending/Orders.cs b/lending/Codat/Lending/Orders.cs index 60835c37..16bd7c41 100644 --- a/lending/Codat/Lending/Orders.cs +++ b/lending/Codat/Lending/Orders.cs @@ -112,6 +112,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -171,9 +176,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -299,6 +304,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -358,9 +368,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/PaymentMethods.cs b/lending/Codat/Lending/PaymentMethods.cs index 24e2ce2d..b547239a 100644 --- a/lending/Codat/Lending/PaymentMethods.cs +++ b/lending/Codat/Lending/PaymentMethods.cs @@ -115,6 +115,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -174,9 +179,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -302,6 +307,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -361,9 +371,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/Payments.cs b/lending/Codat/Lending/Payments.cs index f08f6a8b..38be54ac 100644 --- a/lending/Codat/Lending/Payments.cs +++ b/lending/Codat/Lending/Payments.cs @@ -115,6 +115,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -174,9 +179,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -302,6 +307,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -361,9 +371,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/ProductCategories.cs b/lending/Codat/Lending/ProductCategories.cs index 818bc821..b780452b 100644 --- a/lending/Codat/Lending/ProductCategories.cs +++ b/lending/Codat/Lending/ProductCategories.cs @@ -115,6 +115,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -174,9 +179,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -302,6 +307,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -361,9 +371,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/Products.cs b/lending/Codat/Lending/Products.cs index c9ecff24..45a53722 100644 --- a/lending/Codat/Lending/Products.cs +++ b/lending/Codat/Lending/Products.cs @@ -115,6 +115,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -174,9 +179,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -302,6 +307,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -361,9 +371,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/ProfitAndLoss.cs b/lending/Codat/Lending/ProfitAndLoss.cs index 25a1ac27..e333f68b 100644 --- a/lending/Codat/Lending/ProfitAndLoss.cs +++ b/lending/Codat/Lending/ProfitAndLoss.cs @@ -107,6 +107,11 @@ public async Task GetCategorizedA var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -166,9 +171,9 @@ public async Task GetCategorizedA } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -290,6 +295,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -349,9 +359,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/PullOperations.cs b/lending/Codat/Lending/PullOperations.cs index d9226145..ba9c9460 100644 --- a/lending/Codat/Lending/PullOperations.cs +++ b/lending/Codat/Lending/PullOperations.cs @@ -100,6 +100,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -159,9 +164,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -283,6 +288,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -342,9 +352,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/Refresh.cs b/lending/Codat/Lending/Refresh.cs index 30a98c0c..acfef284 100644 --- a/lending/Codat/Lending/Refresh.cs +++ b/lending/Codat/Lending/Refresh.cs @@ -113,6 +113,11 @@ public async Task AllDataTypesAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -172,9 +177,9 @@ public async Task AllDataTypesAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -280,6 +285,11 @@ public async Task DataTypeAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -339,9 +349,9 @@ public async Task DataTypeAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/Reports.cs b/lending/Codat/Lending/Reports.cs index ce5270d7..34e6a45d 100644 --- a/lending/Codat/Lending/Reports.cs +++ b/lending/Codat/Lending/Reports.cs @@ -164,6 +164,11 @@ public async Task GetOrdersAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -223,9 +228,9 @@ public async Task GetOrdersAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -368,6 +373,11 @@ public async Task GetRefundsAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -427,9 +437,9 @@ public async Task GetRefundsAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/SDKConfig.cs b/lending/Codat/Lending/SDKConfig.cs index 7f68a004..c1d6f23a 100644 --- a/lending/Codat/Lending/SDKConfig.cs +++ b/lending/Codat/Lending/SDKConfig.cs @@ -45,7 +45,7 @@ public SDKConfig(ISpeakeasyHttpClient? client = null) Client = client ?? new SpeakeasyHttpClient(); ServerUrl = ""; ServerIndex = 0; - UserAgent = "speakeasy-sdk/csharp 10.0.1 2.803.3 3.0.0 Codat.Lending"; + UserAgent = "speakeasy-sdk/csharp 10.0.2 2.879.13 3.0.0 Codat.Lending"; SecuritySource = null; Hooks = new SDKHooks(); RetryConfig = null; diff --git a/lending/Codat/Lending/SourceAccounts.cs b/lending/Codat/Lending/SourceAccounts.cs index b0f1c8b0..a3c0c089 100644 --- a/lending/Codat/Lending/SourceAccounts.cs +++ b/lending/Codat/Lending/SourceAccounts.cs @@ -163,6 +163,11 @@ public async Task CreateAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + var serializedBody = RequestBodySerializer.Serialize(request, "RequestBody", "json", false, true); if (serializedBody != null) { @@ -228,9 +233,9 @@ public async Task CreateAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -358,6 +363,11 @@ public async Task ListMappingsAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -417,9 +427,9 @@ public async Task ListMappingsAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -570,6 +580,11 @@ public async Task CreateMappingAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Post, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + var serializedBody = RequestBodySerializer.Serialize(request, "BankFeedBankAccountMapping", "json", false, true); if (serializedBody != null) { @@ -635,9 +650,9 @@ public async Task CreateMappingAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/Suppliers.cs b/lending/Codat/Lending/Suppliers.cs index d2cc8276..fe1ce32e 100644 --- a/lending/Codat/Lending/Suppliers.cs +++ b/lending/Codat/Lending/Suppliers.cs @@ -178,6 +178,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -237,9 +242,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -365,6 +370,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -424,9 +434,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -550,6 +560,11 @@ public async Task ListAttachmentsAsy var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -609,9 +624,9 @@ public async Task ListAttachmentsAsy } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -735,6 +750,11 @@ public async Task GetAttachmentAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -794,9 +814,9 @@ public async Task GetAttachmentAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -920,6 +940,11 @@ public async Task DownloadAttachm var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/octet-stream"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -979,9 +1004,9 @@ public async Task DownloadAttachm } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/TransactionCategories.cs b/lending/Codat/Lending/TransactionCategories.cs index 902f3099..ef00135d 100644 --- a/lending/Codat/Lending/TransactionCategories.cs +++ b/lending/Codat/Lending/TransactionCategories.cs @@ -115,6 +115,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -174,9 +179,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -302,6 +307,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -361,9 +371,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/Transfers.cs b/lending/Codat/Lending/Transfers.cs index ea28a766..0c4936dc 100644 --- a/lending/Codat/Lending/Transfers.cs +++ b/lending/Codat/Lending/Transfers.cs @@ -115,6 +115,11 @@ public async Task ListAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -174,9 +179,9 @@ public async Task ListAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; @@ -302,6 +307,11 @@ public async Task GetAsync( var httpRequest = new HttpRequestMessage(HttpMethod.Get, urlString); httpRequest.Headers.Add("user-agent", SDKConfiguration.UserAgent); + if (!httpRequest.Headers.Contains("Accept")) + { + httpRequest.Headers.Add("Accept", "application/json"); + } + if (SDKConfiguration.SecuritySource != null) { httpRequest = new SecurityMetadata(SDKConfiguration.SecuritySource).Apply(httpRequest); @@ -361,9 +371,9 @@ public async Task GetAsync( } } } - catch (Exception error) + catch (Exception _hookError) { - var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, error); + var _httpResponse = await this.SDKConfiguration.Hooks.AfterErrorAsync(new AfterErrorContext(hookCtx), null, _hookError); if (_httpResponse != null) { httpResponse = _httpResponse; diff --git a/lending/Codat/Lending/Utils/Constants.cs b/lending/Codat/Lending/Utils/Constants.cs index 09dce91e..14a46e73 100644 --- a/lending/Codat/Lending/Utils/Constants.cs +++ b/lending/Codat/Lending/Utils/Constants.cs @@ -22,12 +22,12 @@ public static class Constants /// /// The version of the SDK. /// - public const string SdkVersion = "10.0.1"; + public const string SdkVersion = "10.0.2"; /// /// The version of the SDK generator used to create this SDK. /// - public const string SdkGenVersion = "2.803.3"; + public const string SdkGenVersion = "2.879.13"; /// /// The version of the OpenAPI document used to generate this SDK. diff --git a/lending/Codat/Lending/Utils/RequestBodySerializer.cs b/lending/Codat/Lending/Utils/RequestBodySerializer.cs index e2c73a45..6aa2fdc7 100644 --- a/lending/Codat/Lending/Utils/RequestBodySerializer.cs +++ b/lending/Codat/Lending/Utils/RequestBodySerializer.cs @@ -282,7 +282,7 @@ private static HttpContent SerializeMultipart(object request, string mediaType) string fieldName = (metadata.Name ?? prop.Name) + "[]"; var fileContent = new ByteArrayContent(content); - fileContent.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue("application/octet-stream"); + fileContent.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue(GetMimeType(fileName)); formData.Add(fileContent, fieldName, fileName); } } @@ -294,7 +294,7 @@ private static HttpContent SerializeMultipart(object request, string mediaType) string fieldName = metadata.Name; var fileContent = new ByteArrayContent(content); - fileContent.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue("application/octet-stream"); + fileContent.Headers.ContentType = new System.Net.Http.Headers.MediaTypeHeaderValue(GetMimeType(fileName)); formData.Add(fileContent, fieldName, fileName); } else @@ -552,6 +552,27 @@ private static (string fileName, byte[] content) ExtractFileProperties(PropertyI return (fileName, content); } + private static string GetMimeType(string fileName) + { + var ext = System.IO.Path.GetExtension(fileName)?.ToLowerInvariant(); + return ext switch + { + ".json" => "application/json", + ".xml" => "application/xml", + ".txt" => "text/plain", + ".csv" => "text/csv", + ".html" or ".htm" => "text/html", + ".pdf" => "application/pdf", + ".zip" => "application/zip", + ".png" => "image/png", + ".jpg" or ".jpeg" => "image/jpeg", + ".gif" => "image/gif", + ".svg" => "image/svg+xml", + ".webp" => "image/webp", + _ => "application/octet-stream", + }; + } + private static PropertyInfo? GetPropertyInfo(object value, string propertyName) { try diff --git a/lending/Codat/Lending/Utils/Retries/Retries.cs b/lending/Codat/Lending/Utils/Retries/Retries.cs index 26a1023f..dc8a81f1 100644 --- a/lending/Codat/Lending/Utils/Retries/Retries.cs +++ b/lending/Codat/Lending/Utils/Retries/Retries.cs @@ -127,6 +127,27 @@ private async Task GetResponseAsync(bool retryConnectionErr } } + private static long RetryAfterMs(HttpResponseMessage response) + { + if (response.Headers.TryGetValues("Retry-After", out var values)) + { + var retryAfter = System.Linq.Enumerable.FirstOrDefault(values); + if (!string.IsNullOrEmpty(retryAfter)) + { + if (long.TryParse(retryAfter, out var seconds) && seconds >= 0) + { + return seconds * 1000; + } + if (DateTimeOffset.TryParse(retryAfter, out var retryDate)) + { + var deltaMs = (long)(retryDate - DateTimeOffset.UtcNow).TotalMilliseconds; + return deltaMs > 0 ? deltaMs : 0; + } + } + } + return 0; + } + private async Task retryWithBackoff(bool retryConnectionErrors) { var backoff = retryConfig.Backoff; @@ -159,10 +180,16 @@ private async Task retryWithBackoff(bool retryConnectionErr throw; } - var intervalMs = backoff.InitialIntervalMs * Math.Pow(backoff.BaseFactor, numAttempts); - var jitterMs = backoff.JitterFactor * intervalMs; - intervalMs = intervalMs - jitterMs + new Random().NextDouble() * (2 * jitterMs + 1); - intervalMs = Math.Min(intervalMs, backoff.MaxIntervalMs); + long intervalMs = ex.Response != null ? RetryAfterMs(ex.Response) : 0; + + if (intervalMs <= 0) + { + var computed = backoff.InitialIntervalMs * Math.Pow(backoff.BaseFactor, numAttempts); + var jitterMs = backoff.JitterFactor * computed; + computed = computed - jitterMs + new Random().NextDouble() * (2 * jitterMs + 1); + computed = Math.Min(computed, backoff.MaxIntervalMs); + intervalMs = (long)computed; + } await Task.Delay((int)intervalMs); numAttempts += 1; diff --git a/lending/Codat/Lending/Utils/SecurityMetadata.cs b/lending/Codat/Lending/Utils/SecurityMetadata.cs index 9a1f37ce..cc85352b 100644 --- a/lending/Codat/Lending/Utils/SecurityMetadata.cs +++ b/lending/Codat/Lending/Utils/SecurityMetadata.cs @@ -11,6 +11,7 @@ namespace Codat.Lending.Utils { using System; using System.Collections.Generic; + using System.Linq; using System.Net.Http; using System.Reflection; using System.Text; @@ -22,9 +23,9 @@ internal class SecurityMetadata private Dictionary headerParams { get; } = new Dictionary(); private Dictionary queryParams { get; } = new Dictionary(); - public SecurityMetadata(Func securitySource) + public SecurityMetadata(Func securitySource, string[]? allowedFields = null) { - ParseSecuritySource(securitySource); + ParseSecuritySource(securitySource, allowedFields); } public HttpRequestMessage Apply(HttpRequestMessage request) @@ -49,7 +50,7 @@ public HttpRequestMessage Apply(HttpRequestMessage request) return request; } - private void ParseSecuritySource(Func securitySource) + private void ParseSecuritySource(Func securitySource, string[]? allowedFields) { if (securitySource == null) { @@ -62,7 +63,16 @@ private void ParseSecuritySource(Func securitySource) return; } - foreach (var prop in security.GetType().GetProperties()) + var allProps = security.GetType().GetProperties(); + PropertyInfo[] props = allowedFields != null + ? allowedFields + .Select(name => allProps.FirstOrDefault(p => p.Name == name)) + .Where(p => p != null) + .Cast() + .ToArray() + : allProps; + + foreach (var prop in props) { var value = prop.GetValue(security, null); if (value == null) @@ -79,6 +89,7 @@ private void ParseSecuritySource(Func securitySource) if (secMetadata.Option) { ParseOption(value); + return; } else if (secMetadata.Scheme) { @@ -91,6 +102,11 @@ private void ParseSecuritySource(Func securitySource) { ParseScheme(secMetadata, value); } + + if (!secMetadata.Composite) + { + return; + } } } @@ -99,6 +115,10 @@ private void ParseSecuritySource(Func securitySource) private void ParseOption(object option) { + // Check if the option itself IS a basic auth scheme (e.g. UserPassAuth where + // fields directly contain username/password with full basic auth metadata). + // This is distinct from an option that CONTAINS a basic auth scheme as a + // nested class (e.g. SchemeBasicAuth) - that case is handled by ParseScheme. foreach (var prop in option.GetType().GetProperties()) { var value = prop.GetValue(option, null); @@ -113,6 +133,12 @@ private void ParseOption(object option) continue; } + if (secMetadata.Type == "http" && secMetadata.SubType == "basic" && !Utilities.IsClass(value)) + { + ParseBasicAuthScheme(option); + return; + } + ParseScheme(secMetadata, value); } } diff --git a/lending/Codat/Lending/Utils/SpeakeasyMetadata.cs b/lending/Codat/Lending/Utils/SpeakeasyMetadata.cs index 1ace4be7..06b90339 100644 --- a/lending/Codat/Lending/Utils/SpeakeasyMetadata.cs +++ b/lending/Codat/Lending/Utils/SpeakeasyMetadata.cs @@ -65,6 +65,7 @@ internal class SecurityMetadata public string? SubType { get; set; } = null; public bool Option { get; set; } = false; public bool Scheme { get; set; } = false; + public bool Composite { get; set; } = false; public string Name { get; set; } = ""; } diff --git a/lending/Codat/Lending/Utils/Utilities.cs b/lending/Codat/Lending/Utils/Utilities.cs index ee59d7c1..aa3ac0d5 100644 --- a/lending/Codat/Lending/Utils/Utilities.cs +++ b/lending/Codat/Lending/Utils/Utilities.cs @@ -130,11 +130,26 @@ public static bool IsList(object? o) && o.GetType().GetGenericTypeDefinition().IsAssignableFrom(typeof(List<>)); } + public static bool IsModelNamespace(string ns) + { + var modelNamespaces = new[] + { + "Codat.Lending.Models.Requests", + "Codat.Lending.Models.Components", + "Codat.Lending.Models.Errors", + "Codat.Lending.Models.Webhooks", + }; + + return modelNamespaces.Contains(ns); + } + public static bool IsClass(object? o) { if (o == null) return false; - return o.GetType().IsClass && (o.GetType().FullName ?? "").StartsWith("Codat.Lending.Models"); + if (!o.GetType().IsClass) + return false; + return IsModelNamespace(o.GetType().Namespace ?? ""); } // TODO: code review polyfilled for IsAssignableTo diff --git a/lending/RELEASES.md b/lending/RELEASES.md index 520057d4..1cb16d40 100644 --- a/lending/RELEASES.md +++ b/lending/RELEASES.md @@ -292,4 +292,14 @@ Based on: ### Generated - [csharp v10.0.1] lending ### Releases -- [NuGet v10.0.1] https://www.nuget.org/packages/Codat.Lending/10.0.1 - lending \ No newline at end of file +- [NuGet v10.0.1] https://www.nuget.org/packages/Codat.Lending/10.0.1 - lending + +## 2026-04-15 09:48:05 +### Changes +Based on: +- OpenAPI Doc +- Speakeasy CLI 1.761.5 (2.879.13) https://github.com/speakeasy-api/speakeasy +### Generated +- [csharp v10.0.2] lending +### Releases +- [NuGet v10.0.2] https://www.nuget.org/packages/Codat.Lending/10.0.2 - lending \ No newline at end of file diff --git a/lending/docs/Models/Components/AccountBalance.md b/lending/docs/Models/Components/AccountBalance.md index 91860054..edeb8886 100644 --- a/lending/docs/Models/Components/AccountBalance.md +++ b/lending/docs/Models/Components/AccountBalance.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | ----------------------------------------------- | -| `Available` | *decimal* | :heavy_minus_sign: | The account's current balance | | -| `Pending` | *decimal* | :heavy_minus_sign: | Funds that are not yet available in the balance | | -| `Reserved` | *object* | :heavy_minus_sign: | Funds reserved as holdings | | -| `Currency` | *string* | :heavy_minus_sign: | The currency of the account | GBP | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | +| `Available` | *decimal* | :heavy_minus_sign: | The account's current balance | | +| `Pending` | *decimal* | :heavy_minus_sign: | Funds that are not yet available in the balance | | +| `Reserved` | *object* | :heavy_minus_sign: | Funds reserved as holdings | | +| `Currency` | *string* | :heavy_minus_sign: | The currency of the account | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | \ No newline at end of file diff --git a/lending/docs/Models/Components/AccountIdentifierType.md b/lending/docs/Models/Components/AccountIdentifierType.md index 3c722650..01ca8109 100644 --- a/lending/docs/Models/Components/AccountIdentifierType.md +++ b/lending/docs/Models/Components/AccountIdentifierType.md @@ -2,6 +2,14 @@ Type of account +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = AccountIdentifierType.Account; +``` + ## Values diff --git a/lending/docs/Models/Components/AccountPrototype.md b/lending/docs/Models/Components/AccountPrototype.md index 4dcf0fa6..d5a4d57e 100644 --- a/lending/docs/Models/Components/AccountPrototype.md +++ b/lending/docs/Models/Components/AccountPrototype.md @@ -9,8 +9,8 @@ | `Name` | *string* | :heavy_minus_sign: | Name of the account. | Accounts Receivable | | `Description` | *string* | :heavy_minus_sign: | Description for the account. | Invoices the business has issued but has not yet collected payment on. | | `FullyQualifiedCategory` | *string* | :heavy_minus_sign: | Full category of the account.

For example, `Liability.Current` or `Income.Revenue`. To determine a list of possible categories for each integration, see our examples, follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide, or refer to the integration's own documentation. | Asset.Current | -| `FullyQualifiedName` | *string* | :heavy_minus_sign: | Full name of the account, for example:
- `Cash On Hand`
- `Rents Held In Trust`
- `Fixed Asset` | Cash On Hand | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `FullyQualifiedName` | *string* | :heavy_minus_sign: | Full name of the account, for example:
- `Cash On Hand`
- `Rents Held In Trust`
- `Fixed Asset` | **Example 1:** Cash On Hand
**Example 2:** Fixed Asset | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `CurrentBalance` | *decimal* | :heavy_minus_sign: | Current balance in the account. | 0 | | `Type` | [AccountType](../../Models/Components/AccountType.md) | :heavy_minus_sign: | Type of account | Asset | | `Status` | [AccountStatus](../../Models/Components/AccountStatus.md) | :heavy_minus_sign: | Status of the account | Active | diff --git a/lending/docs/Models/Components/AccountStatus.md b/lending/docs/Models/Components/AccountStatus.md index cddd64b3..ef7b5757 100644 --- a/lending/docs/Models/Components/AccountStatus.md +++ b/lending/docs/Models/Components/AccountStatus.md @@ -2,6 +2,14 @@ Status of the account +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = AccountStatus.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/AccountTransactionLineRecordRefDataType.md b/lending/docs/Models/Components/AccountTransactionLineRecordRefDataType.md index a5421245..049d6033 100644 --- a/lending/docs/Models/Components/AccountTransactionLineRecordRefDataType.md +++ b/lending/docs/Models/Components/AccountTransactionLineRecordRefDataType.md @@ -2,6 +2,14 @@ Name of underlying data type. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = AccountTransactionLineRecordRefDataType.BankTransactions; +``` + ## Values diff --git a/lending/docs/Models/Components/AccountType.md b/lending/docs/Models/Components/AccountType.md index 938ae146..9f8041bf 100644 --- a/lending/docs/Models/Components/AccountType.md +++ b/lending/docs/Models/Components/AccountType.md @@ -2,6 +2,14 @@ Type of account +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = AccountType.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/AccountingAccount.md b/lending/docs/Models/Components/AccountingAccount.md index 289e5959..913b858e 100644 --- a/lending/docs/Models/Components/AccountingAccount.md +++ b/lending/docs/Models/Components/AccountingAccount.md @@ -32,15 +32,15 @@ To determine the list of allowed categories for a specific integration, you can: | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Identifier for the account, unique for the company. | 1b6266d1-1e44-46c5-8eb5-a8f98e03124e | | `NominalCode` | *string* | :heavy_minus_sign: | 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. | 610 | | `Name` | *string* | :heavy_minus_sign: | Name of the account. | Accounts Receivable | | `Description` | *string* | :heavy_minus_sign: | Description for the account. | Invoices the business has issued but has not yet collected payment on. | | `FullyQualifiedCategory` | *string* | :heavy_minus_sign: | Full category of the account.

For example, `Liability.Current` or `Income.Revenue`. To determine a list of possible categories for each integration, see our examples, follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide, or refer to the integration's own documentation. | Asset.Current | -| `FullyQualifiedName` | *string* | :heavy_minus_sign: | Full name of the account, for example:
- `Cash On Hand`
- `Rents Held In Trust`
- `Fixed Asset` | Cash On Hand | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `FullyQualifiedName` | *string* | :heavy_minus_sign: | Full name of the account, for example:
- `Cash On Hand`
- `Rents Held In Trust`
- `Fixed Asset` | **Example 1:** Cash On Hand
**Example 2:** Fixed Asset | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `CurrentBalance` | *decimal* | :heavy_minus_sign: | Current balance in the account. | 0 | | `Type` | [AccountType](../../Models/Components/AccountType.md) | :heavy_minus_sign: | Type of account | Asset | | `Status` | [AccountStatus](../../Models/Components/AccountStatus.md) | :heavy_minus_sign: | Status of the account | Active | diff --git a/lending/docs/Models/Components/AccountingAccountTransaction.md b/lending/docs/Models/Components/AccountingAccountTransaction.md index 6bfd1264..5e20bfb3 100644 --- a/lending/docs/Models/Components/AccountingAccountTransaction.md +++ b/lending/docs/Models/Components/AccountingAccountTransaction.md @@ -21,15 +21,15 @@ Account transactions is the parent data type of [payments](https://docs.codat.io | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Identifier of the direct cost (unique to the company). | | | `TransactionId` | *string* | :heavy_minus_sign: | Identifier of the transaction (unique to the company). | | | `Note` | *string* | :heavy_minus_sign: | Additional information about the account transaction, if available. | | | `BankAccountRef` | [BankAccountRef](../../Models/Components/BankAccountRef.md) | :heavy_minus_sign: | Links to the Account transactions data type. | | -| `Date` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `Date` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Status` | [AccountingAccountTransactionStatus](../../Models/Components/AccountingAccountTransactionStatus.md) | :heavy_minus_sign: | The status of the account transaction. | | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `CurrencyRate` | *decimal* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting software, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \|


### Integration-specific details

\| Integration \| Scenario \| System behavior \|
\|-------------------\|-------------------------------------------------\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------\|
\| QuickBooks Online \| Transaction currency differs from base currency \| If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, specify a currencyRate in the request body. \| | | | `Lines` | List<[AccountTransactionLine](../../Models/Components/AccountTransactionLine.md)> | :heavy_minus_sign: | Array of account transaction lines. | | | `TotalAmount` | *decimal* | :heavy_minus_sign: | Total amount of the account transactions, inclusive of tax. | | diff --git a/lending/docs/Models/Components/AccountingAccountTransactionStatus.md b/lending/docs/Models/Components/AccountingAccountTransactionStatus.md index 7a38d505..1759467c 100644 --- a/lending/docs/Models/Components/AccountingAccountTransactionStatus.md +++ b/lending/docs/Models/Components/AccountingAccountTransactionStatus.md @@ -2,6 +2,14 @@ The status of the account transaction. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = AccountingAccountTransactionStatus.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/AccountingAddressType.md b/lending/docs/Models/Components/AccountingAddressType.md index 2c5f98c7..033feda2 100644 --- a/lending/docs/Models/Components/AccountingAddressType.md +++ b/lending/docs/Models/Components/AccountingAddressType.md @@ -2,6 +2,14 @@ The type of the address +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = AccountingAddressType.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/AccountingAgedCreditorReport.md b/lending/docs/Models/Components/AccountingAgedCreditorReport.md index 1244b286..6ee80b3f 100644 --- a/lending/docs/Models/Components/AccountingAgedCreditorReport.md +++ b/lending/docs/Models/Components/AccountingAgedCreditorReport.md @@ -38,6 +38,6 @@ The report will be grouped per supplier and depending on the periods requested. | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Generated` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `ReportDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `Generated` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `ReportDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Data` | List<[AgedCreditor](../../Models/Components/AgedCreditor.md)> | :heavy_minus_sign: | Array of aged creditor. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/AccountingAgedDebtorReport.md b/lending/docs/Models/Components/AccountingAgedDebtorReport.md index a4c6d06f..608a663d 100644 --- a/lending/docs/Models/Components/AccountingAgedDebtorReport.md +++ b/lending/docs/Models/Components/AccountingAgedDebtorReport.md @@ -38,6 +38,6 @@ The report will be grouped per supplier and depending on the periods requested. | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Generated` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `ReportDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `Generated` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `ReportDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Data` | List<[AgedDebtor](../../Models/Components/AgedDebtor.md)> | :heavy_minus_sign: | Array of aged debtors. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/AccountingAttachment.md b/lending/docs/Models/Components/AccountingAttachment.md index 8a2f0e68..3ad20ccf 100644 --- a/lending/docs/Models/Components/AccountingAttachment.md +++ b/lending/docs/Models/Components/AccountingAttachment.md @@ -23,11 +23,11 @@ Note that different integrations have different requirements to file size and ex | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Identifier for the attachment, unique for the company in the accounting software. | | | `Name` | *string* | :heavy_minus_sign: | Name of the attachment file. | | | `ContentType` | *string* | :heavy_minus_sign: | 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` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `DateCreated` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `FileSize` | *int* | :heavy_minus_sign: | File size in bytes. For example, if this reads **46153**, then the file size is 46kb. | | | `IncludeWhenSent` | *bool* | :heavy_minus_sign: | 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. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/AccountingBalanceSheet.md b/lending/docs/Models/Components/AccountingBalanceSheet.md index 6d6e57d5..e7712918 100644 --- a/lending/docs/Models/Components/AccountingBalanceSheet.md +++ b/lending/docs/Models/Components/AccountingBalanceSheet.md @@ -22,7 +22,7 @@ Our [Enhanced Financials](https://docs.codat.io/lending/features/financial-state | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `Reports` | List<[Models.Components.BalanceSheet](../../Models/Components/BalanceSheet.md)> | :heavy_check_mark: | An array of balance sheet reports. | | -| `MostRecentAvailableMonth` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `EarliestAvailableMonth` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `MostRecentAvailableMonth` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `EarliestAvailableMonth` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/AccountingBankAccount.md b/lending/docs/Models/Components/AccountingBankAccount.md index 0876452e..dfff9e24 100644 --- a/lending/docs/Models/Components/AccountingBankAccount.md +++ b/lending/docs/Models/Components/AccountingBankAccount.md @@ -20,8 +20,8 @@ Bank accounts data includes: | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Identifier for the account, unique for the company in the accounting software. | | | `AccountName` | *string* | :heavy_minus_sign: | Name of the bank account in the accounting software. | | | `AccountType` | [AccountingBankAccountType](../../Models/Components/AccountingBankAccountType.md) | :heavy_minus_sign: | 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. | | @@ -29,7 +29,7 @@ Bank accounts data includes: | `SortCode` | *string* | :heavy_minus_sign: | 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` | *string* | :heavy_minus_sign: | 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` | *string* | :heavy_minus_sign: | International bank account number of the account. Often used when making or receiving international payments. | | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `Balance` | *decimal* | :heavy_minus_sign: | Balance of the bank account. | | | `Institution` | *string* | :heavy_minus_sign: | The institution of the bank account. | | | `AvailableBalance` | *decimal* | :heavy_minus_sign: | 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. | | diff --git a/lending/docs/Models/Components/AccountingBankAccountType.md b/lending/docs/Models/Components/AccountingBankAccountType.md index e079af7b..8e3cb2ff 100644 --- a/lending/docs/Models/Components/AccountingBankAccountType.md +++ b/lending/docs/Models/Components/AccountingBankAccountType.md @@ -4,6 +4,14 @@ 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. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = AccountingBankAccountType.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/AccountingBankTransaction.md b/lending/docs/Models/Components/AccountingBankTransaction.md index c0c5ddb3..b5869ff5 100644 --- a/lending/docs/Models/Components/AccountingBankTransaction.md +++ b/lending/docs/Models/Components/AccountingBankTransaction.md @@ -20,11 +20,11 @@ Bank transactions include the: | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Identifier for the bank transaction, unique to the company in the accounting software. | | | `AccountId` | *string* | :heavy_minus_sign: | Unique identifier to the `accountId` the bank transactions originates from. | | -| `ClearedOnDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `ClearedOnDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Description` | *string* | :heavy_minus_sign: | Description of the bank transaction. | | | `Reconciled` | *bool* | :heavy_minus_sign: | `True` if the bank transaction has been [reconciled](https://www.xero.com/uk/guides/what-is-bank-reconciliation/) in the accounting software. | | | `Amount` | *decimal* | :heavy_minus_sign: | The amount transacted in the bank transaction. | | diff --git a/lending/docs/Models/Components/AccountingBill.md b/lending/docs/Models/Components/AccountingBill.md index 45a8922f..71a8fbab 100644 --- a/lending/docs/Models/Components/AccountingBill.md +++ b/lending/docs/Models/Components/AccountingBill.md @@ -23,15 +23,15 @@ You can find these types of transactions in our [Direct costs](https://docs.coda | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Identifier for the bill, unique for the company in the accounting software. | | | `Reference` | *string* | :heavy_minus_sign: | User-friendly reference for the bill. | | | `SupplierRef` | [SupplierRef](../../Models/Components/SupplierRef.md) | :heavy_minus_sign: | Reference to the supplier the record relates to. | | | `PurchaseOrderRefs` | List<[PurchaseOrderReference](../../Models/Components/PurchaseOrderReference.md)> | :heavy_minus_sign: | N/A | | -| `IssueDate` | *string* | :heavy_check_mark: | N/A | 2022-10-23T00:00:00Z | -| `DueDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `IssueDate` | *string* | :heavy_check_mark: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `DueDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `CurrencyRate` | *decimal* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting software, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \|


### Integration-specific details

\| Integration \| Scenario \| System behavior \|
\|-------------------\|-------------------------------------------------\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------\|
\| QuickBooks Online \| Transaction currency differs from base currency \| If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, specify a currencyRate in the request body. \| | | | `LineItems` | List<[BillLineItem](../../Models/Components/BillLineItem.md)> | :heavy_minus_sign: | Array of Bill line items. | | | `WithholdingTax` | List<[WithholdingTax](../../Models/Components/WithholdingTax.md)> | :heavy_minus_sign: | N/A | | diff --git a/lending/docs/Models/Components/AccountingBillCreditNote.md b/lending/docs/Models/Components/AccountingBillCreditNote.md index 9fe5ce8e..c9c34d7e 100644 --- a/lending/docs/Models/Components/AccountingBillCreditNote.md +++ b/lending/docs/Models/Components/AccountingBillCreditNote.md @@ -20,8 +20,8 @@ A bill credit note includes details of: | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Identifier for the bill credit note that is unique to a company in the accounting software. | 1509398f-98e2-436d-8a5d-c042e0c74ffc | | `BillCreditNoteNumber` | *string* | :heavy_minus_sign: | Friendly reference for the bill credit note. | 91fe2a83-e161-4c21-929d-c5c10c4b07e5 | | `SupplierRef` | [SupplierRef](../../Models/Components/SupplierRef.md) | :heavy_minus_sign: | Reference to the supplier the record relates to. | | @@ -33,9 +33,9 @@ A bill credit note includes details of: | `DiscountPercentage` | *decimal* | :heavy_check_mark: | Percentage rate of any discount applied to the bill credit note. | 0 | | `RemainingCredit` | *decimal* | :heavy_minus_sign: | Amount of the bill credit note that is still outstanding. | 0 | | `Status` | [BillCreditNoteStatus](../../Models/Components/BillCreditNoteStatus.md) | :heavy_check_mark: | Current state of the bill credit note | Paid | -| `IssueDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `AllocatedOnDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `IssueDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `AllocatedOnDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `CurrencyRate` | *decimal* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting software, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \|


### Integration-specific details

\| Integration \| Scenario \| System behavior \|
\|-------------------\|-------------------------------------------------\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------\|
\| QuickBooks Online \| Transaction currency differs from base currency \| If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, specify a currencyRate in the request body. \| | | | `LineItems` | List<[BillCreditNoteLineItem](../../Models/Components/BillCreditNoteLineItem.md)> | :heavy_minus_sign: | An array of line | | | `PaymentAllocations` | List<[AccountingPaymentAllocation](../../Models/Components/AccountingPaymentAllocation.md)> | :heavy_minus_sign: | An array of payment allocations. | | diff --git a/lending/docs/Models/Components/AccountingBillPayment.md b/lending/docs/Models/Components/AccountingBillPayment.md index 55f5c64d..be955f7b 100644 --- a/lending/docs/Models/Components/AccountingBillPayment.md +++ b/lending/docs/Models/Components/AccountingBillPayment.md @@ -155,15 +155,15 @@ These two rates allow the calculation of currency loss or gain for any of the tr | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Identifier for the bill payment, unique for the company in the accounting software. | 3d5a8e00-d108-4045-8823-7f342676cffa | | `SupplierRef` | [SupplierRef](../../Models/Components/SupplierRef.md) | :heavy_minus_sign: | N/A | | | `AccountRef` | [AccountRef](../../Models/Components/AccountRef.md) | :heavy_minus_sign: | Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account. | {
"Example": {
"value": {
"accountRef": {
"id": "4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a",
"name": "Business Current Account"
}
}
}
} | | `TotalAmount` | *decimal* | :heavy_minus_sign: | Amount of the payment in the payment currency. This value never changes and represents the amount of money that is paid into the supplier's account. | 1329.54 | -| `Currency` | *string* | :heavy_minus_sign: | N/A | GBP | +| `Currency` | *string* | :heavy_minus_sign: | N/A | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `CurrencyRate` | *decimal* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting software, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \|


### Integration-specific details

\| Integration \| Scenario \| System behavior \|
\|-------------------\|-------------------------------------------------\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------\|
\| QuickBooks Online \| Transaction currency differs from base currency \| If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, specify a currencyRate in the request body. \| | | -| `Date` | *string* | :heavy_check_mark: | N/A | 2022-10-23T00:00:00Z | +| `Date` | *string* | :heavy_check_mark: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Note` | *string* | :heavy_minus_sign: | Additional information associated with the payment. | Bill Payment against bill c13e37b6-dfaa-4894-b3be-9fe97bda9f44 | | `PaymentMethodRef` | [PaymentMethodRef](../../Models/Components/PaymentMethodRef.md) | :heavy_minus_sign: | N/A | {
"id": "EILBDVJVNUAGVKRQ",
"name": "AliPay"
} | | `Lines` | List<[BillPaymentLine](../../Models/Components/BillPaymentLine.md)> | :heavy_minus_sign: | An array of bill payment lines. | | diff --git a/lending/docs/Models/Components/AccountingCashFlowStatement.md b/lending/docs/Models/Components/AccountingCashFlowStatement.md index b567c612..0a69988b 100644 --- a/lending/docs/Models/Components/AccountingCashFlowStatement.md +++ b/lending/docs/Models/Components/AccountingCashFlowStatement.md @@ -20,6 +20,6 @@ A cash flow statement is a financial report that records all cash that is receiv | `Reports` | List<[CashFlowStatement](../../Models/Components/CashFlowStatement.md)> | :heavy_check_mark: | Array of cash flow statements. | | | `ReportBasis` | [ReportBasis](../../Models/Components/ReportBasis.md) | :heavy_check_mark: | Accounting method used when aggregating the report data. In this case, `Cash`. | | | `ReportInput` | [ReportInput](../../Models/Components/ReportInput.md) | :heavy_check_mark: | Accounting method used to prepare the cash flow statement. | | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | -| `MostRecentAvailableMonth` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `EarliestAvailableMonth` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | +| `MostRecentAvailableMonth` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `EarliestAvailableMonth` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/AccountingCompanyInfo.md b/lending/docs/Models/Components/AccountingCompanyInfo.md index dc0d4bdc..03d2d56f 100644 --- a/lending/docs/Models/Components/AccountingCompanyInfo.md +++ b/lending/docs/Models/Components/AccountingCompanyInfo.md @@ -17,11 +17,11 @@ Company info provides standard details about a linked company such as their addr | `Addresses` | List<[AccountingAddress](../../Models/Components/AccountingAddress.md)> | :heavy_minus_sign: | An array of Addresses. | | | `PhoneNumbers` | List<[PhoneNumber](../../Models/Components/PhoneNumber.md)> | :heavy_minus_sign: | An array of phone numbers. | | | `WebLinks` | List<[WebLink](../../Models/Components/WebLink.md)> | :heavy_minus_sign: | An array of weblinks. | | -| `LedgerLockDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `LedgerLockDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `RegistrationNumber` | *string* | :heavy_minus_sign: | Registration number given to the linked company by the companies authority in the country of origin. In the UK this is Companies House. | | | `TaxNumber` | *string* | :heavy_minus_sign: | Company tax number. | | -| `FinancialYearStartDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `FinancialYearStartDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `BaseCurrency` | *string* | :heavy_minus_sign: | Currency set in the accounting software of the linked company. Used by the currency rate. | | | `SourceUrls` | Dictionary | :heavy_minus_sign: | URL addresses for the accounting source.

For example, for Xero integrations two URLs are returned. These have many potential use cases, such as [deep linking](https://developer.xero.com/documentation/api-guides/deep-link-xero). | | -| `CreatedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `CreatedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `SupplementalData` | [SupplementalData](../../Models/Components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/AccountingCreateAccountResponse.md b/lending/docs/Models/Components/AccountingCreateAccountResponse.md index 1cb1c467..2afe59e3 100644 --- a/lending/docs/Models/Components/AccountingCreateAccountResponse.md +++ b/lending/docs/Models/Components/AccountingCreateAccountResponse.md @@ -11,8 +11,8 @@ | `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `PushOperationKey` | *string* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `DataConnectionKey` | *string* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `RequestedOnUtc` | *string* | :heavy_check_mark: | 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. | 2022-10-23T00:00:00Z | -| `CompletedOnUtc` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `RequestedOnUtc` | *string* | :heavy_check_mark: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `CompletedOnUtc` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `TimeoutInMinutes` | *int* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | | ~~`TimeoutInSeconds`~~ | *int* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | | `Status` | [PushOperationStatus](../../Models/Components/PushOperationStatus.md) | :heavy_check_mark: | The current status of the push operation. | | diff --git a/lending/docs/Models/Components/AccountingCreateAccountResponseAccountingAccount.md b/lending/docs/Models/Components/AccountingCreateAccountResponseAccountingAccount.md index 0ea57580..eb2448b6 100644 --- a/lending/docs/Models/Components/AccountingCreateAccountResponseAccountingAccount.md +++ b/lending/docs/Models/Components/AccountingCreateAccountResponseAccountingAccount.md @@ -34,15 +34,15 @@ To determine the list of allowed categories for a specific integration, you can: | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Identifier for the account, unique for the company. | 1b6266d1-1e44-46c5-8eb5-a8f98e03124e | | `NominalCode` | *string* | :heavy_minus_sign: | 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. | 610 | | `Name` | *string* | :heavy_minus_sign: | Name of the account. | Accounts Receivable | | `Description` | *string* | :heavy_minus_sign: | Description for the account. | Invoices the business has issued but has not yet collected payment on. | | `FullyQualifiedCategory` | *string* | :heavy_minus_sign: | Full category of the account.

For example, `Liability.Current` or `Income.Revenue`. To determine a list of possible categories for each integration, see our examples, follow our [Create, update, delete data](https://docs.codat.io/using-the-api/push) guide, or refer to the integration's own documentation. | Asset.Current | -| `FullyQualifiedName` | *string* | :heavy_minus_sign: | Full name of the account, for example:
- `Cash On Hand`
- `Rents Held In Trust`
- `Fixed Asset` | Cash On Hand | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `FullyQualifiedName` | *string* | :heavy_minus_sign: | Full name of the account, for example:
- `Cash On Hand`
- `Rents Held In Trust`
- `Fixed Asset` | **Example 1:** Cash On Hand
**Example 2:** Fixed Asset | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `CurrentBalance` | *decimal* | :heavy_minus_sign: | Current balance in the account. | 0 | | `Type` | [AccountType](../../Models/Components/AccountType.md) | :heavy_minus_sign: | Type of account | Asset | | `Status` | [AccountStatus](../../Models/Components/AccountStatus.md) | :heavy_minus_sign: | Status of the account | Active | diff --git a/lending/docs/Models/Components/AccountingCreateBankAccountResponse.md b/lending/docs/Models/Components/AccountingCreateBankAccountResponse.md index b97d621f..454686f8 100644 --- a/lending/docs/Models/Components/AccountingCreateBankAccountResponse.md +++ b/lending/docs/Models/Components/AccountingCreateBankAccountResponse.md @@ -11,8 +11,8 @@ | `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `PushOperationKey` | *string* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `DataConnectionKey` | *string* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `RequestedOnUtc` | *string* | :heavy_check_mark: | 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. | 2022-10-23T00:00:00Z | -| `CompletedOnUtc` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `RequestedOnUtc` | *string* | :heavy_check_mark: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `CompletedOnUtc` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `TimeoutInMinutes` | *int* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | | ~~`TimeoutInSeconds`~~ | *int* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | | `Status` | [PushOperationStatus](../../Models/Components/PushOperationStatus.md) | :heavy_check_mark: | The current status of the push operation. | | diff --git a/lending/docs/Models/Components/AccountingCreateBankAccountResponseAccountingBankAccount.md b/lending/docs/Models/Components/AccountingCreateBankAccountResponseAccountingBankAccount.md index 9e437e91..5f55c74d 100644 --- a/lending/docs/Models/Components/AccountingCreateBankAccountResponseAccountingBankAccount.md +++ b/lending/docs/Models/Components/AccountingCreateBankAccountResponseAccountingBankAccount.md @@ -22,8 +22,8 @@ Bank accounts data includes: | Field | Type | Required | Description | Example | | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Identifier for the account, unique for the company in the accounting software. | | | `AccountName` | *string* | :heavy_minus_sign: | Name of the bank account in the accounting software. | | | `AccountType` | [AccountingBankAccountType](../../Models/Components/AccountingBankAccountType.md) | :heavy_minus_sign: | 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. | | @@ -31,7 +31,7 @@ Bank accounts data includes: | `SortCode` | *string* | :heavy_minus_sign: | 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` | *string* | :heavy_minus_sign: | 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` | *string* | :heavy_minus_sign: | International bank account number of the account. Often used when making or receiving international payments. | | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `Balance` | *decimal* | :heavy_minus_sign: | Balance of the bank account. | | | `Institution` | *string* | :heavy_minus_sign: | The institution of the bank account. | | | `AvailableBalance` | *decimal* | :heavy_minus_sign: | 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. | | diff --git a/lending/docs/Models/Components/AccountingCreateBankAccountTransactions.md b/lending/docs/Models/Components/AccountingCreateBankAccountTransactions.md index a9a7a997..7653716e 100644 --- a/lending/docs/Models/Components/AccountingCreateBankAccountTransactions.md +++ b/lending/docs/Models/Components/AccountingCreateBankAccountTransactions.md @@ -5,7 +5,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `AccountId` | *string* | :heavy_minus_sign: | Unique identifier for a bank account. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `Transactions` | List<[CreateBankAccountTransaction](../../Models/Components/CreateBankAccountTransaction.md)> | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `AccountId` | *string* | :heavy_minus_sign: | Unique identifier for a bank account. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ
**Example 5:** Checking 0202 | +| `Transactions` | List<[CreateBankAccountTransaction](../../Models/Components/CreateBankAccountTransaction.md)> | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/Models/Components/AccountingCreateBankTransactions.md b/lending/docs/Models/Components/AccountingCreateBankTransactions.md index 2d8a5926..ab00347d 100644 --- a/lending/docs/Models/Components/AccountingCreateBankTransactions.md +++ b/lending/docs/Models/Components/AccountingCreateBankTransactions.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `AccountId` | *string* | :heavy_minus_sign: | Unique identifier for a bank account. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `Transactions` | List<[CreateBankAccountTransaction](../../Models/Components/CreateBankAccountTransaction.md)> | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `AccountId` | *string* | :heavy_minus_sign: | Unique identifier for a bank account. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ
**Example 5:** Checking 0202 | +| `Transactions` | List<[CreateBankAccountTransaction](../../Models/Components/CreateBankAccountTransaction.md)> | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/Models/Components/AccountingCreateBankTransactionsResponse.md b/lending/docs/Models/Components/AccountingCreateBankTransactionsResponse.md index abe285d8..dad74d1a 100644 --- a/lending/docs/Models/Components/AccountingCreateBankTransactionsResponse.md +++ b/lending/docs/Models/Components/AccountingCreateBankTransactionsResponse.md @@ -11,8 +11,8 @@ | `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `PushOperationKey` | *string* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `DataConnectionKey` | *string* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `RequestedOnUtc` | *string* | :heavy_check_mark: | 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. | 2022-10-23T00:00:00Z | -| `CompletedOnUtc` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `RequestedOnUtc` | *string* | :heavy_check_mark: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `CompletedOnUtc` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `TimeoutInMinutes` | *int* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | | ~~`TimeoutInSeconds`~~ | *int* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | | `Status` | [PushOperationStatus](../../Models/Components/PushOperationStatus.md) | :heavy_check_mark: | The current status of the push operation. | | diff --git a/lending/docs/Models/Components/AccountingCreateDirectCostResponse.md b/lending/docs/Models/Components/AccountingCreateDirectCostResponse.md index 5482283d..2ce3ba07 100644 --- a/lending/docs/Models/Components/AccountingCreateDirectCostResponse.md +++ b/lending/docs/Models/Components/AccountingCreateDirectCostResponse.md @@ -11,8 +11,8 @@ | `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `PushOperationKey` | *string* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `DataConnectionKey` | *string* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `RequestedOnUtc` | *string* | :heavy_check_mark: | 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. | 2022-10-23T00:00:00Z | -| `CompletedOnUtc` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `RequestedOnUtc` | *string* | :heavy_check_mark: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `CompletedOnUtc` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `TimeoutInMinutes` | *int* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | | ~~`TimeoutInSeconds`~~ | *int* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | | `Status` | [PushOperationStatus](../../Models/Components/PushOperationStatus.md) | :heavy_check_mark: | The current status of the push operation. | | diff --git a/lending/docs/Models/Components/AccountingCreateDirectCostResponseAccountingDirectCost.md b/lending/docs/Models/Components/AccountingCreateDirectCostResponseAccountingDirectCost.md index 3c24ceb4..21268d80 100644 --- a/lending/docs/Models/Components/AccountingCreateDirectCostResponseAccountingDirectCost.md +++ b/lending/docs/Models/Components/AccountingCreateDirectCostResponseAccountingDirectCost.md @@ -19,14 +19,14 @@ Direct costs is a child data type of [account transactions](https://docs.codat.i | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Identifier of the direct cost, unique for the company. | | | `Reference` | *string* | :heavy_minus_sign: | User-friendly reference for the direct cost. | | | `Note` | *string* | :heavy_minus_sign: | A note attached to the direct cost. | | | `ContactRef` | [ContactRef](../../Models/Components/ContactRef.md) | :heavy_minus_sign: | N/A | | -| `IssueDate` | *string* | :heavy_check_mark: | 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. | 2022-10-23T00:00:00Z | -| `Currency` | *string* | :heavy_check_mark: | 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. | GBP | +| `IssueDate` | *string* | :heavy_check_mark: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `Currency` | *string* | :heavy_check_mark: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `CurrencyRate` | *decimal* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting software, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \|


### Integration-specific details

\| Integration \| Scenario \| System behavior \|
\|-------------------\|-------------------------------------------------\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------\|
\| QuickBooks Online \| Transaction currency differs from base currency \| If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, specify a currencyRate in the request body. \| | | | `LineItems` | List<[DirectCostLineItem](../../Models/Components/DirectCostLineItem.md)> | :heavy_check_mark: | An array of line items. | | | `PaymentAllocations` | List<[AccountingPaymentAllocation](../../Models/Components/AccountingPaymentAllocation.md)> | :heavy_check_mark: | An array of payment allocations. | | diff --git a/lending/docs/Models/Components/AccountingCreatePaymentResponse.md b/lending/docs/Models/Components/AccountingCreatePaymentResponse.md index 9ecd9a1b..92e6eff7 100644 --- a/lending/docs/Models/Components/AccountingCreatePaymentResponse.md +++ b/lending/docs/Models/Components/AccountingCreatePaymentResponse.md @@ -11,8 +11,8 @@ | `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `PushOperationKey` | *string* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `DataConnectionKey` | *string* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `RequestedOnUtc` | *string* | :heavy_check_mark: | 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. | 2022-10-23T00:00:00Z | -| `CompletedOnUtc` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `RequestedOnUtc` | *string* | :heavy_check_mark: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `CompletedOnUtc` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `TimeoutInMinutes` | *int* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | | ~~`TimeoutInSeconds`~~ | *int* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | | `Status` | [PushOperationStatus](../../Models/Components/PushOperationStatus.md) | :heavy_check_mark: | The current status of the push operation. | | diff --git a/lending/docs/Models/Components/AccountingCreatePaymentResponseAccountingPayment.md b/lending/docs/Models/Components/AccountingCreatePaymentResponseAccountingPayment.md index 627417bf..cdbc04fc 100644 --- a/lending/docs/Models/Components/AccountingCreatePaymentResponseAccountingPayment.md +++ b/lending/docs/Models/Components/AccountingCreatePaymentResponseAccountingPayment.md @@ -684,16 +684,16 @@ In this example, a payment on account is used to pay the same invoice in January | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Identifier for the payment, unique to the company in the accounting software. | | | `CustomerRef` | [AccountingCustomerRef](../../Models/Components/AccountingCustomerRef.md) | :heavy_minus_sign: | N/A | | | `AccountRef` | [AccountRef](../../Models/Components/AccountRef.md) | :heavy_minus_sign: | Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account. | {
"Example": {
"value": {
"accountRef": {
"id": "4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a",
"name": "Business Current Account"
}
}
}
} | | `PaymentMethodRef` | [PaymentMethodRef](../../Models/Components/PaymentMethodRef.md) | :heavy_minus_sign: | The payment method the record is linked to in the accounting or commerce software. | {
"id": "EILBDVJVNUAGVKRQ",
"name": "AliPay"
} | | `TotalAmount` | *decimal* | :heavy_minus_sign: | Amount of the payment in the payment currency. This value should never change and represents the amount of money paid into the customer's account. | | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `CurrencyRate` | *decimal* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting software, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \|


### Integration-specific details

\| Integration \| Scenario \| System behavior \|
\|-------------------\|-------------------------------------------------\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------\|
\| QuickBooks Online \| Transaction currency differs from base currency \| If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, specify a currencyRate in the request body. \| | | -| `Date` | *string* | :heavy_check_mark: | 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. | 2022-10-23T00:00:00Z | +| `Date` | *string* | :heavy_check_mark: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Note` | *string* | :heavy_minus_sign: | Any additional information associated with the payment. | | | `Lines` | List<[PaymentLine](../../Models/Components/PaymentLine.md)> | :heavy_minus_sign: | An array of payment lines. | | | `Reference` | *string* | :heavy_minus_sign: | Friendly reference for the payment. | | diff --git a/lending/docs/Models/Components/AccountingCreateSupplierResponse.md b/lending/docs/Models/Components/AccountingCreateSupplierResponse.md index b56e4573..9058ba04 100644 --- a/lending/docs/Models/Components/AccountingCreateSupplierResponse.md +++ b/lending/docs/Models/Components/AccountingCreateSupplierResponse.md @@ -11,8 +11,8 @@ | `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `PushOperationKey` | *string* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `DataConnectionKey` | *string* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `RequestedOnUtc` | *string* | :heavy_check_mark: | 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. | 2022-10-23T00:00:00Z | -| `CompletedOnUtc` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `RequestedOnUtc` | *string* | :heavy_check_mark: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `CompletedOnUtc` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `TimeoutInMinutes` | *int* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | | ~~`TimeoutInSeconds`~~ | *int* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | | `Status` | [PushOperationStatus](../../Models/Components/PushOperationStatus.md) | :heavy_check_mark: | The current status of the push operation. | | diff --git a/lending/docs/Models/Components/AccountingCreateSupplierResponseAccountingSupplier.md b/lending/docs/Models/Components/AccountingCreateSupplierResponseAccountingSupplier.md index e4fb1ce8..d06755dc 100644 --- a/lending/docs/Models/Components/AccountingCreateSupplierResponseAccountingSupplier.md +++ b/lending/docs/Models/Components/AccountingCreateSupplierResponseAccountingSupplier.md @@ -11,13 +11,13 @@ From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Identifier for the supplier, unique to the company in the accounting software. | | | `SupplierName` | *string* | :heavy_minus_sign: | Name of the supplier as recorded in the accounting system, typically the company name. | | | `ContactName` | *string* | :heavy_minus_sign: | Name of the main contact for the supplier. | | | `EmailAddress` | *string* | :heavy_minus_sign: | Email address that the supplier may be contacted on. | | -| `Phone` | *string* | :heavy_minus_sign: | Phone number that the supplier may be contacted on. | +44 25691 154789 | +| `Phone` | *string* | :heavy_minus_sign: | Phone number that the supplier may be contacted on. | **Example 1:** +44 25691 154789
**Example 2:** (877) 492-8687
**Example 3:** 01224 658 999 | | `Addresses` | List<[AccountingAddress](../../Models/Components/AccountingAddress.md)> | :heavy_minus_sign: | An array of Addresses. | | | `RegistrationNumber` | *string* | :heavy_minus_sign: | Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House. | | | `TaxNumber` | *string* | :heavy_minus_sign: | Supplier's company tax number. | | diff --git a/lending/docs/Models/Components/AccountingCreateTransferResponse.md b/lending/docs/Models/Components/AccountingCreateTransferResponse.md index bbba988a..537a4ee7 100644 --- a/lending/docs/Models/Components/AccountingCreateTransferResponse.md +++ b/lending/docs/Models/Components/AccountingCreateTransferResponse.md @@ -11,8 +11,8 @@ | `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `PushOperationKey` | *string* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `DataConnectionKey` | *string* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `RequestedOnUtc` | *string* | :heavy_check_mark: | 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. | 2022-10-23T00:00:00Z | -| `CompletedOnUtc` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `RequestedOnUtc` | *string* | :heavy_check_mark: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `CompletedOnUtc` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `TimeoutInMinutes` | *int* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | | ~~`TimeoutInSeconds`~~ | *int* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | | `Status` | [PushOperationStatus](../../Models/Components/PushOperationStatus.md) | :heavy_check_mark: | The current status of the push operation. | | diff --git a/lending/docs/Models/Components/AccountingCreateTransferResponseAccountingTransfer.md b/lending/docs/Models/Components/AccountingCreateTransferResponseAccountingTransfer.md index 4f2d421e..d4dca12e 100644 --- a/lending/docs/Models/Components/AccountingCreateTransferResponseAccountingTransfer.md +++ b/lending/docs/Models/Components/AccountingCreateTransferResponseAccountingTransfer.md @@ -9,12 +9,12 @@ A transfer records the movement of money between two bank accounts, or between a | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Unique identifier for the transfer. | | | `Description` | *string* | :heavy_minus_sign: | Description of the transfer. | | | `ContactRef` | [ContactRef](../../Models/Components/ContactRef.md) | :heavy_minus_sign: | N/A | | -| `Date` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `Date` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `From` | [TransferAccount](../../Models/Components/TransferAccount.md) | :heavy_minus_sign: | Account details of the account sending or receiving the transfer. | | | `To` | [TransferAccount](../../Models/Components/TransferAccount.md) | :heavy_minus_sign: | Account details of the account sending or receiving the transfer. | | | `Status` | [AccountingCreateTransferResponseStatus](../../Models/Components/AccountingCreateTransferResponseStatus.md) | :heavy_minus_sign: | The status of the transfer in the account | | diff --git a/lending/docs/Models/Components/AccountingCreateTransferResponseStatus.md b/lending/docs/Models/Components/AccountingCreateTransferResponseStatus.md index 03ebdfdf..8e9aa5d9 100644 --- a/lending/docs/Models/Components/AccountingCreateTransferResponseStatus.md +++ b/lending/docs/Models/Components/AccountingCreateTransferResponseStatus.md @@ -2,6 +2,14 @@ The status of the transfer in the account +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = AccountingCreateTransferResponseStatus.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/AccountingCreditNote.md b/lending/docs/Models/Components/AccountingCreditNote.md index 7ddc183f..1bce54f7 100644 --- a/lending/docs/Models/Components/AccountingCreditNote.md +++ b/lending/docs/Models/Components/AccountingCreditNote.md @@ -16,8 +16,8 @@ It contains details of: | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Identifier for the credit note, unique to the company in the accounting software. | | | `CreditNoteNumber` | *string* | :heavy_minus_sign: | Friendly reference for the credit note. | | | `CustomerRef` | [AccountingCustomerRef](../../Models/Components/AccountingCustomerRef.md) | :heavy_minus_sign: | N/A | | @@ -31,9 +31,9 @@ It contains details of: | `DiscountPercentage` | *decimal* | :heavy_check_mark: | Percentage rate (from 0 to 100) of discounts applied to the credit note. | | | `RemainingCredit` | *decimal* | :heavy_check_mark: | Unused balance of totalAmount originally raised. | | | `Status` | [CreditNoteStatus](../../Models/Components/CreditNoteStatus.md) | :heavy_check_mark: | Current state of the credit note. | | -| `IssueDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `AllocatedOnDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `IssueDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `AllocatedOnDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `CurrencyRate` | *decimal* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting software, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \|


### Integration-specific details

\| Integration \| Scenario \| System behavior \|
\|-------------------\|-------------------------------------------------\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------\|
\| QuickBooks Online \| Transaction currency differs from base currency \| If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, specify a currencyRate in the request body. \| | | | `LineItems` | List<[CreditNoteLineItem](../../Models/Components/CreditNoteLineItem.md)> | :heavy_minus_sign: | N/A | | | `PaymentAllocations` | List<[AccountingPaymentAllocation](../../Models/Components/AccountingPaymentAllocation.md)> | :heavy_minus_sign: | An array of payment allocations. | | diff --git a/lending/docs/Models/Components/AccountingCustomer.md b/lending/docs/Models/Components/AccountingCustomer.md index bb38b4ac..e566e386 100644 --- a/lending/docs/Models/Components/AccountingCustomer.md +++ b/lending/docs/Models/Components/AccountingCustomer.md @@ -12,13 +12,13 @@ Customers' data links to accounts receivable [invoices](https://docs.codat.io/le | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Identifier for the customer, unique to the company in the accounting software. | | | `CustomerName` | *string* | :heavy_minus_sign: | Name of the customer as recorded in the accounting system, typically the company name. | | | `ContactName` | *string* | :heavy_minus_sign: | Name of the main contact for the identified customer. | | | `EmailAddress` | *string* | :heavy_minus_sign: | Email address the customer can be contacted by. | | -| `DefaultCurrency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `DefaultCurrency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `Phone` | *string* | :heavy_minus_sign: | Phone number the customer can be contacted by. | | | `Addresses` | List<[AccountingAddress](../../Models/Components/AccountingAddress.md)> | :heavy_minus_sign: | An array of Addresses. | | | `Contacts` | List<[Contact](../../Models/Components/Contact.md)> | :heavy_minus_sign: | An array of Contacts. | | diff --git a/lending/docs/Models/Components/AccountingDirectCost.md b/lending/docs/Models/Components/AccountingDirectCost.md index abf3ea76..dbc6867b 100644 --- a/lending/docs/Models/Components/AccountingDirectCost.md +++ b/lending/docs/Models/Components/AccountingDirectCost.md @@ -17,14 +17,14 @@ Direct costs is a child data type of [account transactions](https://docs.codat.i | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Identifier of the direct cost, unique for the company. | | | `Reference` | *string* | :heavy_minus_sign: | User-friendly reference for the direct cost. | | | `Note` | *string* | :heavy_minus_sign: | A note attached to the direct cost. | | | `ContactRef` | [ContactRef](../../Models/Components/ContactRef.md) | :heavy_minus_sign: | N/A | | -| `IssueDate` | *string* | :heavy_check_mark: | 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. | 2022-10-23T00:00:00Z | -| `Currency` | *string* | :heavy_check_mark: | 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. | GBP | +| `IssueDate` | *string* | :heavy_check_mark: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `Currency` | *string* | :heavy_check_mark: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `CurrencyRate` | *decimal* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting software, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \|


### Integration-specific details

\| Integration \| Scenario \| System behavior \|
\|-------------------\|-------------------------------------------------\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------\|
\| QuickBooks Online \| Transaction currency differs from base currency \| If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, specify a currencyRate in the request body. \| | | | `LineItems` | List<[DirectCostLineItem](../../Models/Components/DirectCostLineItem.md)> | :heavy_check_mark: | An array of line items. | | | `PaymentAllocations` | List<[AccountingPaymentAllocation](../../Models/Components/AccountingPaymentAllocation.md)> | :heavy_check_mark: | An array of payment allocations. | | diff --git a/lending/docs/Models/Components/AccountingDirectIncome.md b/lending/docs/Models/Components/AccountingDirectIncome.md index 9e906bde..690d840e 100644 --- a/lending/docs/Models/Components/AccountingDirectIncome.md +++ b/lending/docs/Models/Components/AccountingDirectIncome.md @@ -19,14 +19,14 @@ Direct incomes is a child data type of [account transactions](https://docs.codat | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Identifier of the direct income, unique for the company. | | | `Reference` | *string* | :heavy_minus_sign: | User-friendly reference for the direct income. | | | `Note` | *string* | :heavy_minus_sign: | An optional note on the direct income that can be used to assign the direct income with a reference ID in your application. | | | `ContactRef` | [ContactRef](../../Models/Components/ContactRef.md) | :heavy_minus_sign: | N/A | | -| `IssueDate` | *string* | :heavy_check_mark: | 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. | 2022-10-23T00:00:00Z | -| `Currency` | *string* | :heavy_check_mark: | 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. | GBP | +| `IssueDate` | *string* | :heavy_check_mark: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `Currency` | *string* | :heavy_check_mark: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `CurrencyRate` | *decimal* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting software, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \|


### Integration-specific details

\| Integration \| Scenario \| System behavior \|
\|-------------------\|-------------------------------------------------\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------\|
\| QuickBooks Online \| Transaction currency differs from base currency \| If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, specify a currencyRate in the request body. \| | | | `LineItems` | List<[DirectIncomeLineItem](../../Models/Components/DirectIncomeLineItem.md)> | :heavy_check_mark: | An array of line items. | | | `PaymentAllocations` | List<[AccountingPaymentAllocation](../../Models/Components/AccountingPaymentAllocation.md)> | :heavy_check_mark: | N/A | | diff --git a/lending/docs/Models/Components/AccountingInvoice.md b/lending/docs/Models/Components/AccountingInvoice.md index 8152ce99..d6d75ce3 100644 --- a/lending/docs/Models/Components/AccountingInvoice.md +++ b/lending/docs/Models/Components/AccountingInvoice.md @@ -33,16 +33,16 @@ In Codat, an invoice contains details of: | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Identifier for the invoice, unique to the company in the accounting software. | | | `InvoiceNumber` | *string* | :heavy_minus_sign: | Friendly reference for the invoice. If available, this appears in the file name of invoice attachments. | | | `CustomerRef` | [AccountingCustomerRef](../../Models/Components/AccountingCustomerRef.md) | :heavy_minus_sign: | N/A | | | `SalesOrderRefs` | List<[SalesOrderReference](../../Models/Components/SalesOrderReference.md)> | :heavy_minus_sign: | List of references to related Sales orders. | | -| `IssueDate` | *string* | :heavy_check_mark: | 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. | 2022-10-23T00:00:00Z | -| `DueDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `PaidOnDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `IssueDate` | *string* | :heavy_check_mark: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `DueDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `PaidOnDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `CurrencyRate` | *decimal* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting software, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \|


### Integration-specific details

\| Integration \| Scenario \| System behavior \|
\|-------------------\|-------------------------------------------------\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------\|
\| QuickBooks Online \| Transaction currency differs from base currency \| If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, specify a currencyRate in the request body. \| | | | `LineItems` | List<[InvoiceLineItem](../../Models/Components/InvoiceLineItem.md)> | :heavy_minus_sign: | An array of line items. | | | `PaymentAllocations` | List<[AccountingPaymentAllocation](../../Models/Components/AccountingPaymentAllocation.md)> | :heavy_minus_sign: | An array of payment allocations. | | diff --git a/lending/docs/Models/Components/AccountingInvoiceDataType.md b/lending/docs/Models/Components/AccountingInvoiceDataType.md index 278ae519..8fdc053e 100644 --- a/lending/docs/Models/Components/AccountingInvoiceDataType.md +++ b/lending/docs/Models/Components/AccountingInvoiceDataType.md @@ -2,6 +2,14 @@ The underlying data type associated to the reference `id`. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = AccountingInvoiceDataType.SalesOrders; +``` + ## Values diff --git a/lending/docs/Models/Components/AccountingJournal.md b/lending/docs/Models/Components/AccountingJournal.md index 12cfc488..3ddb9963 100644 --- a/lending/docs/Models/Components/AccountingJournal.md +++ b/lending/docs/Models/Components/AccountingJournal.md @@ -27,14 +27,14 @@ Multiple journals or subjournals are used in the following Codat integrations: | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Journal ID. | | | `JournalCode` | *string* | :heavy_minus_sign: | Native journal number or code. | | | `Name` | *string* | :heavy_minus_sign: | Journal name.
The maximum length for a journal name is 256 characters. All characters above that number will be truncated. | | | `Type` | *string* | :heavy_minus_sign: | The type of the journal. | | | `ParentId` | *string* | :heavy_minus_sign: | Parent journal ID.
If the journal is a parent journal, this value is not present. | | | `HasChildren` | *bool* | :heavy_minus_sign: | If the journal has child journals, this value is true. If it doesn’t, it is false. | | -| `CreatedOn` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `CreatedOn` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Status` | [JournalStatus](../../Models/Components/JournalStatus.md) | :heavy_minus_sign: | Current journal status. | | | `Metadata` | [Metadata](../../Models/Components/Metadata.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/Models/Components/AccountingJournalEntry.md b/lending/docs/Models/Components/AccountingJournalEntry.md index 1c8fa5a8..8b979a95 100644 --- a/lending/docs/Models/Components/AccountingJournalEntry.md +++ b/lending/docs/Models/Components/AccountingJournalEntry.md @@ -26,13 +26,13 @@ In Codat a journal entry contains details of: | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Unique identifier of the journal entry for the company in the accounting software. | | | `Description` | *string* | :heavy_minus_sign: | Optional description of the journal entry. | | -| `PostedOn` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `CreatedOn` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `UpdatedOn` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `PostedOn` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `CreatedOn` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `UpdatedOn` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `JournalRef` | [JournalRef](../../Models/Components/JournalRef.md) | :heavy_minus_sign: | Links journal entries to the relevant journal in accounting integrations that use multi-book accounting (multiple journals). | | | `JournalLines` | List<[JournalLine](../../Models/Components/JournalLine.md)> | :heavy_minus_sign: | An array of journal lines. | | | `RecordRef` | [JournalEntryRecordRef](../../Models/Components/JournalEntryRecordRef.md) | :heavy_minus_sign: | Links a journal entry to the underlying record that created it. | | diff --git a/lending/docs/Models/Components/AccountingPayment.md b/lending/docs/Models/Components/AccountingPayment.md index 511112a1..58e5daaa 100644 --- a/lending/docs/Models/Components/AccountingPayment.md +++ b/lending/docs/Models/Components/AccountingPayment.md @@ -682,16 +682,16 @@ In this example, a payment on account is used to pay the same invoice in January | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Identifier for the payment, unique to the company in the accounting software. | | | `CustomerRef` | [AccountingCustomerRef](../../Models/Components/AccountingCustomerRef.md) | :heavy_minus_sign: | N/A | | | `AccountRef` | [AccountRef](../../Models/Components/AccountRef.md) | :heavy_minus_sign: | Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account. | {
"Example": {
"value": {
"accountRef": {
"id": "4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a",
"name": "Business Current Account"
}
}
}
} | | `PaymentMethodRef` | [PaymentMethodRef](../../Models/Components/PaymentMethodRef.md) | :heavy_minus_sign: | The payment method the record is linked to in the accounting or commerce software. | {
"id": "EILBDVJVNUAGVKRQ",
"name": "AliPay"
} | | `TotalAmount` | *decimal* | :heavy_minus_sign: | Amount of the payment in the payment currency. This value should never change and represents the amount of money paid into the customer's account. | | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `CurrencyRate` | *decimal* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting software, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \|


### Integration-specific details

\| Integration \| Scenario \| System behavior \|
\|-------------------\|-------------------------------------------------\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------\|
\| QuickBooks Online \| Transaction currency differs from base currency \| If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, specify a currencyRate in the request body. \| | | -| `Date` | *string* | :heavy_check_mark: | 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. | 2022-10-23T00:00:00Z | +| `Date` | *string* | :heavy_check_mark: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Note` | *string* | :heavy_minus_sign: | Any additional information associated with the payment. | | | `Lines` | List<[PaymentLine](../../Models/Components/PaymentLine.md)> | :heavy_minus_sign: | An array of payment lines. | | | `Reference` | *string* | :heavy_minus_sign: | Friendly reference for the payment. | | diff --git a/lending/docs/Models/Components/AccountingProfitAndLossReport.md b/lending/docs/Models/Components/AccountingProfitAndLossReport.md index a9758f67..9ec61b98 100644 --- a/lending/docs/Models/Components/AccountingProfitAndLossReport.md +++ b/lending/docs/Models/Components/AccountingProfitAndLossReport.md @@ -29,5 +29,5 @@ Our [Enhanced Financials](https://docs.codat.io/lending/features/financial-state | `Reports` | List<[ProfitAndLossReport](../../Models/Components/ProfitAndLossReport.md)> | :heavy_check_mark: | An array of profit and loss reports. | | | `ReportBasis` | [ReportBasis](../../Models/Components/ReportBasis.md) | :heavy_check_mark: | The basis of a report. | | | `Currency` | *string* | :heavy_minus_sign: | Base currency of the company in which the profit and loss report is presented. | | -| `MostRecentAvailableMonth` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `EarliestAvailableMonth` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `MostRecentAvailableMonth` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `EarliestAvailableMonth` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/AccountingRecordRef.md b/lending/docs/Models/Components/AccountingRecordRef.md index dab67ff2..8ecd82c6 100644 --- a/lending/docs/Models/Components/AccountingRecordRef.md +++ b/lending/docs/Models/Components/AccountingRecordRef.md @@ -7,7 +7,7 @@ For example, if a journal entry is generated based on an invoice, this property ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | ------------------------------------------- | -| `Id` | *string* | :heavy_minus_sign: | 'id' of the underlying record or data type. | | -| `DataType` | *string* | :heavy_minus_sign: | Allowed name of the 'dataType'. | journalEntry | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | +| `Id` | *string* | :heavy_minus_sign: | 'id' of the underlying record or data type. | | +| `DataType` | *string* | :heavy_minus_sign: | Allowed name of the 'dataType'. | **Example 1:** journalEntry
**Example 2:** invoice
**Example 3:** accountTransaction
**Example 4:** transfer | \ No newline at end of file diff --git a/lending/docs/Models/Components/AccountingSupplier.md b/lending/docs/Models/Components/AccountingSupplier.md index 7ef5478c..8322542e 100644 --- a/lending/docs/Models/Components/AccountingSupplier.md +++ b/lending/docs/Models/Components/AccountingSupplier.md @@ -9,13 +9,13 @@ From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Identifier for the supplier, unique to the company in the accounting software. | | | `SupplierName` | *string* | :heavy_minus_sign: | Name of the supplier as recorded in the accounting system, typically the company name. | | | `ContactName` | *string* | :heavy_minus_sign: | Name of the main contact for the supplier. | | | `EmailAddress` | *string* | :heavy_minus_sign: | Email address that the supplier may be contacted on. | | -| `Phone` | *string* | :heavy_minus_sign: | Phone number that the supplier may be contacted on. | +44 25691 154789 | +| `Phone` | *string* | :heavy_minus_sign: | Phone number that the supplier may be contacted on. | **Example 1:** +44 25691 154789
**Example 2:** (877) 492-8687
**Example 3:** 01224 658 999 | | `Addresses` | List<[AccountingAddress](../../Models/Components/AccountingAddress.md)> | :heavy_minus_sign: | An array of Addresses. | | | `RegistrationNumber` | *string* | :heavy_minus_sign: | Company number of the supplier. In the UK, this is typically the company registration number issued by Companies House. | | | `TaxNumber` | *string* | :heavy_minus_sign: | Supplier's company tax number. | | diff --git a/lending/docs/Models/Components/AccountingTransfer.md b/lending/docs/Models/Components/AccountingTransfer.md index 099859fd..326d8ccb 100644 --- a/lending/docs/Models/Components/AccountingTransfer.md +++ b/lending/docs/Models/Components/AccountingTransfer.md @@ -7,12 +7,12 @@ A transfer records the movement of money between two bank accounts, or between a | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | Unique identifier for the transfer. | | | `Description` | *string* | :heavy_minus_sign: | Description of the transfer. | | | `ContactRef` | [ContactRef](../../Models/Components/ContactRef.md) | :heavy_minus_sign: | N/A | | -| `Date` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `Date` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `From` | [TransferAccount](../../Models/Components/TransferAccount.md) | :heavy_minus_sign: | Account details of the account sending or receiving the transfer. | | | `To` | [TransferAccount](../../Models/Components/TransferAccount.md) | :heavy_minus_sign: | Account details of the account sending or receiving the transfer. | | | `Status` | [AccountingTransferStatus](../../Models/Components/AccountingTransferStatus.md) | :heavy_minus_sign: | The status of the transfer in the account | | diff --git a/lending/docs/Models/Components/AccountingTransferStatus.md b/lending/docs/Models/Components/AccountingTransferStatus.md index 573466d6..fb30d6c6 100644 --- a/lending/docs/Models/Components/AccountingTransferStatus.md +++ b/lending/docs/Models/Components/AccountingTransferStatus.md @@ -2,6 +2,14 @@ The status of the transfer in the account +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = AccountingTransferStatus.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/Accounts.md b/lending/docs/Models/Components/Accounts.md index c1aa4b8c..bd1608c5 100644 --- a/lending/docs/Models/Components/Accounts.md +++ b/lending/docs/Models/Components/Accounts.md @@ -10,5 +10,5 @@ | `AccountProvider` | *string* | :heavy_minus_sign: | The bank or other financial institution providing the account. | | | `AccountName` | *string* | :heavy_minus_sign: | The name of the account according to the provider. | | | `AccountType` | *string* | :heavy_minus_sign: | The type of banking account, e.g. credit or debit. | | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `CurrentBalance` | *decimal* | :heavy_minus_sign: | The balance of the bank account. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/AgedCurrencyOutstanding.md b/lending/docs/Models/Components/AgedCurrencyOutstanding.md index c0cdf1b1..cba471e8 100644 --- a/lending/docs/Models/Components/AgedCurrencyOutstanding.md +++ b/lending/docs/Models/Components/AgedCurrencyOutstanding.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `AgedOutstandingAmounts` | List<[AgedOutstandingAmount](../../Models/Components/AgedOutstandingAmount.md)> | :heavy_minus_sign: | Array of outstanding amounts by period. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/AgedOutstandingAmount.md b/lending/docs/Models/Components/AgedOutstandingAmount.md index b6c38282..e3e4457f 100644 --- a/lending/docs/Models/Components/AgedOutstandingAmount.md +++ b/lending/docs/Models/Components/AgedOutstandingAmount.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `FromDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `ToDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `FromDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `ToDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Amount` | *decimal* | :heavy_minus_sign: | The amount outstanding. | | | `Details` | List<[AgedOutstandingAmountDetail](../../Models/Components/AgedOutstandingAmountDetail.md)> | :heavy_minus_sign: | Array of details. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/Allocation.md b/lending/docs/Models/Components/Allocation.md index 984112a4..d3bdba6e 100644 --- a/lending/docs/Models/Components/Allocation.md +++ b/lending/docs/Models/Components/Allocation.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `CurrencyRate` | *decimal* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting software, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \|


### Integration-specific details

\| Integration \| Scenario \| System behavior \|
\|-------------------\|-------------------------------------------------\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------\|
\| QuickBooks Online \| Transaction currency differs from base currency \| If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, specify a currencyRate in the request body. \| | | -| `AllocatedOnDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `AllocatedOnDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `TotalAmount` | *decimal* | :heavy_minus_sign: | The total amount that has been allocated. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/BalanceSheet.md b/lending/docs/Models/Components/BalanceSheet.md index 960b200a..0912fe1d 100644 --- a/lending/docs/Models/Components/BalanceSheet.md +++ b/lending/docs/Models/Components/BalanceSheet.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Date` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `Date` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Assets` | [ReportLine](../../Models/Components/ReportLine.md) | :heavy_minus_sign: | N/A | | | `Liabilities` | [ReportLine](../../Models/Components/ReportLine.md) | :heavy_minus_sign: | N/A | | | `NetAssets` | *decimal* | :heavy_check_mark: | Value of net assets for a company in their base currency. | | diff --git a/lending/docs/Models/Components/BankAccountStatus.md b/lending/docs/Models/Components/BankAccountStatus.md index 4ae20d42..e3b3767e 100644 --- a/lending/docs/Models/Components/BankAccountStatus.md +++ b/lending/docs/Models/Components/BankAccountStatus.md @@ -2,6 +2,14 @@ Status of the bank account. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = BankAccountStatus.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/BankFeedBankAccountMapping.md b/lending/docs/Models/Components/BankFeedBankAccountMapping.md index e8a25fdb..4845f0fd 100644 --- a/lending/docs/Models/Components/BankFeedBankAccountMapping.md +++ b/lending/docs/Models/Components/BankFeedBankAccountMapping.md @@ -7,4 +7,4 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `SourceAccountId` | *string* | :heavy_check_mark: | Unique ID for the source account | | | `TargetAccountId` | *string* | :heavy_minus_sign: | Unique ID for the target account | | -| `FeedStartDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `FeedStartDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/BankFeedMapping.md b/lending/docs/Models/Components/BankFeedMapping.md index bdf1c0e1..d0dcccd0 100644 --- a/lending/docs/Models/Components/BankFeedMapping.md +++ b/lending/docs/Models/Components/BankFeedMapping.md @@ -11,9 +11,9 @@ A bank feed connection between a source account and a target account, including | `SourceAccountName` | *string* | :heavy_minus_sign: | Name for the source account. | | | `SourceAccountNumber` | *string* | :heavy_minus_sign: | Account number for the source account. | | | `SourceBalance` | *decimal* | :heavy_minus_sign: | Balance for the source account. | | -| `SourceCurrency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `SourceCurrency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `TargetAccountId` | *string* | :heavy_minus_sign: | Unique ID for the target account in the accounting software. | | | `TargetAccountName` | *string* | :heavy_minus_sign: | Name for the target account in the accounting software. | | | `Status` | *string* | :heavy_minus_sign: | The status. | | | `TargetAccountOptions` | List<[TargetAccountOption](../../Models/Components/TargetAccountOption.md)> | :heavy_minus_sign: | An array of potential target accounts. | | -| `FeedStartDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `FeedStartDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/BankTransactionType.md b/lending/docs/Models/Components/BankTransactionType.md index 749fe41b..37743a67 100644 --- a/lending/docs/Models/Components/BankTransactionType.md +++ b/lending/docs/Models/Components/BankTransactionType.md @@ -2,6 +2,14 @@ Type of transaction for the bank statement line. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = BankTransactionType.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/BankingAccount.md b/lending/docs/Models/Components/BankingAccount.md index 76cdafe6..f3b778ad 100644 --- a/lending/docs/Models/Components/BankingAccount.md +++ b/lending/docs/Models/Components/BankingAccount.md @@ -9,8 +9,8 @@ Responses are paged, so you should provide `page` and `pageSize` query parameter | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_check_mark: | The ID of the account from the provider. | | | `Name` | *string* | :heavy_check_mark: | The name of the account according to the provider. | | | `InformalName` | *string* | :heavy_minus_sign: | The friendly name of the account, chosen by the holder. This may not have been set by the account holder and therefore is not always available. | | diff --git a/lending/docs/Models/Components/BankingAccountBalance.md b/lending/docs/Models/Components/BankingAccountBalance.md index 3419338a..41407ccf 100644 --- a/lending/docs/Models/Components/BankingAccountBalance.md +++ b/lending/docs/Models/Components/BankingAccountBalance.md @@ -15,8 +15,8 @@ Responses are paged, so you should provide `page` and `pageSize` query parameter | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `AccountId` | *string* | :heavy_check_mark: | The unique identifier of the account. | | | `Balance` | [AccountBalanceAmounts](../../Models/Components/AccountBalanceAmounts.md) | :heavy_check_mark: | Depending on the data provided by the underlying bank, not all balances are always available. | | -| `Date` | *string* | :heavy_check_mark: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `Date` | *string* | :heavy_check_mark: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/BankingTransaction.md b/lending/docs/Models/Components/BankingTransaction.md index 5416a267..e3fc620c 100644 --- a/lending/docs/Models/Components/BankingTransaction.md +++ b/lending/docs/Models/Components/BankingTransaction.md @@ -9,15 +9,15 @@ Responses are paged, so you should provide `page` and `pageSize` query parameter | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_check_mark: | The unique identifier of the bank transaction. | | | `AccountId` | *string* | :heavy_check_mark: | The unique identifier of the bank account. | | | `Description` | *string* | :heavy_minus_sign: | The description of the bank transaction. | | | `Amount` | *decimal* | :heavy_minus_sign: | The amount of the bank transaction. | | | `Currency` | *string* | :heavy_check_mark: | The currency of the bank transaction. | | -| `PostedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `AuthorizedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `PostedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `AuthorizedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Code` | [TransactionCode](../../Models/Components/TransactionCode.md) | :heavy_minus_sign: | Code to identify the underlying transaction. | | | `MerchantName` | *string* | :heavy_minus_sign: | The name of the merchant. | | | `TransactionCategoryRef` | [TransactionCategoryRef](../../Models/Components/TransactionCategoryRef.md) | :heavy_minus_sign: | An object of bank transaction category reference data. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/BankingTransactionCategory.md b/lending/docs/Models/Components/BankingTransactionCategory.md index 4c2f8fa7..bd53aad8 100644 --- a/lending/docs/Models/Components/BankingTransactionCategory.md +++ b/lending/docs/Models/Components/BankingTransactionCategory.md @@ -9,8 +9,8 @@ Responses are paged, so you should provide `page` and `pageSize` query parameter | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_check_mark: | The unique identifier of the bank transaction category. | | | `Name` | *string* | :heavy_check_mark: | The name of the bank transaction category. | | | `ParentId` | *string* | :heavy_minus_sign: | The unique identifier of the parent bank transaction category. | | diff --git a/lending/docs/Models/Components/BankingTransactionRef.md b/lending/docs/Models/Components/BankingTransactionRef.md index af6f5ba1..44e30f23 100644 --- a/lending/docs/Models/Components/BankingTransactionRef.md +++ b/lending/docs/Models/Components/BankingTransactionRef.md @@ -9,6 +9,6 @@ | `DataConnectionId` | *string* | :heavy_minus_sign: | Unique identifier of the bank transaction's connection. | | | `AccountId` | *string* | :heavy_minus_sign: | Unique identifier of the bank transaction's account. | | | `AccountName` | *string* | :heavy_minus_sign: | Name given to account. | | -| `Date` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `Date` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Description` | *string* | :heavy_minus_sign: | Description given to bank transaction. | | | `Amount` | *decimal* | :heavy_minus_sign: | Bank transaction amount. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/BillCreditNoteStatus.md b/lending/docs/Models/Components/BillCreditNoteStatus.md index 95081e93..61a8f1f2 100644 --- a/lending/docs/Models/Components/BillCreditNoteStatus.md +++ b/lending/docs/Models/Components/BillCreditNoteStatus.md @@ -2,6 +2,14 @@ Current state of the bill credit note +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = BillCreditNoteStatus.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/BillLineItemDataType.md b/lending/docs/Models/Components/BillLineItemDataType.md index f4098b20..059baadb 100644 --- a/lending/docs/Models/Components/BillLineItemDataType.md +++ b/lending/docs/Models/Components/BillLineItemDataType.md @@ -2,6 +2,14 @@ Allowed name of the 'dataType'. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = BillLineItemDataType.PurchaseOrders; +``` + ## Values diff --git a/lending/docs/Models/Components/BillPaymentLine.md b/lending/docs/Models/Components/BillPaymentLine.md index 2abf2479..5fdb43fe 100644 --- a/lending/docs/Models/Components/BillPaymentLine.md +++ b/lending/docs/Models/Components/BillPaymentLine.md @@ -7,4 +7,4 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Amount` | *decimal* | :heavy_check_mark: | Amount in the bill payment currency. | | | `Links` | List<[BillPaymentLineLink](../../Models/Components/BillPaymentLineLink.md)> | :heavy_minus_sign: | N/A | | -| `AllocatedOnDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `AllocatedOnDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/BillPaymentLineLinkType.md b/lending/docs/Models/Components/BillPaymentLineLinkType.md index 19d156f3..9d45ba7c 100644 --- a/lending/docs/Models/Components/BillPaymentLineLinkType.md +++ b/lending/docs/Models/Components/BillPaymentLineLinkType.md @@ -2,6 +2,14 @@ Types of links to bill payment lines. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = BillPaymentLineLinkType.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/BillStatus.md b/lending/docs/Models/Components/BillStatus.md index 6b630d7a..89368dbe 100644 --- a/lending/docs/Models/Components/BillStatus.md +++ b/lending/docs/Models/Components/BillStatus.md @@ -2,6 +2,14 @@ Current state of the bill. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = BillStatus.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/BilledToType.md b/lending/docs/Models/Components/BilledToType.md index 8f24354b..17de5fde 100644 --- a/lending/docs/Models/Components/BilledToType.md +++ b/lending/docs/Models/Components/BilledToType.md @@ -2,6 +2,14 @@ Defines if the invoice or credit note is billed/rebilled to a project or customer. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = BilledToType.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/BilledToType1.md b/lending/docs/Models/Components/BilledToType1.md index 280ec527..39f08ee0 100644 --- a/lending/docs/Models/Components/BilledToType1.md +++ b/lending/docs/Models/Components/BilledToType1.md @@ -2,6 +2,14 @@ Defines if the bill or bill credit note is billed/rebilled to a project. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = BilledToType1.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/CashFlowStatement.md b/lending/docs/Models/Components/CashFlowStatement.md index 5ca3553f..32174a1e 100644 --- a/lending/docs/Models/Components/CashFlowStatement.md +++ b/lending/docs/Models/Components/CashFlowStatement.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `FromDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `ToDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `FromDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `ToDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `CashReceipts` | [ReportLine](../../Models/Components/ReportLine.md) | :heavy_minus_sign: | N/A | | | `CashPayments` | [ReportLine](../../Models/Components/ReportLine.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/Models/Components/CashFlowTransaction.md b/lending/docs/Models/Components/CashFlowTransaction.md index 33ba6e46..137905a3 100644 --- a/lending/docs/Models/Components/CashFlowTransaction.md +++ b/lending/docs/Models/Components/CashFlowTransaction.md @@ -6,14 +6,14 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Id` | *string* | :heavy_minus_sign: | The unique identifier of the bank transaction. | | -| `Date` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `Date` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Description` | *string* | :heavy_minus_sign: | The description of the bank transaction. | | | `Amount` | *decimal* | :heavy_minus_sign: | The bank transaction amount. | | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `TransactionCategory` | [TransactionCategory](../../Models/Components/TransactionCategory.md) | :heavy_minus_sign: | N/A | {
"Example": {
"value": {
"transactionCategory": {
"confidence": 92.7,
"levels": [
"Asset",
"Current",
"Bank",
"BankTransfers",
"ShareholderTransfers"
],
"confidences": [
92.7,
95,
96,
97.5,
100
]
}
}
}
} | | `PlatformName` | *string* | :heavy_minus_sign: | Returns the payment processor responsible for the transaction. | | | `CounterpartyNames` | List<*string*> | :heavy_minus_sign: | An array of counterparty names involved in the transaction. | | | `SourceRef` | [SourceRef](../../Models/Components/SourceRef.md) | :heavy_minus_sign: | A source reference containing the `sourceType` object "Banking". | {
"Example": {
"value": {
"sourceRef": {
"sourceType": "Banking"
}
}
}
} | | `AccountRef` | [AccountRef](../../Models/Components/AccountRef.md) | :heavy_minus_sign: | An account reference containing the account id and name. | {
"Example": {
"value": {
"accountRef": {
"id": "4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a",
"name": "Business Current Account"
}
}
}
} | -| `ModifiedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `IsRecurring` | *bool* | :heavy_minus_sign: | Indicates if the transaction is classified as recurring by Codat's categorization engine. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/ClientRateLimitWebhook.md b/lending/docs/Models/Components/ClientRateLimitWebhook.md index 22d3edca..b5ded115 100644 --- a/lending/docs/Models/Components/ClientRateLimitWebhook.md +++ b/lending/docs/Models/Components/ClientRateLimitWebhook.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Id` | *string* | :heavy_minus_sign: | Unique identifier of the event. | 743ec94a-8aa4-44bb-8bd4-e1855ee0e74b | -| `EventType` | *string* | :heavy_minus_sign: | The type of event. | client.rateLimit.reset | -| `GeneratedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `EventType` | *string* | :heavy_minus_sign: | The type of event. | **Example 1:** client.rateLimit.reset
**Example 2:** client.rateLimit.reached | +| `GeneratedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Payload` | [ClientRateLimitWebhookPayload](../../Models/Components/ClientRateLimitWebhookPayload.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/Models/Components/ClientRateLimitWebhookPayload.md b/lending/docs/Models/Components/ClientRateLimitWebhookPayload.md index 5cd8406a..ba853889 100644 --- a/lending/docs/Models/Components/ClientRateLimitWebhookPayload.md +++ b/lending/docs/Models/Components/ClientRateLimitWebhookPayload.md @@ -7,4 +7,4 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `DailyQuota` | *long* | :heavy_minus_sign: | The number of available requests per day. | | | `QuotaRemaining` | *long* | :heavy_minus_sign: | Total number of requests remaining for your client. | | -| `ExpiryDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `ExpiryDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/CommerceAddressType.md b/lending/docs/Models/Components/CommerceAddressType.md index 1ea5a370..32f309e5 100644 --- a/lending/docs/Models/Components/CommerceAddressType.md +++ b/lending/docs/Models/Components/CommerceAddressType.md @@ -2,6 +2,14 @@ The type of the address +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = CommerceAddressType.Billing; +``` + ## Values diff --git a/lending/docs/Models/Components/CommerceCompanyInfo.md b/lending/docs/Models/Components/CommerceCompanyInfo.md index a8b6ba5b..85b6068f 100644 --- a/lending/docs/Models/Components/CommerceCompanyInfo.md +++ b/lending/docs/Models/Components/CommerceCompanyInfo.md @@ -9,8 +9,8 @@ a linked company, such as their address, phone number, and company registration. | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `CompanyName` | *string* | :heavy_minus_sign: | The name of the company | Codat | | `CommercePlatformRef` | *string* | :heavy_minus_sign: | Identifier or reference for the company in the commerce software | | | `CompanyLegalName` | *string* | :heavy_minus_sign: | The full legal name of the company | Codat Limited | @@ -18,7 +18,7 @@ a linked company, such as their address, phone number, and company registration. | `PhoneNumbers` | List<[PhoneNumber](../../Models/Components/PhoneNumber.md)> | :heavy_minus_sign: | Phone numbers associated with the company | | | `WebLinks` | List<[WebLink](../../Models/Components/WebLink.md)> | :heavy_minus_sign: | Weblinks associated with the company | | | `RegistrationNumber` | *string* | :heavy_minus_sign: | The registration number of the company | 10480375 | -| `BaseCurrency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `BaseCurrency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `AccountBalances` | List<[AccountBalance](../../Models/Components/AccountBalance.md)> | :heavy_minus_sign: | The available and current cash balances for the company's accounts | | | `SourceUrls` | Dictionary | :heavy_minus_sign: | URL addresses for the originating system. For example, potential use cases include 'deeplinking' to the originating system | {
"url1": "https://connect.sandbox.com/v2/customers",
"url2": "https://connect.sandbox.com/v2/disputes"
} | -| `CreatedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `CreatedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/CommerceCustomer.md b/lending/docs/Models/Components/CommerceCustomer.md index 773d6588..e145a8fb 100644 --- a/lending/docs/Models/Components/CommerceCustomer.md +++ b/lending/docs/Models/Components/CommerceCustomer.md @@ -7,13 +7,13 @@ When a customer places an order with the connected commerce store their details | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `Id` | *string* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `Id` | *string* | :heavy_check_mark: | A unique, persistent identifier for this record | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | | `CustomerName` | *string* | :heavy_minus_sign: | Name of the customer | Fred Smith | | `EmailAddress` | *string* | :heavy_minus_sign: | Email address of the customer | fred.smith@myCompany.com | -| `Phone` | *string* | :heavy_minus_sign: | A phone number. | +44 25691 154789 | -| `DefaultCurrency` | *string* | :heavy_minus_sign: | N/A | GBP | +| `Phone` | *string* | :heavy_minus_sign: | A phone number. | **Example 1:** +44 25691 154789
**Example 2:** (877) 492-8687
**Example 3:** 01224 658 999 | +| `DefaultCurrency` | *string* | :heavy_minus_sign: | N/A | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `Addresses` | List<[CommerceAddress](../../Models/Components/CommerceAddress.md)> | :heavy_minus_sign: | Addresses of the customer | | | `Note` | *string* | :heavy_minus_sign: | Any additional information about the customer | | -| `CreatedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `CreatedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/CommerceCustomerRef.md b/lending/docs/Models/Components/CommerceCustomerRef.md index 2e0421d4..cc5d8e9e 100644 --- a/lending/docs/Models/Components/CommerceCustomerRef.md +++ b/lending/docs/Models/Components/CommerceCustomerRef.md @@ -5,7 +5,7 @@ Reference to the customer that placed the order. ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | -| `Id` | *string* | :heavy_check_mark: | The unique identitifer of the customer being referenced | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `Name` | *string* | :heavy_minus_sign: | Name of the customer being referenced. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `Id` | *string* | :heavy_check_mark: | The unique identitifer of the customer being referenced | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `Name` | *string* | :heavy_minus_sign: | Name of the customer being referenced. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/CommerceDispute.md b/lending/docs/Models/Components/CommerceDispute.md index 6c8029a8..0eec89b1 100644 --- a/lending/docs/Models/Components/CommerceDispute.md +++ b/lending/docs/Models/Components/CommerceDispute.md @@ -12,13 +12,13 @@ You can use data from the Disputes endpoints to calculate key metrics, such as t | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `Id` | *string* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `Id` | *string* | :heavy_check_mark: | A unique, persistent identifier for this record | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | | `DisputedTransactions` | List<[TransactionSourceRef](../../Models/Components/TransactionSourceRef.md)> | :heavy_minus_sign: | Link to the source event(s) which triggered this transaction. | | -| `TotalAmount` | *object* | :heavy_minus_sign: | Total transaction amount that is under dispute. | 194.12 | -| `Currency` | *string* | :heavy_check_mark: | 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. | GBP | +| `TotalAmount` | *object* | :heavy_minus_sign: | Total transaction amount that is under dispute. | **Example 1:** 194.12
**Example 2:** -283.56
**Example 3:** 0 | +| `Currency` | *string* | :heavy_check_mark: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `Status` | [DisputeStatus](../../Models/Components/DisputeStatus.md) | :heavy_minus_sign: | Current status of the dispute | EvidenceRequired | | `Reason` | *string* | :heavy_minus_sign: | Reason for the dispute | Unhappy with product | -| `DueDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `CreatedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `DueDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `CreatedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/CommerceLocation.md b/lending/docs/Models/Components/CommerceLocation.md index 1d6ba48c..b34fa18e 100644 --- a/lending/docs/Models/Components/CommerceLocation.md +++ b/lending/docs/Models/Components/CommerceLocation.md @@ -7,10 +7,10 @@ A Location also holds information on geographic locations where orders were plac ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `Id` | *string* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `Name` | *string* | :heavy_minus_sign: | Name of this location | | -| `Address` | [CommerceAddress](../../Models/Components/CommerceAddress.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `Id` | *string* | :heavy_check_mark: | A unique, persistent identifier for this record | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `Name` | *string* | :heavy_minus_sign: | Name of this location | | +| `Address` | [CommerceAddress](../../Models/Components/CommerceAddress.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/Models/Components/CommerceOrder.md b/lending/docs/Models/Components/CommerceOrder.md index 11e47b69..54ea66f3 100644 --- a/lending/docs/Models/Components/CommerceOrder.md +++ b/lending/docs/Models/Components/CommerceOrder.md @@ -8,13 +8,13 @@ Orders contain the transaction details for all products sold by the company, and | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `Id` | *string* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `Id` | *string* | :heavy_check_mark: | A unique, persistent identifier for this record | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | | `OrderNumber` | *string* | :heavy_minus_sign: | Friendly reference for the order in the commerce or point of sale platform. | | -| `Country` | *string* | :heavy_minus_sign: | The Codat country property is returned as it was provided in the underlying platform by the company without any formatting on our part.

Depending on the platform the value of this property will either be an ISO 3166 code (2-alpha or 3-alpha) or free-form text returned as a string name in our model.

For POST operations against platforms that demand a specific format for the country code, we have documented accepted values in the [options](https://docs.codat.io/lending-api#/operations/get-companies-companyId-connections-connectionId-push) endpoint. | GBR | -| `Currency` | *string* | :heavy_minus_sign: | N/A | GBP | -| `ClosedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `Country` | *string* | :heavy_minus_sign: | The Codat country property is returned as it was provided in the underlying platform by the company without any formatting on our part.

Depending on the platform the value of this property will either be an ISO 3166 code (2-alpha or 3-alpha) or free-form text returned as a string name in our model.

For POST operations against platforms that demand a specific format for the country code, we have documented accepted values in the [options](https://docs.codat.io/lending-api#/operations/get-companies-companyId-connections-connectionId-push) endpoint. | **Example 1:** GBR
**Example 2:** USA
**Example 3:** ABW | +| `Currency` | *string* | :heavy_minus_sign: | N/A | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | +| `ClosedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `TotalAmount` | *decimal* | :heavy_minus_sign: | Total amount of the order, including discounts, refunds, and tax, but excluding gratuities. | | | `TotalRefund` | *decimal* | :heavy_minus_sign: | Total amount of any refunds issued on the order, including discounts and tax, but excluding gratuities. This is always negative. | | | `TotalTaxAmount` | *decimal* | :heavy_minus_sign: | Total amount of tax applied to the order. | | @@ -26,4 +26,4 @@ Orders contain the transaction details for all products sold by the company, and | `LocationRef` | [LocationRef](../../Models/Components/LocationRef.md) | :heavy_minus_sign: | Reference to the geographic location where the order was placed. | | | `CustomerRef` | [CommerceCustomerRef](../../Models/Components/CommerceCustomerRef.md) | :heavy_minus_sign: | Reference to the customer that placed the order. | | | `SupplementalData` | [SupplementalData](../../Models/Components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | -| `CreatedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `CreatedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/CommercePayment.md b/lending/docs/Models/Components/CommercePayment.md index 5be6264a..dc14a766 100644 --- a/lending/docs/Models/Components/CommercePayment.md +++ b/lending/docs/Models/Components/CommercePayment.md @@ -11,14 +11,14 @@ You can use data from the Payments endpoints to calculate key metrics, such as g | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `Id` | *string* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `Amount` | *decimal* | :heavy_minus_sign: | Payment Amount (including gratuity) | 194.12 | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `Id` | *string* | :heavy_check_mark: | A unique, persistent identifier for this record | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `Amount` | *decimal* | :heavy_minus_sign: | Payment Amount (including gratuity) | **Example 1:** 194.12
**Example 2:** -283.56
**Example 3:** 0 | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `PaymentMethodRef` | [PaymentMethodRef](../../Models/Components/PaymentMethodRef.md) | :heavy_minus_sign: | The payment method the record is linked to in the accounting or commerce software. | {
"id": "EILBDVJVNUAGVKRQ",
"name": "AliPay"
} | | `Status` | [PaymentStatus](../../Models/Components/PaymentStatus.md) | :heavy_minus_sign: | Status of the payment. | | -| `PaymentProvider` | *string* | :heavy_minus_sign: | Service provider of the payment, if applicable. | Amazon Pay | -| `DueDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `PaymentProvider` | *string* | :heavy_minus_sign: | Service provider of the payment, if applicable. | **Example 1:** Amazon Pay
**Example 2:** Checkout.com
**Example 3:** SagePay | +| `DueDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `SupplementalData` | [SupplementalData](../../Models/Components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | -| `CreatedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `CreatedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/CommercePaymentMethod.md b/lending/docs/Models/Components/CommercePaymentMethod.md index 534851f5..4250c2db 100644 --- a/lending/docs/Models/Components/CommercePaymentMethod.md +++ b/lending/docs/Models/Components/CommercePaymentMethod.md @@ -5,10 +5,10 @@ A Payment Method represents the payment method(s) used to make payments. ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `Id` | *string* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `Name` | *string* | :heavy_minus_sign: | The name of the PaymentMethod | Alipay | -| `Status` | [CommercePaymentMethodStatus](../../Models/Components/CommercePaymentMethodStatus.md) | :heavy_minus_sign: | Status of the Payment Method. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `Id` | *string* | :heavy_check_mark: | A unique, persistent identifier for this record | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `Name` | *string* | :heavy_minus_sign: | The name of the PaymentMethod | Alipay | +| `Status` | [CommercePaymentMethodStatus](../../Models/Components/CommercePaymentMethodStatus.md) | :heavy_minus_sign: | Status of the Payment Method. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/CommercePaymentMethodStatus.md b/lending/docs/Models/Components/CommercePaymentMethodStatus.md index d8abdbb7..2be95240 100644 --- a/lending/docs/Models/Components/CommercePaymentMethodStatus.md +++ b/lending/docs/Models/Components/CommercePaymentMethodStatus.md @@ -2,6 +2,14 @@ Status of the Payment Method. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = CommercePaymentMethodStatus.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/CommerceProduct.md b/lending/docs/Models/Components/CommerceProduct.md index 7b933e04..9b5be433 100644 --- a/lending/docs/Models/Components/CommerceProduct.md +++ b/lending/docs/Models/Components/CommerceProduct.md @@ -8,10 +8,10 @@ A Product is an item in the company's inventory, and includes information about | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Id` | *string* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `Name` | *string* | :heavy_minus_sign: | Name of the product in the commerce or POS system | Hard Drive | -| `Description` | *string* | :heavy_minus_sign: | Description of the product recorded in the commerce or point of sale platform. | 1tb Western Digital Hard Drive | -| `Categorization` | *string* | :heavy_minus_sign: | Retail category that the product is assigned to e.g. `Hardware`. | Hardware | +| `Id` | *string* | :heavy_check_mark: | A unique, persistent identifier for this record | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `Name` | *string* | :heavy_minus_sign: | Name of the product in the commerce or POS system | **Example 1:** Hard Drive
**Example 2:** Windows Installation
**Example 3:** Software Support (Hourly) | +| `Description` | *string* | :heavy_minus_sign: | Description of the product recorded in the commerce or point of sale platform. | **Example 1:** 1tb Western Digital Hard Drive
**Example 2:** Install of Windows 11 (Professional Edition)
**Example 3:** 1 hour of support from an agent (phone or remote) | +| `Categorization` | *string* | :heavy_minus_sign: | Retail category that the product is assigned to e.g. `Hardware`. | **Example 1:** Hardware
**Example 2:** Software
**Example 3:** Support Services | | `IsGiftCard` | *bool* | :heavy_minus_sign: | Whether the product represents a gift card or voucher that
can be redeemed in the commerce or POS platform.
| | | `Variants` | List<[ProductVariant](../../Models/Components/ProductVariant.md)> | :heavy_minus_sign: | N/A | | | `SupplementalData` | [SupplementalData](../../Models/Components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/CommerceProductCategory.md b/lending/docs/Models/Components/CommerceProductCategory.md index 9ce4a675..a1c04df8 100644 --- a/lending/docs/Models/Components/CommerceProductCategory.md +++ b/lending/docs/Models/Components/CommerceProductCategory.md @@ -7,8 +7,8 @@ Product categories are used to classify a group of products together, either by | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | The unique identifier of the product category | "102" | | `Name` | *string* | :heavy_minus_sign: | The name of the product category | Entertainment | | `AncestorRefs` | List<[CommerceRecordRef](../../Models/Components/CommerceRecordRef.md)> | :heavy_minus_sign: | A collection of parent product categories implicitly ordered with the immediate parent last in the list. | | diff --git a/lending/docs/Models/Components/CommerceRecordRef.md b/lending/docs/Models/Components/CommerceRecordRef.md index 5e53f4ae..63d916ed 100644 --- a/lending/docs/Models/Components/CommerceRecordRef.md +++ b/lending/docs/Models/Components/CommerceRecordRef.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | -| `Id` | *string* | :heavy_check_mark: | The unique identitifer of the record being referenced | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `Type` | *string* | :heavy_check_mark: | The type of record being referenced. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `Id` | *string* | :heavy_check_mark: | The unique identitifer of the record being referenced | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `Type` | *string* | :heavy_check_mark: | The type of record being referenced. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/CommerceTransaction.md b/lending/docs/Models/Components/CommerceTransaction.md index 6eef3757..4a9353da 100644 --- a/lending/docs/Models/Components/CommerceTransaction.md +++ b/lending/docs/Models/Components/CommerceTransaction.md @@ -14,14 +14,14 @@ You can use data from the Transactions endpoints to calculate key metrics, such | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `CreatedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `SourceCreatedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `Id` | *string* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `TotalAmount` | *decimal* | :heavy_minus_sign: | The total transaction amount | 194.12 | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `CreatedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceCreatedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `Id` | *string* | :heavy_check_mark: | A unique, persistent identifier for this record | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `TotalAmount` | *decimal* | :heavy_minus_sign: | The total transaction amount | **Example 1:** 194.12
**Example 2:** -283.56
**Example 3:** 0 | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `Type` | [TransactionType](../../Models/Components/TransactionType.md) | :heavy_minus_sign: | The type of the platform transaction:
- `Unknown`
- `FailedPayout` — Failed transfer of funds from the seller's merchant account to their bank account.
- `Payment` — Credit and debit card payments.
- `PaymentFee` — Payment provider's fee on each card payment.
- `PaymentFeeRefund` — Payment provider's fee that has been refunded to the seller.
- `Payout` — Transfer of funds from the seller's merchant account to their bank account.
- `Refund` — Refunds to a customer's credit or debit card.
- `Transfer` — Secure transfer of funds to the seller's bank account. | | -| `SubType` | *string* | :heavy_minus_sign: | Non-standardised transaction type data from the commerce software | CardPayment | +| `SubType` | *string* | :heavy_minus_sign: | Non-standardised transaction type data from the commerce software | **Example 1:** CardPayment
**Example 2:** Invoice payment | | `TransactionSourceRef` | [TransactionSourceRef](../../Models/Components/TransactionSourceRef.md) | :heavy_minus_sign: | Link to the source event which triggered this transaction | | | `SupplementalData` | [SupplementalData](../../Models/Components/SupplementalData.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types.

It is referenced as a configured dynamic key value pair that is unique to the accounting software. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/Company.md b/lending/docs/Models/Components/Company.md index de73033f..ec23bba3 100644 --- a/lending/docs/Models/Components/Company.md +++ b/lending/docs/Models/Components/Company.md @@ -15,8 +15,8 @@ When you create a company, you can specify a `name` and we will automatically ge | `Name` | *string* | :heavy_check_mark: | The name of the company | Codat Ltd. | | `Description` | *string* | :heavy_minus_sign: | Additional information about the company. This can be used to store foreign IDs, references, etc. | Requested early access to the new financing scheme. | | `Redirect` | *string* | :heavy_check_mark: | 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. | https://link.codat.io/company/27628208-459c-46a2-a705-5641ce25f739 | -| `LastSync` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `Created` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `LastSync` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `Created` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `CreatedByUserName` | *string* | :heavy_minus_sign: | Name of user that created the company in Codat. | | | `Products` | List<*string*> | :heavy_minus_sign: | An array of products that are currently enabled for the company. | | | `Tags` | Dictionary | :heavy_minus_sign: | A collection of user-defined key-value pairs that store custom metadata against the company. | | diff --git a/lending/docs/Models/Components/Connection.md b/lending/docs/Models/Components/Connection.md index 9a9ab3f0..c8cb73dc 100644 --- a/lending/docs/Models/Components/Connection.md +++ b/lending/docs/Models/Components/Connection.md @@ -18,13 +18,13 @@ Before you can use a data connection to pull or push data, the company must gran | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Id` | *string* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | | `IntegrationId` | *string* | :heavy_check_mark: | A Codat ID representing the integration. | fd321cb6-7963-4506-b873-e99593a45e30 | -| `IntegrationKey` | *string* | :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. | | +| `IntegrationKey` | *string* | :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. | | | `SourceId` | *string* | :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 | | `SourceType` | [Models.Components.SourceType](../../Models/Components/SourceType.md) | :heavy_check_mark: | The type of platform of the connection. | Accounting | | `PlatformName` | *string* | :heavy_check_mark: | Name of integration connected to company. | | | `LinkUrl` | *string* | :heavy_check_mark: | The link URL your customers can use to authorize access to their business application. | https://link-api.codat.io/companies/86bd88cb-44ab-4dfb-b32f-87b19b14287f/connections/2e2eb431-c1fa-4dc9-93fa-d29781c12bcd/start | | `Status` | [DataConnectionStatus](../../Models/Components/DataConnectionStatus.md) | :heavy_check_mark: | The current authorization status of the data connection. | | -| `LastSync` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `Created` | *string* | :heavy_check_mark: | 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. | 2022-10-23T00:00:00Z | +| `LastSync` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `Created` | *string* | :heavy_check_mark: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `DataConnectionErrors` | List<[DataConnectionError](../../Models/Components/DataConnectionError.md)> | :heavy_minus_sign: | N/A | | | `ConnectionInfo` | Dictionary | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/Models/Components/Contact.md b/lending/docs/Models/Components/Contact.md index 41eaab62..8511d148 100644 --- a/lending/docs/Models/Components/Contact.md +++ b/lending/docs/Models/Components/Contact.md @@ -10,4 +10,4 @@ | `Phone` | List<[PhoneNumber](../../Models/Components/PhoneNumber.md)> | :heavy_minus_sign: | An array of Phone numbers. | | | `Address` | [AccountingAddress](../../Models/Components/AccountingAddress.md) | :heavy_minus_sign: | N/A | | | `Status` | [CustomerStatus](../../Models/Components/CustomerStatus.md) | :heavy_check_mark: | Status of customer. | | -| `ModifiedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `ModifiedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/ContactRefDataType.md b/lending/docs/Models/Components/ContactRefDataType.md index aab8f232..3d33fc93 100644 --- a/lending/docs/Models/Components/ContactRefDataType.md +++ b/lending/docs/Models/Components/ContactRefDataType.md @@ -2,6 +2,14 @@ Allowed name of the 'dataType'. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = ContactRefDataType.Customers; +``` + ## Values diff --git a/lending/docs/Models/Components/CreateBankAccountTransaction.md b/lending/docs/Models/Components/CreateBankAccountTransaction.md index 9e5e9535..5c93113b 100644 --- a/lending/docs/Models/Components/CreateBankAccountTransaction.md +++ b/lending/docs/Models/Components/CreateBankAccountTransaction.md @@ -7,6 +7,6 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Id` | *string* | :heavy_minus_sign: | Identifier for the bank account transaction, unique for the company in the accounting software. | | | `Amount` | *decimal* | :heavy_minus_sign: | The amount transacted in the bank transaction. | | -| `Date` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `Date` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Description` | *string* | :heavy_minus_sign: | Description of the bank transaction. | | | `Balance` | *decimal* | :heavy_minus_sign: | The remaining balance in the account with ID `accountId`. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/CreditNoteStatus.md b/lending/docs/Models/Components/CreditNoteStatus.md index 41acdfbf..4731a496 100644 --- a/lending/docs/Models/Components/CreditNoteStatus.md +++ b/lending/docs/Models/Components/CreditNoteStatus.md @@ -2,6 +2,14 @@ Current state of the credit note. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = CreditNoteStatus.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/CustomerStatus.md b/lending/docs/Models/Components/CustomerStatus.md index 22819665..d372acce 100644 --- a/lending/docs/Models/Components/CustomerStatus.md +++ b/lending/docs/Models/Components/CustomerStatus.md @@ -2,6 +2,14 @@ Status of customer. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = CustomerStatus.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/DataConnectionError.md b/lending/docs/Models/Components/DataConnectionError.md index fe2a2bda..2e7779da 100644 --- a/lending/docs/Models/Components/DataConnectionError.md +++ b/lending/docs/Models/Components/DataConnectionError.md @@ -8,6 +8,6 @@ | `StatusCode` | *string* | :heavy_minus_sign: | The HTTP status code returned by the source platform when the error occurred. | | | `StatusText` | *string* | :heavy_minus_sign: | A non-numeric status code/text returned by the source platform when the error occurred. | | | `ErrorMessage` | *string* | :heavy_minus_sign: | A message about a error returned by Codat. | | -| `ErroredOnUtc` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `ErroredOnUtc` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Status` | [ErrorStatus](../../Models/Components/ErrorStatus.md) | :heavy_minus_sign: | The current status of a transient error. Null statuses indicate that the error is not transient. | | -| `ResolvedOnUtc` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `ResolvedOnUtc` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/DataConnectionStatus.md b/lending/docs/Models/Components/DataConnectionStatus.md index 5d13bea5..96722972 100644 --- a/lending/docs/Models/Components/DataConnectionStatus.md +++ b/lending/docs/Models/Components/DataConnectionStatus.md @@ -2,6 +2,14 @@ The current authorization status of the data connection. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = DataConnectionStatus.PendingAuth; +``` + ## Values diff --git a/lending/docs/Models/Components/DataIntegrityAmounts.md b/lending/docs/Models/Components/DataIntegrityAmounts.md index 4c19baaa..0225e7de 100644 --- a/lending/docs/Models/Components/DataIntegrityAmounts.md +++ b/lending/docs/Models/Components/DataIntegrityAmounts.md @@ -9,4 +9,4 @@ Only returned for transactions. For accounts, there is nothing returned. | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Min` | *decimal* | :heavy_minus_sign: | Lowest value of transaction set. | | | `Max` | *decimal* | :heavy_minus_sign: | Highest value of transaction set. | | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | \ No newline at end of file +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | \ No newline at end of file diff --git a/lending/docs/Models/Components/DataIntegrityByAmount.md b/lending/docs/Models/Components/DataIntegrityByAmount.md index ea2aa9eb..25248826 100644 --- a/lending/docs/Models/Components/DataIntegrityByAmount.md +++ b/lending/docs/Models/Components/DataIntegrityByAmount.md @@ -9,4 +9,4 @@ | `Unmatched` | *decimal* | :heavy_minus_sign: | The sum of the absolute value of transactions of the type specified in the route which don't have a match. | | | `Matched` | *decimal* | :heavy_minus_sign: | The sum of the absolute value of transactions of the type specified in the route which have a match. | | | `Total` | *decimal* | :heavy_minus_sign: | The total of unmatched and matched. | | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | \ No newline at end of file +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | \ No newline at end of file diff --git a/lending/docs/Models/Components/DataIntegrityDataType.md b/lending/docs/Models/Components/DataIntegrityDataType.md index 7f820fa9..2a59630e 100644 --- a/lending/docs/Models/Components/DataIntegrityDataType.md +++ b/lending/docs/Models/Components/DataIntegrityDataType.md @@ -1,5 +1,13 @@ # DataIntegrityDataType +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = DataIntegrityDataType.BankingAccounts; +``` + ## Values diff --git a/lending/docs/Models/Components/DataIntegrityDates.md b/lending/docs/Models/Components/DataIntegrityDates.md index 30faedfa..c20f63c5 100644 --- a/lending/docs/Models/Components/DataIntegrityDates.md +++ b/lending/docs/Models/Components/DataIntegrityDates.md @@ -7,7 +7,7 @@ Only returned for transactions. For accounts, there is nothing returned. | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `MinDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `MaxDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `MinOverlappingDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `MaxOverlappingDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `MinDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `MaxDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `MinOverlappingDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `MaxOverlappingDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/DataIntegrityDetail.md b/lending/docs/Models/Components/DataIntegrityDetail.md index 58701a6f..c36ad66f 100644 --- a/lending/docs/Models/Components/DataIntegrityDetail.md +++ b/lending/docs/Models/Components/DataIntegrityDetail.md @@ -8,8 +8,8 @@ | `Id` | *string* | :heavy_minus_sign: | ID GUID of the transaction. | | | `Type` | *string* | :heavy_minus_sign: | The data type of the record. | | | `ConnectionId` | *string* | :heavy_minus_sign: | ID GUID representing the connection of the accounting or banking platform. | | -| `Date` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `Date` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Description` | *string* | :heavy_minus_sign: | The transaction description. | | | `Amount` | *decimal* | :heavy_minus_sign: | The transaction value. | | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `Matches` | List<[DataIntegrityMatch](../../Models/Components/DataIntegrityMatch.md)> | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/Models/Components/DataIntegrityMatch.md b/lending/docs/Models/Components/DataIntegrityMatch.md index 5dd81f1b..15d26292 100644 --- a/lending/docs/Models/Components/DataIntegrityMatch.md +++ b/lending/docs/Models/Components/DataIntegrityMatch.md @@ -11,4 +11,4 @@ | `Date` | *string* | :heavy_minus_sign: | The date of the transaction. | | | `Description` | *string* | :heavy_minus_sign: | The transaction description. | | | `Amount` | *string* | :heavy_minus_sign: | The transaction value. | | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | \ No newline at end of file +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | \ No newline at end of file diff --git a/lending/docs/Models/Components/DataIntegrityStatusInfo.md b/lending/docs/Models/Components/DataIntegrityStatusInfo.md index 15eea4ba..044c865f 100644 --- a/lending/docs/Models/Components/DataIntegrityStatusInfo.md +++ b/lending/docs/Models/Components/DataIntegrityStatusInfo.md @@ -5,6 +5,6 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `LastMatched` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `LastMatched` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `CurrentStatus` | [IntegrityStatus](../../Models/Components/IntegrityStatus.md) | :heavy_minus_sign: | The current status of the most recently run matching algorithm. | | | `StatusMessage` | *string* | :heavy_minus_sign: | Detailed explanation supporting the status value. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/DataStatus.md b/lending/docs/Models/Components/DataStatus.md index 46aed60c..800c638e 100644 --- a/lending/docs/Models/Components/DataStatus.md +++ b/lending/docs/Models/Components/DataStatus.md @@ -8,7 +8,7 @@ Describes the state of data in the Codat cache for a company and data type | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `DataType` | [DataTypes](../../Models/Components/DataTypes.md) | :heavy_check_mark: | Available data types | invoices | -| `LastSuccessfulSync` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `LastSuccessfulSync` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `CurrentStatus` | [Status](../../Models/Components/Status.md) | :heavy_check_mark: | The current status of the dataset. | | | `LatestSyncId` | *string* | :heavy_minus_sign: | Unique identifier for most recent sync of data type. | ad474a37-2003-478e-baee-9af9f1ec2fe3 | | `LatestSuccessfulSyncId` | *string* | :heavy_minus_sign: | Unique identifier for the most recent successful sync of data type. | 8220fc90-55b6-47bc-9417-48ac6ea93101 | \ No newline at end of file diff --git a/lending/docs/Models/Components/DataType.md b/lending/docs/Models/Components/DataType.md index 4f6ed341..9febaaa5 100644 --- a/lending/docs/Models/Components/DataType.md +++ b/lending/docs/Models/Components/DataType.md @@ -2,6 +2,14 @@ Available data types +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = DataType.AccountTransactions; +``` + ## Values diff --git a/lending/docs/Models/Components/DataTypes.md b/lending/docs/Models/Components/DataTypes.md index 3ea6fa56..e17ee255 100644 --- a/lending/docs/Models/Components/DataTypes.md +++ b/lending/docs/Models/Components/DataTypes.md @@ -2,6 +2,14 @@ Available data types +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = DataTypes.AccountTransactions; +``` + ## Values diff --git a/lending/docs/Models/Components/DatasetStatus.md b/lending/docs/Models/Components/DatasetStatus.md index d5bf9440..d2f83e85 100644 --- a/lending/docs/Models/Components/DatasetStatus.md +++ b/lending/docs/Models/Components/DatasetStatus.md @@ -2,6 +2,14 @@ The current status of the dataset. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = DatasetStatus.Initial; +``` + ## Values diff --git a/lending/docs/Models/Components/DirectCostPrototype.md b/lending/docs/Models/Components/DirectCostPrototype.md index 12c9d521..94e6cbe7 100644 --- a/lending/docs/Models/Components/DirectCostPrototype.md +++ b/lending/docs/Models/Components/DirectCostPrototype.md @@ -8,8 +8,8 @@ | `Reference` | *string* | :heavy_minus_sign: | User-friendly reference for the direct cost. | | | `Note` | *string* | :heavy_minus_sign: | A note attached to the direct cost. | | | `ContactRef` | [ContactRef](../../Models/Components/ContactRef.md) | :heavy_minus_sign: | N/A | | -| `IssueDate` | *string* | :heavy_check_mark: | 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. | 2022-10-23T00:00:00Z | -| `Currency` | *string* | :heavy_check_mark: | 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. | GBP | +| `IssueDate` | *string* | :heavy_check_mark: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `Currency` | *string* | :heavy_check_mark: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `CurrencyRate` | *decimal* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting software, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \|


### Integration-specific details

\| Integration \| Scenario \| System behavior \|
\|-------------------\|-------------------------------------------------\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------\|
\| QuickBooks Online \| Transaction currency differs from base currency \| If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, specify a currencyRate in the request body. \| | | | `LineItems` | List<[DirectCostLineItem](../../Models/Components/DirectCostLineItem.md)> | :heavy_check_mark: | An array of line items. | | | `PaymentAllocations` | List<[AccountingPaymentAllocation](../../Models/Components/AccountingPaymentAllocation.md)> | :heavy_check_mark: | An array of payment allocations. | | diff --git a/lending/docs/Models/Components/DisputeStatus.md b/lending/docs/Models/Components/DisputeStatus.md index e30ad79e..bcb4645a 100644 --- a/lending/docs/Models/Components/DisputeStatus.md +++ b/lending/docs/Models/Components/DisputeStatus.md @@ -2,6 +2,14 @@ Current status of the dispute +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = DisputeStatus.Won; +``` + ## Values diff --git a/lending/docs/Models/Components/EndUploadSessionRequestStatus.md b/lending/docs/Models/Components/EndUploadSessionRequestStatus.md index f3dc9d25..06d1a15b 100644 --- a/lending/docs/Models/Components/EndUploadSessionRequestStatus.md +++ b/lending/docs/Models/Components/EndUploadSessionRequestStatus.md @@ -2,6 +2,14 @@ An indicator to cancel the dataset processing or trigger ingestion and enrichment of data. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = EndUploadSessionRequestStatus.Cancel; +``` + ## Values diff --git a/lending/docs/Models/Components/EnhancedInvoiceReportItem.md b/lending/docs/Models/Components/EnhancedInvoiceReportItem.md index dd4a7f27..ab514a3e 100644 --- a/lending/docs/Models/Components/EnhancedInvoiceReportItem.md +++ b/lending/docs/Models/Components/EnhancedInvoiceReportItem.md @@ -5,16 +5,16 @@ | Field | Type | Required | Description | Example | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Id` | *string* | :heavy_minus_sign: | ID of the invoice, which may be a GUID but it may be something else depending on the accounting software. | | | `InvoiceNumber` | *string* | :heavy_minus_sign: | Invoice number. | | | `CustomerRef` | [LendingCustomerRef](../../Models/Components/LendingCustomerRef.md) | :heavy_minus_sign: | N/A | | -| `IssueDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `DueDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `IssueDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `DueDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Status` | [InvoiceStatus](../../Models/Components/InvoiceStatus.md) | :heavy_minus_sign: | Current state of the invoice:

- `Draft` - Invoice hasn't been submitted to the supplier. It may be in a pending state or is scheduled for future submission, for example by email.
- `Submitted` - Invoice is no longer a draft. It has been processed and, or, sent to the customer. In this state, it will impact the ledger. It also has no payments made against it, meaning `amountDue` will usually equal `totalAmount` (unless tax is witheld).
- `PartiallyPaid` - The balance paid against the invoice is positive, but less than the total invoice amount, meaning `0 < amountDue < totalAmount`.
- `Paid` - Invoice is paid in full. This includes if the invoice has been credited or overpaid, meaning `amountDue == 0`.
- `Void` - An invoice can become Void when it's deleted, refunded, written off, or cancelled. A voided invoice may still be PartiallyPaid, and so all outstanding amounts on voided invoices are removed from the accounts receivable account. | | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `TotalAmount` | *decimal* | :heavy_minus_sign: | Invoice's total amount. | | | `AmountDue` | *decimal* | :heavy_minus_sign: | Invoice's total amount due. | | | `Payments` | List<[Payment](../../Models/Components/Payment.md)> | :heavy_minus_sign: | N/A | | -| `PaidOnDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `PaidOnDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/EnhancedReportInfo.md b/lending/docs/Models/Components/EnhancedReportInfo.md index b9636330..ad010571 100644 --- a/lending/docs/Models/Components/EnhancedReportInfo.md +++ b/lending/docs/Models/Components/EnhancedReportInfo.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `ReportName` | *string* | :heavy_minus_sign: | The name of the report. | | | `CompanyName` | *string* | :heavy_minus_sign: | Name of the company queried. | | -| `GeneratedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `GeneratedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/ErrorStatus.md b/lending/docs/Models/Components/ErrorStatus.md index 9dc66255..1b1f72f3 100644 --- a/lending/docs/Models/Components/ErrorStatus.md +++ b/lending/docs/Models/Components/ErrorStatus.md @@ -2,6 +2,14 @@ The current status of a transient error. Null statuses indicate that the error is not transient. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = ErrorStatus.Active; +``` + ## Values diff --git a/lending/docs/Models/Components/ExcelReportTypes.md b/lending/docs/Models/Components/ExcelReportTypes.md index 9be175f1..fc5de185 100644 --- a/lending/docs/Models/Components/ExcelReportTypes.md +++ b/lending/docs/Models/Components/ExcelReportTypes.md @@ -2,6 +2,14 @@ The type of the report requested in the query string. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = ExcelReportTypes.Audit; +``` + ## Values diff --git a/lending/docs/Models/Components/ExcelStatus.md b/lending/docs/Models/Components/ExcelStatus.md index cb9b4b40..bae20bbd 100644 --- a/lending/docs/Models/Components/ExcelStatus.md +++ b/lending/docs/Models/Components/ExcelStatus.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `LastGenerated` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `LastGenerated` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `InProgress` | *bool* | :heavy_minus_sign: | When true, the request was successful and the report is being generated. If false, the request was unsuccessful and the report is not being generated. | | | `Queued` | *string* | :heavy_minus_sign: | The date and time of when a successful request was queued for the most recent report. | | | `Success` | *bool* | :heavy_minus_sign: | True if the requested report was successfully queued and false if the requested report was not able to be queued. | | diff --git a/lending/docs/Models/Components/File.md b/lending/docs/Models/Components/File.md index d576bd80..f6fe888b 100644 --- a/lending/docs/Models/Components/File.md +++ b/lending/docs/Models/Components/File.md @@ -8,4 +8,4 @@ | `FileName` | *string* | :heavy_minus_sign: | The file's name. | | | `DisplayName` | *string* | :heavy_minus_sign: | An optional display name for the file. | | | `SourceType` | *string* | :heavy_minus_sign: | The source of the file uploaded. | | -| `Uploaded` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `Uploaded` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/IntegrityStatus.md b/lending/docs/Models/Components/IntegrityStatus.md index 2ac8a35f..34869421 100644 --- a/lending/docs/Models/Components/IntegrityStatus.md +++ b/lending/docs/Models/Components/IntegrityStatus.md @@ -2,6 +2,14 @@ The current status of the most recently run matching algorithm. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = IntegrityStatus.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/InvoiceStatus.md b/lending/docs/Models/Components/InvoiceStatus.md index f222c06b..0a31e067 100644 --- a/lending/docs/Models/Components/InvoiceStatus.md +++ b/lending/docs/Models/Components/InvoiceStatus.md @@ -8,6 +8,14 @@ Current state of the invoice: - `Paid` - Invoice is paid in full. This includes if the invoice has been credited or overpaid, meaning `amountDue == 0`. - `Void` - An invoice can become Void when it's deleted, refunded, written off, or cancelled. A voided invoice may still be PartiallyPaid, and so all outstanding amounts on voided invoices are removed from the accounts receivable account. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = InvoiceStatus.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/JournalEntryRecordRefDataType.md b/lending/docs/Models/Components/JournalEntryRecordRefDataType.md index 818b825f..750216fa 100644 --- a/lending/docs/Models/Components/JournalEntryRecordRefDataType.md +++ b/lending/docs/Models/Components/JournalEntryRecordRefDataType.md @@ -2,6 +2,14 @@ Name of underlying data type. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = JournalEntryRecordRefDataType.BankTransactions; +``` + ## Values diff --git a/lending/docs/Models/Components/JournalLineDataType.md b/lending/docs/Models/Components/JournalLineDataType.md index 83aab476..dac02992 100644 --- a/lending/docs/Models/Components/JournalLineDataType.md +++ b/lending/docs/Models/Components/JournalLineDataType.md @@ -2,6 +2,14 @@ Allowed name of the 'dataType'. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = JournalLineDataType.Customers; +``` + ## Values diff --git a/lending/docs/Models/Components/JournalStatus.md b/lending/docs/Models/Components/JournalStatus.md index 86c1f110..254161ea 100644 --- a/lending/docs/Models/Components/JournalStatus.md +++ b/lending/docs/Models/Components/JournalStatus.md @@ -2,6 +2,14 @@ Current journal status. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = JournalStatus.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/LoanSummaryIntegrationType.md b/lending/docs/Models/Components/LoanSummaryIntegrationType.md index 9d796264..b7db526d 100644 --- a/lending/docs/Models/Components/LoanSummaryIntegrationType.md +++ b/lending/docs/Models/Components/LoanSummaryIntegrationType.md @@ -2,6 +2,14 @@ The integration type begin referred to. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = LoanSummaryIntegrationType.Accounting; +``` + ## Values diff --git a/lending/docs/Models/Components/LoanSummaryRecordRefType.md b/lending/docs/Models/Components/LoanSummaryRecordRefType.md index 7d45d54c..dd3e50d7 100644 --- a/lending/docs/Models/Components/LoanSummaryRecordRefType.md +++ b/lending/docs/Models/Components/LoanSummaryRecordRefType.md @@ -2,6 +2,14 @@ The datatype being referred to. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = LoanSummaryRecordRefType.Accounts; +``` + ## Values diff --git a/lending/docs/Models/Components/LoanSummaryReportInfo.md b/lending/docs/Models/Components/LoanSummaryReportInfo.md index efd57610..d3cfb3b5 100644 --- a/lending/docs/Models/Components/LoanSummaryReportInfo.md +++ b/lending/docs/Models/Components/LoanSummaryReportInfo.md @@ -7,4 +7,4 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `ReportName` | *string* | :heavy_minus_sign: | The name of the report. | | | `CompanyName` | *string* | :heavy_minus_sign: | Name of the company queried. | | -| `GeneratedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `GeneratedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/LoanSummaryReportItem.md b/lending/docs/Models/Components/LoanSummaryReportItem.md index b3f86d10..efa70692 100644 --- a/lending/docs/Models/Components/LoanSummaryReportItem.md +++ b/lending/docs/Models/Components/LoanSummaryReportItem.md @@ -7,7 +7,7 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `RecordRef` | [LoanSummaryRecordRef](../../Models/Components/LoanSummaryRecordRef.md) | :heavy_minus_sign: | N/A | | | `Description` | *string* | :heavy_minus_sign: | The description of the object being referred to. E.g. the account. | | -| `StartDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `StartDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `TotalDrawdowns` | *decimal* | :heavy_minus_sign: | The total loan drawdowns. | | | `TotalRepayments` | *decimal* | :heavy_minus_sign: | The total loan repayments which includes capital plus any interest. | | | `Balance` | *decimal* | :heavy_minus_sign: | The loan outstanding balance. This may not equal totalDrawdowns - totalRepayments due to interest which has been accrued. | | diff --git a/lending/docs/Models/Components/LoanTransactionType.md b/lending/docs/Models/Components/LoanTransactionType.md index af7b32ab..e103b2ee 100644 --- a/lending/docs/Models/Components/LoanTransactionType.md +++ b/lending/docs/Models/Components/LoanTransactionType.md @@ -2,6 +2,14 @@ The type of loan transaction. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = LoanTransactionType.Investment; +``` + ## Values diff --git a/lending/docs/Models/Components/LoanTransactionsReportInfo.md b/lending/docs/Models/Components/LoanTransactionsReportInfo.md index d5ee5bdc..d7354702 100644 --- a/lending/docs/Models/Components/LoanTransactionsReportInfo.md +++ b/lending/docs/Models/Components/LoanTransactionsReportInfo.md @@ -10,4 +10,4 @@ | `TotalResults` | *long* | :heavy_minus_sign: | The total number of transactions returned. | | | `ReportName` | *string* | :heavy_minus_sign: | The name of the report. | | | `CompanyName` | *string* | :heavy_minus_sign: | Name of the company queried. | | -| `GeneratedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `GeneratedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/LocationRef.md b/lending/docs/Models/Components/LocationRef.md index 0c036aba..8e30aad4 100644 --- a/lending/docs/Models/Components/LocationRef.md +++ b/lending/docs/Models/Components/LocationRef.md @@ -5,7 +5,7 @@ Reference to the geographic location where the order was placed. ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -| `Id` | *string* | :heavy_check_mark: | The unique identitifer of the location being referenced. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `Name` | *string* | :heavy_minus_sign: | Name of the location being referenced. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `Id` | *string* | :heavy_check_mark: | The unique identitifer of the location being referenced. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `Name` | *string* | :heavy_minus_sign: | Name of the location being referenced. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/OrderLineItem.md b/lending/docs/Models/Components/OrderLineItem.md index bea1f45f..7d8c994d 100644 --- a/lending/docs/Models/Components/OrderLineItem.md +++ b/lending/docs/Models/Components/OrderLineItem.md @@ -3,15 +3,15 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | -| `Id` | *string* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `Quantity` | *decimal* | :heavy_minus_sign: | Number of units of the product sold.
For refunds, quantity is negative.
| | -| `TaxPercentage` | *decimal* | :heavy_minus_sign: | Percentage rate (from 0 to 100) of any sales tax applied to the unit price. | 0 | -| `TotalAmount` | *decimal* | :heavy_minus_sign: | Total amount of the line item, including discounts and tax. | | -| `TotalTaxAmount` | *decimal* | :heavy_minus_sign: | Total amount of tax applied to the line item, factoring in any discounts. | | -| `UnitPrice` | *decimal* | :heavy_minus_sign: | Price per unit of goods or services, excluding discounts and tax. | | -| `Taxes` | List<[TaxComponentAllocation](../../Models/Components/TaxComponentAllocation.md)> | :heavy_minus_sign: | Taxes breakdown as applied to order lines. | | -| `ProductRef` | [ProductRef](../../Models/Components/ProductRef.md) | :heavy_minus_sign: | Reference that links the line item to the correct product details. | | -| `ProductVariantRef` | [ProductVariantRef](../../Models/Components/ProductVariantRef.md) | :heavy_minus_sign: | Reference that links the line item to the specific version of product that has been ordered. | | -| `DiscountAllocations` | List<[OrderDiscountAllocation](../../Models/Components/OrderDiscountAllocation.md)> | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `Id` | *string* | :heavy_check_mark: | A unique, persistent identifier for this record | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `Quantity` | *decimal* | :heavy_minus_sign: | Number of units of the product sold.
For refunds, quantity is negative.
| | +| `TaxPercentage` | *decimal* | :heavy_minus_sign: | Percentage rate (from 0 to 100) of any sales tax applied to the unit price. | **Example 1:** 0
**Example 2:** 12.5
**Example 3:** 45.00 | +| `TotalAmount` | *decimal* | :heavy_minus_sign: | Total amount of the line item, including discounts and tax. | | +| `TotalTaxAmount` | *decimal* | :heavy_minus_sign: | Total amount of tax applied to the line item, factoring in any discounts. | | +| `UnitPrice` | *decimal* | :heavy_minus_sign: | Price per unit of goods or services, excluding discounts and tax. | | +| `Taxes` | List<[TaxComponentAllocation](../../Models/Components/TaxComponentAllocation.md)> | :heavy_minus_sign: | Taxes breakdown as applied to order lines. | | +| `ProductRef` | [ProductRef](../../Models/Components/ProductRef.md) | :heavy_minus_sign: | Reference that links the line item to the correct product details. | | +| `ProductVariantRef` | [ProductVariantRef](../../Models/Components/ProductVariantRef.md) | :heavy_minus_sign: | Reference that links the line item to the specific version of product that has been ordered. | | +| `DiscountAllocations` | List<[OrderDiscountAllocation](../../Models/Components/OrderDiscountAllocation.md)> | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/Models/Components/Path.md b/lending/docs/Models/Components/Path.md index 3677418a..c1b8d9c9 100644 --- a/lending/docs/Models/Components/Path.md +++ b/lending/docs/Models/Components/Path.md @@ -1,5 +1,13 @@ # Path +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = Path.AuthGet; +``` + ## Values diff --git a/lending/docs/Models/Components/Payment.md b/lending/docs/Models/Components/Payment.md index dd4b4b74..d03e466e 100644 --- a/lending/docs/Models/Components/Payment.md +++ b/lending/docs/Models/Components/Payment.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Id` | *string* | :heavy_minus_sign: | ID of the invoice, which may be a GUID but it may be something else depending on the accounting software. | | -| `Date` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `Date` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `PaymentType` | *string* | :heavy_minus_sign: | The type of payment. | | | `Amount` | *decimal* | :heavy_minus_sign: | Payment amount. | | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `CurrencyRate` | *decimal* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting software, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \|


### Integration-specific details

\| Integration \| Scenario \| System behavior \|
\|-------------------\|-------------------------------------------------\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------\|
\| QuickBooks Online \| Transaction currency differs from base currency \| If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, specify a currencyRate in the request body. \| | | | `BankingTransactionRefs` | List<[BankingTransactionRef](../../Models/Components/BankingTransactionRef.md)> | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/Models/Components/PaymentAllocationPayment.md b/lending/docs/Models/Components/PaymentAllocationPayment.md index b36fbe87..d59ac4fe 100644 --- a/lending/docs/Models/Components/PaymentAllocationPayment.md +++ b/lending/docs/Models/Components/PaymentAllocationPayment.md @@ -9,7 +9,7 @@ | `Note` | *string* | :heavy_minus_sign: | Notes attached to the allocated payment. | | | `Reference` | *string* | :heavy_minus_sign: | Reference to the allocated payment. | | | `AccountRef` | [AccountRef](../../Models/Components/AccountRef.md) | :heavy_minus_sign: | Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account. | {
"Example": {
"value": {
"accountRef": {
"id": "4f78a6b0-e9bb-40f2-82fd-f3a2daa1fd0a",
"name": "Business Current Account"
}
}
}
} | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `CurrencyRate` | *decimal* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.

Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit.

It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.

Where the currency rate is provided by the underlying accounting software, it will be available from Codat with the same precision (up to a maximum of 9 decimal places).

For accounting software which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.

## Examples with base currency of GBP

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **USD** \| $20 \| 0.781 \| £15.62 \|
\| **EUR** \| €20 \| 0.885 \| £17.70 \|
\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|

## Examples with base currency of USD

\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|
\| :--------------- \| :------------- \| :------------ \| :------------------------- \|
\| **GBP** \| £20 \| 1.277 \| $25.54 \|
\| **EUR** \| €20 \| 1.134 \| $22.68 \|
\| **RUB** \| ₽20 \| 0.015 \| $0.30 \|


### Integration-specific details

\| Integration \| Scenario \| System behavior \|
\|-------------------\|-------------------------------------------------\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------\|
\| QuickBooks Online \| Transaction currency differs from base currency \| If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, specify a currencyRate in the request body. \| | | -| `PaidOnDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `PaidOnDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `TotalAmount` | *decimal* | :heavy_minus_sign: | Total amount that was paid. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/PaymentLine.md b/lending/docs/Models/Components/PaymentLine.md index d7ddd19d..119e0040 100644 --- a/lending/docs/Models/Components/PaymentLine.md +++ b/lending/docs/Models/Components/PaymentLine.md @@ -7,4 +7,4 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Amount` | *decimal* | :heavy_check_mark: | Amount in the payment currency. | | | `Links` | List<[PaymentLineLink](../../Models/Components/PaymentLineLink.md)> | :heavy_minus_sign: | N/A | | -| `AllocatedOnDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `AllocatedOnDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/PaymentLinkType.md b/lending/docs/Models/Components/PaymentLinkType.md index a705ea78..9048aa3e 100644 --- a/lending/docs/Models/Components/PaymentLinkType.md +++ b/lending/docs/Models/Components/PaymentLinkType.md @@ -12,6 +12,14 @@ Types of payment line links, either: `Manual Journal` `Discount` - ID refers to the payment +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = PaymentLinkType.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/PaymentRef.md b/lending/docs/Models/Components/PaymentRef.md index 92e3455b..9d5dc2be 100644 --- a/lending/docs/Models/Components/PaymentRef.md +++ b/lending/docs/Models/Components/PaymentRef.md @@ -5,13 +5,13 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `Id` | *string* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `Amount` | *decimal* | :heavy_minus_sign: | Payment Amount (including gratuity). | 194.12 | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `Id` | *string* | :heavy_check_mark: | A unique, persistent identifier for this record | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `Amount` | *decimal* | :heavy_minus_sign: | Payment Amount (including gratuity). | **Example 1:** 194.12
**Example 2:** -283.56
**Example 3:** 0 | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `Type` | [PaymentType](../../Models/Components/PaymentType.md) | :heavy_minus_sign: | Type of payment. | Cash | | `Status` | [PaymentStatus](../../Models/Components/PaymentStatus.md) | :heavy_minus_sign: | Status of the payment. | | -| `PaymentProvider` | *string* | :heavy_minus_sign: | Service provider of the payment, if applicable. | Amazon Pay | -| `DueDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `CreatedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `PaymentProvider` | *string* | :heavy_minus_sign: | Service provider of the payment, if applicable. | **Example 1:** Amazon Pay
**Example 2:** Checkout.com
**Example 3:** SagePay | +| `DueDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `CreatedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/PaymentStatus.md b/lending/docs/Models/Components/PaymentStatus.md index 7509d3f5..1c87f9ee 100644 --- a/lending/docs/Models/Components/PaymentStatus.md +++ b/lending/docs/Models/Components/PaymentStatus.md @@ -2,6 +2,14 @@ Status of the payment. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = PaymentStatus.Pending; +``` + ## Values diff --git a/lending/docs/Models/Components/PaymentType.md b/lending/docs/Models/Components/PaymentType.md index 10be107d..a71d4801 100644 --- a/lending/docs/Models/Components/PaymentType.md +++ b/lending/docs/Models/Components/PaymentType.md @@ -2,6 +2,14 @@ Type of payment. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = PaymentType.Cash; +``` + ## Values diff --git a/lending/docs/Models/Components/PeriodUnit.md b/lending/docs/Models/Components/PeriodUnit.md index d15352d7..a51e86c4 100644 --- a/lending/docs/Models/Components/PeriodUnit.md +++ b/lending/docs/Models/Components/PeriodUnit.md @@ -1,5 +1,13 @@ # PeriodUnit +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = PeriodUnit.Day; +``` + ## Values diff --git a/lending/docs/Models/Components/PhoneNumber.md b/lending/docs/Models/Components/PhoneNumber.md index a2c00cae..4f8e3322 100644 --- a/lending/docs/Models/Components/PhoneNumber.md +++ b/lending/docs/Models/Components/PhoneNumber.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | -| `Number` | *string* | :heavy_minus_sign: | A phone number. | +44 25691 154789 | -| `Type` | [Models.Components.Type](../../Models/Components/Type.md) | :heavy_check_mark: | The type of phone number | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | +| `Number` | *string* | :heavy_minus_sign: | A phone number. | **Example 1:** +44 25691 154789
**Example 2:** (877) 492-8687
**Example 3:** 01224 658 999 | +| `Type` | [Models.Components.Type](../../Models/Components/Type.md) | :heavy_check_mark: | The type of phone number | | \ No newline at end of file diff --git a/lending/docs/Models/Components/ProductPrice.md b/lending/docs/Models/Components/ProductPrice.md index 6fc6f2a0..8f71c050 100644 --- a/lending/docs/Models/Components/ProductPrice.md +++ b/lending/docs/Models/Components/ProductPrice.md @@ -5,5 +5,5 @@ | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `UnitPrice` | *decimal* | :heavy_minus_sign: | The product variant's unit price. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/ProductRef.md b/lending/docs/Models/Components/ProductRef.md index 13bb14da..f8d01789 100644 --- a/lending/docs/Models/Components/ProductRef.md +++ b/lending/docs/Models/Components/ProductRef.md @@ -5,7 +5,7 @@ Reference that links the line item to the correct product details. ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | ------------------------------------------------------ | -| `Id` | *string* | :heavy_check_mark: | The unique identifier of the product being referenced. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `Name` | *string* | :heavy_minus_sign: | Name of the product being referenced. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `Id` | *string* | :heavy_check_mark: | The unique identifier of the product being referenced. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `Name` | *string* | :heavy_minus_sign: | Name of the product being referenced. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/ProductVariant.md b/lending/docs/Models/Components/ProductVariant.md index c3a2c539..c21a7e14 100644 --- a/lending/docs/Models/Components/ProductVariant.md +++ b/lending/docs/Models/Components/ProductVariant.md @@ -8,17 +8,17 @@ Represents a variation of a product available for sale, for example an item of c | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00Z | -| `Id` | *string* | :heavy_check_mark: | A unique, persistent identifier for this record | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `Name` | *string* | :heavy_minus_sign: | Name of the product recorded in the commerce or point of sale platform. | Red Coat | +| `ModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `SourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `Id` | *string* | :heavy_check_mark: | A unique, persistent identifier for this record | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `Name` | *string* | :heavy_minus_sign: | Name of the product recorded in the commerce or point of sale platform. | **Example 1:** Red Coat
**Example 2:** Black Coat
**Example 3:** Large Brown Hat | | `IsTaxEnabled` | *bool* | :heavy_minus_sign: | Whether sales taxes are enabled for this product variant. | | -| `Sku` | *string* | :heavy_minus_sign: | SKU (stock keeping unit) of the variant, as defined by the merchant. | Coat-Red-Lrg | -| `Barcode` | *string* | :heavy_minus_sign: | Unique product number of the variant. This might be a barcode, UPC, ISBN, etc. | 564158468416486458646886484 | -| `UnitOfMeasure` | *string* | :heavy_minus_sign: | Unit of measure for the variant, such as `kg` or `meters`. | kg | -| `VatPercentage` | *decimal* | :heavy_minus_sign: | VAT rate for the product variant if sales taxes are enabled. | 12.5 | +| `Sku` | *string* | :heavy_minus_sign: | SKU (stock keeping unit) of the variant, as defined by the merchant. | **Example 1:** Coat-Red-Lrg
**Example 2:** Coat-Black-Md
**Example 3:** LargeBrownHat
**Example 4:** A725BA2 | +| `Barcode` | *string* | :heavy_minus_sign: | Unique product number of the variant. This might be a barcode, UPC, ISBN, etc. | **Example 1:** 564158468416486458646886484
**Example 2:** CSE370 | +| `UnitOfMeasure` | *string* | :heavy_minus_sign: | Unit of measure for the variant, such as `kg` or `meters`. | **Example 1:** kg
**Example 2:** m
**Example 3:** meters | +| `VatPercentage` | *decimal* | :heavy_minus_sign: | VAT rate for the product variant if sales taxes are enabled. | **Example 1:** 12.5
**Example 2:** 0
**Example 3:** 20 | | `Prices` | List<[ProductPrice](../../Models/Components/ProductPrice.md)> | :heavy_minus_sign: | Prices for the product variants in different currencies. | | | `Inventory` | [ProductInventory](../../Models/Components/ProductInventory.md) | :heavy_minus_sign: | Information about the total inventory as well as the locations inventory is in. | | | `ShippingRequired` | *bool* | :heavy_minus_sign: | Indicates whether or not the product requires physical delivery. | | | `Status` | [ProductVariantStatus](../../Models/Components/ProductVariantStatus.md) | :heavy_minus_sign: | The status of the product variant. | | -| `CreatedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `CreatedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/ProductVariantRef.md b/lending/docs/Models/Components/ProductVariantRef.md index 3d8c462e..66cbb33b 100644 --- a/lending/docs/Models/Components/ProductVariantRef.md +++ b/lending/docs/Models/Components/ProductVariantRef.md @@ -5,7 +5,7 @@ Reference that links the line item to the specific version of product that has b ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -| `Id` | *string* | :heavy_check_mark: | The unique identifier of the product variant being referenced. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `Name` | *string* | :heavy_minus_sign: | Name of the product variant being referenced. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `Id` | *string* | :heavy_check_mark: | The unique identifier of the product variant being referenced. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `Name` | *string* | :heavy_minus_sign: | Name of the product variant being referenced. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/ProductVariantStatus.md b/lending/docs/Models/Components/ProductVariantStatus.md index d443d83c..3cfc01f7 100644 --- a/lending/docs/Models/Components/ProductVariantStatus.md +++ b/lending/docs/Models/Components/ProductVariantStatus.md @@ -2,6 +2,14 @@ The status of the product variant. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = ProductVariantStatus.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/ProfitAndLossReport.md b/lending/docs/Models/Components/ProfitAndLossReport.md index d4f5290b..13e3c173 100644 --- a/lending/docs/Models/Components/ProfitAndLossReport.md +++ b/lending/docs/Models/Components/ProfitAndLossReport.md @@ -5,8 +5,8 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `FromDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `ToDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `FromDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `ToDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Income` | [ReportLine](../../Models/Components/ReportLine.md) | :heavy_minus_sign: | N/A | | | `CostOfSales` | [ReportLine](../../Models/Components/ReportLine.md) | :heavy_minus_sign: | N/A | | | `GrossProfit` | *decimal* | :heavy_check_mark: | Gross profit of the company in the given date range. | | diff --git a/lending/docs/Models/Components/PropertieAccountType.md b/lending/docs/Models/Components/PropertieAccountType.md index 0cf70a60..600d9b85 100644 --- a/lending/docs/Models/Components/PropertieAccountType.md +++ b/lending/docs/Models/Components/PropertieAccountType.md @@ -2,6 +2,14 @@ The type of bank account e.g. checking, savings, loan, creditCard, prepaidCard. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = PropertieAccountType.Checking; +``` + ## Values diff --git a/lending/docs/Models/Components/PropertieDataType.md b/lending/docs/Models/Components/PropertieDataType.md index 1defb94d..1bf4a33f 100644 --- a/lending/docs/Models/Components/PropertieDataType.md +++ b/lending/docs/Models/Components/PropertieDataType.md @@ -2,6 +2,14 @@ Available data types +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = PropertieDataType.AccountTransactions; +``` + ## Values diff --git a/lending/docs/Models/Components/PullOperation.md b/lending/docs/Models/Components/PullOperation.md index babc4322..936c87ec 100644 --- a/lending/docs/Models/Components/PullOperation.md +++ b/lending/docs/Models/Components/PullOperation.md @@ -15,8 +15,8 @@ Information about a queued, in progress or completed pull operation. | `Status` | [DatasetStatus](../../Models/Components/DatasetStatus.md) | :heavy_check_mark: | The current status of the dataset. | | | `StatusDescription` | *string* | :heavy_minus_sign: | Additional information about the dataset status. | Paused until 2022-10-23T00:00:00.000Z | | `ErrorMessage` | *string* | :heavy_minus_sign: | A message about a transient or persistent error returned by Codat or the source platform. | | -| `Requested` | *string* | :heavy_check_mark: | 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. | 2022-10-23T00:00:00Z | -| `Completed` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `Requested` | *string* | :heavy_check_mark: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `Completed` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Progress` | *long* | :heavy_check_mark: | An integer signifying the progress of the pull operation. | | | `IsCompleted` | *bool* | :heavy_check_mark: | `True` if the pull operation is completed successfully. The `isCompleted` property is not queryable. To filter failed pull operations, query by `status!=Complete&&status!=NotSupported` instead. | | | `IsErrored` | *bool* | :heavy_check_mark: | `True` if the pull operation entered an error state. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/PushChangeType.md b/lending/docs/Models/Components/PushChangeType.md index 7585e9c8..ba892bca 100644 --- a/lending/docs/Models/Components/PushChangeType.md +++ b/lending/docs/Models/Components/PushChangeType.md @@ -2,6 +2,14 @@ Type of change being applied to record in third party platform. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = PushChangeType.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/PushOperation.md b/lending/docs/Models/Components/PushOperation.md index d8010b6e..e3a760fb 100644 --- a/lending/docs/Models/Components/PushOperation.md +++ b/lending/docs/Models/Components/PushOperation.md @@ -10,8 +10,8 @@ | `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for your SMB in Codat. | 8a210b68-6988-11ed-a1eb-0242ac120002 | | `PushOperationKey` | *string* | :heavy_check_mark: | A unique identifier generated by Codat to represent this single push operation. This identifier can be used to track the status of the push, and should be persisted. | | | `DataConnectionKey` | *string* | :heavy_check_mark: | Unique identifier for a company's data connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `RequestedOnUtc` | *string* | :heavy_check_mark: | 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. | 2022-10-23T00:00:00Z | -| `CompletedOnUtc` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `RequestedOnUtc` | *string* | :heavy_check_mark: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `CompletedOnUtc` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `TimeoutInMinutes` | *int* | :heavy_minus_sign: | Number of minutes the push operation must complete within before it times out. | | | ~~`TimeoutInSeconds`~~ | *int* | :heavy_minus_sign: | : warning: ** DEPRECATED **: This will be removed in a future release, please migrate away from it as soon as possible.

Number of seconds the push operation must complete within before it times out. | | | `Status` | [PushOperationStatus](../../Models/Components/PushOperationStatus.md) | :heavy_check_mark: | The current status of the push operation. | | diff --git a/lending/docs/Models/Components/PushOperationStatus.md b/lending/docs/Models/Components/PushOperationStatus.md index 4e041b53..c7d3a5b3 100644 --- a/lending/docs/Models/Components/PushOperationStatus.md +++ b/lending/docs/Models/Components/PushOperationStatus.md @@ -2,6 +2,14 @@ The current status of the push operation. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = PushOperationStatus.Pending; +``` + ## Values diff --git a/lending/docs/Models/Components/PushOptionType.md b/lending/docs/Models/Components/PushOptionType.md index f1bb3708..e227214e 100644 --- a/lending/docs/Models/Components/PushOptionType.md +++ b/lending/docs/Models/Components/PushOptionType.md @@ -2,6 +2,14 @@ The option type. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = PushOptionType.Array; +``` + ## Values diff --git a/lending/docs/Models/Components/ReportBasis.md b/lending/docs/Models/Components/ReportBasis.md index ac3d9627..5e5fee84 100644 --- a/lending/docs/Models/Components/ReportBasis.md +++ b/lending/docs/Models/Components/ReportBasis.md @@ -2,6 +2,14 @@ The basis of a report. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = ReportBasis.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/ReportInput.md b/lending/docs/Models/Components/ReportInput.md index 1e1e6a2f..f9e7b611 100644 --- a/lending/docs/Models/Components/ReportInput.md +++ b/lending/docs/Models/Components/ReportInput.md @@ -2,6 +2,14 @@ Accounting method used to prepare the cash flow statement. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = ReportInput.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/ReportItem.md b/lending/docs/Models/Components/ReportItem.md index cf5f2cce..90e35ee7 100644 --- a/lending/docs/Models/Components/ReportItem.md +++ b/lending/docs/Models/Components/ReportItem.md @@ -5,7 +5,7 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `Date` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `Date` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Balance` | *decimal* | :heavy_minus_sign: | Balance of the account as reported on the profit and loss or Balance sheet. | | | `AccountName` | *string* | :heavy_minus_sign: | Name of the account. | | | `AccountId` | *string* | :heavy_minus_sign: | The unique account ID. | | diff --git a/lending/docs/Models/Components/ReportItems.md b/lending/docs/Models/Components/ReportItems.md index 1326ea9d..da3190b9 100644 --- a/lending/docs/Models/Components/ReportItems.md +++ b/lending/docs/Models/Components/ReportItems.md @@ -7,7 +7,7 @@ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `LoanRef` | [LoanRef](../../Models/Components/LoanRef.md) | :heavy_minus_sign: | N/A | | | `ItemRef` | [ItemRef](../../Models/Components/ItemRef.md) | :heavy_minus_sign: | N/A | | -| `Date` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `Date` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Amount` | *decimal* | :heavy_minus_sign: | The loan transaction amount. | | | `LoanTransactionType` | [LoanTransactionType](../../Models/Components/LoanTransactionType.md) | :heavy_minus_sign: | The type of loan transaction. | | | `Lender` | *string* | :heavy_minus_sign: | The name of lender providing the loan. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/ReportOperation.md b/lending/docs/Models/Components/ReportOperation.md index 4241adea..f4253750 100644 --- a/lending/docs/Models/Components/ReportOperation.md +++ b/lending/docs/Models/Components/ReportOperation.md @@ -10,6 +10,6 @@ Information about report generation. | `Id` | *string* | :heavy_minus_sign: | Unique identifier of the report | 52c0f26b-051a-43ff-b02a-258eec67f5ef | | `Status` | [ReportOperationStatus](../../Models/Components/ReportOperationStatus.md) | :heavy_minus_sign: | The status of the report generation. | | | `Type` | [ReportOperationType](../../Models/Components/ReportOperationType.md) | :heavy_minus_sign: | The name of the generated report. | | -| `RequestedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | -| `UpdatedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `RequestedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | +| `UpdatedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `ErrorMessage` | *string* | :heavy_minus_sign: | A short message describing any errors that occurred while generating the report. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/ReportOperationStatus.md b/lending/docs/Models/Components/ReportOperationStatus.md index e3ad61b7..e2fea2f4 100644 --- a/lending/docs/Models/Components/ReportOperationStatus.md +++ b/lending/docs/Models/Components/ReportOperationStatus.md @@ -2,6 +2,14 @@ The status of the report generation. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = ReportOperationStatus.InProgress; +``` + ## Values diff --git a/lending/docs/Models/Components/ReportOperationType.md b/lending/docs/Models/Components/ReportOperationType.md index dfbf3c68..f9908c64 100644 --- a/lending/docs/Models/Components/ReportOperationType.md +++ b/lending/docs/Models/Components/ReportOperationType.md @@ -2,6 +2,14 @@ The name of the generated report. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = ReportOperationType.CategorizedBankStatement; +``` + ## Values diff --git a/lending/docs/Models/Components/ReportType.md b/lending/docs/Models/Components/ReportType.md index 2f6c136b..3fe468c6 100644 --- a/lending/docs/Models/Components/ReportType.md +++ b/lending/docs/Models/Components/ReportType.md @@ -1,5 +1,13 @@ # ReportType +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = ReportType.CategorizedBankStatement; +``` + ## Values diff --git a/lending/docs/Models/Components/RoutingInfoType.md b/lending/docs/Models/Components/RoutingInfoType.md index 232fa657..d89ea301 100644 --- a/lending/docs/Models/Components/RoutingInfoType.md +++ b/lending/docs/Models/Components/RoutingInfoType.md @@ -2,6 +2,14 @@ The type of routing number. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = RoutingInfoType.Rtn; +``` + ## Values diff --git a/lending/docs/Models/Components/Schema.md b/lending/docs/Models/Components/Schema.md index b9c178a6..7ad742ef 100644 --- a/lending/docs/Models/Components/Schema.md +++ b/lending/docs/Models/Components/Schema.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Id` | *string* | :heavy_minus_sign: | Unique identifier of the event. | ba29118f-5406-4e59-b05c-ba307ca38d01 | -| `EventType` | *string* | :heavy_minus_sign: | The type of event. | reports.categorizedBankStatement.generate.successful | -| `GeneratedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `EventType` | *string* | :heavy_minus_sign: | The type of event. | **Example 1:** reports.categorizedBankStatement.generate.successful
**Example 2:** reports.creditModel.generate.successful | +| `GeneratedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Payload` | [ReportGenerationPayload](../../Models/Components/ReportGenerationPayload.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/Models/Components/ServiceCharge.md b/lending/docs/Models/Components/ServiceCharge.md index 2be9db52..536c246e 100644 --- a/lending/docs/Models/Components/ServiceCharge.md +++ b/lending/docs/Models/Components/ServiceCharge.md @@ -6,9 +6,9 @@ | Field | Type | Required | Description | Example | | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | | `Description` | *string* | :heavy_minus_sign: | Service charges for this order. | A service charge | -| `TotalAmount` | *decimal* | :heavy_minus_sign: | Total amount of the service charge, including tax. | 0 | -| `TaxPercentage` | *decimal* | :heavy_minus_sign: | Percentage rate (from 0 to 100) of any tax applied to the service charge. | 0 | -| `TaxAmount` | *decimal* | :heavy_minus_sign: | Amount of the service charge that is tax. | 0 | +| `TotalAmount` | *decimal* | :heavy_minus_sign: | Total amount of the service charge, including tax. | **Example 1:** 0
**Example 2:** 12.5
**Example 3:** 45 | +| `TaxPercentage` | *decimal* | :heavy_minus_sign: | Percentage rate (from 0 to 100) of any tax applied to the service charge. | **Example 1:** 0
**Example 2:** 12.5
**Example 3:** 45 | +| `TaxAmount` | *decimal* | :heavy_minus_sign: | Amount of the service charge that is tax. | **Example 1:** 0
**Example 2:** 12.5
**Example 3:** 45 | | `Taxes` | List<[TaxComponentAllocation](../../Models/Components/TaxComponentAllocation.md)> | :heavy_minus_sign: | Taxes breakdown as applied to service charges. | | -| `Quantity` | *long* | :heavy_minus_sign: | The number of times the charge is charged. | 1 | +| `Quantity` | *long* | :heavy_minus_sign: | The number of times the charge is charged. | **Example 1:** 1
**Example 2:** 12
**Example 3:** 45 | | `Type` | [ServiceChargeType](../../Models/Components/ServiceChargeType.md) | :heavy_minus_sign: | The type of the service charge. | Overpayment | \ No newline at end of file diff --git a/lending/docs/Models/Components/ServiceChargeType.md b/lending/docs/Models/Components/ServiceChargeType.md index 4fbe44a3..8d57a865 100644 --- a/lending/docs/Models/Components/ServiceChargeType.md +++ b/lending/docs/Models/Components/ServiceChargeType.md @@ -2,6 +2,14 @@ The type of the service charge. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = ServiceChargeType.Generic; +``` + ## Values diff --git a/lending/docs/Models/Components/Source.md b/lending/docs/Models/Components/Source.md index a0056503..8a12f16d 100644 --- a/lending/docs/Models/Components/Source.md +++ b/lending/docs/Models/Components/Source.md @@ -2,6 +2,14 @@ The source of the banking data that determines its format +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = Source.Codat; +``` + ## Values diff --git a/lending/docs/Models/Components/SourceAccount.md b/lending/docs/Models/Components/SourceAccount.md index b22d21be..e712fc97 100644 --- a/lending/docs/Models/Components/SourceAccount.md +++ b/lending/docs/Models/Components/SourceAccount.md @@ -12,8 +12,8 @@ The target bank account in a supported accounting software for ingestion into a | `AccountType` | *string* | :heavy_minus_sign: | The type of bank account e.g. Credit. | | | `AccountNumber` | *string* | :heavy_minus_sign: | The account number. | | | `SortCode` | *string* | :heavy_minus_sign: | The sort code. | | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `Balance` | *decimal* | :heavy_minus_sign: | The latest balance for the bank account. | | -| `ModifiedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Status` | [SourceAccountStatus](../../Models/Components/SourceAccountStatus.md) | :heavy_minus_sign: | Status of the source account. | | -| `FeedStartDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `FeedStartDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/SourceAccountPrototype.md b/lending/docs/Models/Components/SourceAccountPrototype.md index 9153044f..60030a98 100644 --- a/lending/docs/Models/Components/SourceAccountPrototype.md +++ b/lending/docs/Models/Components/SourceAccountPrototype.md @@ -10,6 +10,6 @@ | `AccountType` | *string* | :heavy_minus_sign: | The type of bank account e.g. Credit. | | | `AccountNumber` | *string* | :heavy_minus_sign: | The account number. | | | `SortCode` | *string* | :heavy_minus_sign: | The sort code. | | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `Balance` | *decimal* | :heavy_minus_sign: | The latest balance for the bank account. | | -| `ModifiedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | \ No newline at end of file +| `ModifiedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/SourceAccountStatus.md b/lending/docs/Models/Components/SourceAccountStatus.md index b10dbe8d..d25a78bd 100644 --- a/lending/docs/Models/Components/SourceAccountStatus.md +++ b/lending/docs/Models/Components/SourceAccountStatus.md @@ -2,6 +2,14 @@ Status of the source account. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = SourceAccountStatus.Pending; +``` + ## Values diff --git a/lending/docs/Models/Components/SourceAccountV2.md b/lending/docs/Models/Components/SourceAccountV2.md index 6da7d070..89b55f82 100644 --- a/lending/docs/Models/Components/SourceAccountV2.md +++ b/lending/docs/Models/Components/SourceAccountV2.md @@ -13,9 +13,9 @@ The target bank account in a supported accounting software for ingestion into a | `AccountNumber` | *string* | :heavy_check_mark: | The account number. | | | `SortCode` | *string* | :heavy_minus_sign: | The sort code. | | | `RoutingInfo` | [RoutingInfo](../../Models/Components/RoutingInfo.md) | :heavy_minus_sign: | Routing information for the bank. This does not include account number. | | -| `Currency` | *string* | :heavy_check_mark: | 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. | GBP | +| `Currency` | *string* | :heavy_check_mark: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `Balance` | *decimal* | :heavy_check_mark: | The latest balance for the bank account. | | | `AccountInfo` | [AccountInfo](../../Models/Components/AccountInfo.md) | :heavy_minus_sign: | N/A | | -| `ModifiedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Status` | [SourceAccountV2Status](../../Models/Components/SourceAccountV2Status.md) | :heavy_minus_sign: | Status of the source account. | | | `FeedStartDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates are represented using the ISO 8601 standard. Date fields are formatted as strings; for example:
```
2020-10-08
``` | 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Components/SourceAccountV2AccountType.md b/lending/docs/Models/Components/SourceAccountV2AccountType.md index 827c490b..26f9c7f0 100644 --- a/lending/docs/Models/Components/SourceAccountV2AccountType.md +++ b/lending/docs/Models/Components/SourceAccountV2AccountType.md @@ -2,6 +2,14 @@ The type of bank account e.g. checking, savings, loan, creditCard, prepaidCard. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = SourceAccountV2AccountType.Checking; +``` + ## Values diff --git a/lending/docs/Models/Components/SourceAccountV2Prototype.md b/lending/docs/Models/Components/SourceAccountV2Prototype.md index 120a01d9..fa067a53 100644 --- a/lending/docs/Models/Components/SourceAccountV2Prototype.md +++ b/lending/docs/Models/Components/SourceAccountV2Prototype.md @@ -11,7 +11,7 @@ | `AccountNumber` | *string* | :heavy_check_mark: | The account number. | | | `RoutingInfo` | [RoutingInfo](../../Models/Components/RoutingInfo.md) | :heavy_minus_sign: | Routing information for the bank. This does not include account number. | | | `SortCode` | *string* | :heavy_minus_sign: | The sort code. | | -| `Currency` | *string* | :heavy_check_mark: | 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. | GBP | +| `Currency` | *string* | :heavy_check_mark: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `Balance` | *decimal* | :heavy_check_mark: | The latest balance for the bank account. | | -| `ModifiedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `ModifiedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `AccountInfo` | [AccountInfo](../../Models/Components/AccountInfo.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/Models/Components/SourceAccountV2Status.md b/lending/docs/Models/Components/SourceAccountV2Status.md index db69a132..a7e00f41 100644 --- a/lending/docs/Models/Components/SourceAccountV2Status.md +++ b/lending/docs/Models/Components/SourceAccountV2Status.md @@ -2,6 +2,14 @@ Status of the source account. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = SourceAccountV2Status.Pending; +``` + ## Values diff --git a/lending/docs/Models/Components/SourceType.md b/lending/docs/Models/Components/SourceType.md index 3ddd34f7..e6d07f55 100644 --- a/lending/docs/Models/Components/SourceType.md +++ b/lending/docs/Models/Components/SourceType.md @@ -2,6 +2,14 @@ The type of platform of the connection. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = SourceType.Accounting; +``` + ## Values diff --git a/lending/docs/Models/Components/StartUploadSessionRequestDataType.md b/lending/docs/Models/Components/StartUploadSessionRequestDataType.md index 3d7782f6..96153c56 100644 --- a/lending/docs/Models/Components/StartUploadSessionRequestDataType.md +++ b/lending/docs/Models/Components/StartUploadSessionRequestDataType.md @@ -2,6 +2,14 @@ A key for a Codat data type. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = StartUploadSessionRequestDataType.BankingAccounts; +``` + ## Values diff --git a/lending/docs/Models/Components/Status.md b/lending/docs/Models/Components/Status.md index c15395ba..96697091 100644 --- a/lending/docs/Models/Components/Status.md +++ b/lending/docs/Models/Components/Status.md @@ -2,6 +2,14 @@ The current status of the dataset. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = Status.Initial; +``` + ## Values diff --git a/lending/docs/Models/Components/SupplierStatus.md b/lending/docs/Models/Components/SupplierStatus.md index 328b27e1..2160ff04 100644 --- a/lending/docs/Models/Components/SupplierStatus.md +++ b/lending/docs/Models/Components/SupplierStatus.md @@ -2,6 +2,14 @@ Status of the supplier. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = SupplierStatus.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/TaxComponentRef.md b/lending/docs/Models/Components/TaxComponentRef.md index e6fd7997..9321d769 100644 --- a/lending/docs/Models/Components/TaxComponentRef.md +++ b/lending/docs/Models/Components/TaxComponentRef.md @@ -5,7 +5,7 @@ Taxes rates reference object depending on the rates being available on source co ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- | -| `Id` | *string* | :heavy_check_mark: | The unique identitifer of the tax component being referenced. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `Name` | *string* | :heavy_check_mark: | Name of the tax component being referenced. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `Id` | *string* | :heavy_check_mark: | The unique identitifer of the tax component being referenced. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `Name` | *string* | :heavy_check_mark: | Name of the tax component being referenced. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/TrackingRecordRefDataType.md b/lending/docs/Models/Components/TrackingRecordRefDataType.md index 37145631..ab20140d 100644 --- a/lending/docs/Models/Components/TrackingRecordRefDataType.md +++ b/lending/docs/Models/Components/TrackingRecordRefDataType.md @@ -2,6 +2,14 @@ Name of underlying data type. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = TrackingRecordRefDataType.Customers; +``` + ## Values diff --git a/lending/docs/Models/Components/TransactionCategoryStatus.md b/lending/docs/Models/Components/TransactionCategoryStatus.md index af57627a..2a4b21f6 100644 --- a/lending/docs/Models/Components/TransactionCategoryStatus.md +++ b/lending/docs/Models/Components/TransactionCategoryStatus.md @@ -2,6 +2,14 @@ The status of the transaction category. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = TransactionCategoryStatus.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/TransactionCode.md b/lending/docs/Models/Components/TransactionCode.md index a9233e1d..628c89f3 100644 --- a/lending/docs/Models/Components/TransactionCode.md +++ b/lending/docs/Models/Components/TransactionCode.md @@ -2,6 +2,14 @@ Code to identify the underlying transaction. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = TransactionCode.Unknown; +``` + ## Values diff --git a/lending/docs/Models/Components/TransactionSourceRef.md b/lending/docs/Models/Components/TransactionSourceRef.md index d5974109..ccad9947 100644 --- a/lending/docs/Models/Components/TransactionSourceRef.md +++ b/lending/docs/Models/Components/TransactionSourceRef.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | ------------------------------------------------------------------------- | -| `Id` | *string* | :heavy_check_mark: | The unique identitifer of the record being referenced | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `Type` | [TransactionSourceType](../../Models/Components/TransactionSourceType.md) | :heavy_check_mark: | The type of source the transaction arose. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `Id` | *string* | :heavy_check_mark: | The unique identitifer of the record being referenced | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `Type` | [TransactionSourceType](../../Models/Components/TransactionSourceType.md) | :heavy_check_mark: | The type of source the transaction arose. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/TransactionSourceType.md b/lending/docs/Models/Components/TransactionSourceType.md index b0110df8..23a1ccf5 100644 --- a/lending/docs/Models/Components/TransactionSourceType.md +++ b/lending/docs/Models/Components/TransactionSourceType.md @@ -2,6 +2,14 @@ The type of source the transaction arose. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = TransactionSourceType.Fee; +``` + ## Values diff --git a/lending/docs/Models/Components/TransactionType.md b/lending/docs/Models/Components/TransactionType.md index c3234489..c80d8c2e 100644 --- a/lending/docs/Models/Components/TransactionType.md +++ b/lending/docs/Models/Components/TransactionType.md @@ -10,6 +10,14 @@ The type of the platform transaction: - `Refund` — Refunds to a customer's credit or debit card. - `Transfer` — Secure transfer of funds to the seller's bank account. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = TransactionType.Payment; +``` + ## Values diff --git a/lending/docs/Models/Components/TransferAccount.md b/lending/docs/Models/Components/TransferAccount.md index c31781a8..4d334a5e 100644 --- a/lending/docs/Models/Components/TransferAccount.md +++ b/lending/docs/Models/Components/TransferAccount.md @@ -8,5 +8,5 @@ Account details of the account sending or receiving the transfer. | Field | Type | Required | Description | Example | | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `AccountRef` | [AccountingRecordRef](../../Models/Components/AccountingRecordRef.md) | :heavy_minus_sign: | Links the current record to the underlying record or data type that created it.

For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model. | | -| `Currency` | *string* | :heavy_minus_sign: | 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. | GBP | +| `Currency` | *string* | :heavy_minus_sign: | 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. | **Example 1:** GBP
**Example 2:** USD
**Example 3:** EUR | | `Amount` | *decimal* | :heavy_minus_sign: | The amount transferred between accounts. | | \ No newline at end of file diff --git a/lending/docs/Models/Components/Type.md b/lending/docs/Models/Components/Type.md index 023a8fb3..39f76e14 100644 --- a/lending/docs/Models/Components/Type.md +++ b/lending/docs/Models/Components/Type.md @@ -2,6 +2,14 @@ The type of phone number +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = Type.Primary; +``` + ## Values diff --git a/lending/docs/Models/Components/WebLinkType.md b/lending/docs/Models/Components/WebLinkType.md index a091ba93..f5de1509 100644 --- a/lending/docs/Models/Components/WebLinkType.md +++ b/lending/docs/Models/Components/WebLinkType.md @@ -2,6 +2,14 @@ The type of the weblink. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = WebLinkType.Website; +``` + ## Values diff --git a/lending/docs/Models/Components/ZeroDataType.md b/lending/docs/Models/Components/ZeroDataType.md index 99f13572..8ea193ff 100644 --- a/lending/docs/Models/Components/ZeroDataType.md +++ b/lending/docs/Models/Components/ZeroDataType.md @@ -2,6 +2,14 @@ Allowed name of the 'dataType'. +## Example Usage + +```csharp +using Codat.Lending.Models.Components; + +var value = ZeroDataType.PurchaseOrders; +``` + ## Values diff --git a/lending/docs/Models/Requests/CreateBankTransactionsRequest.md b/lending/docs/Models/Requests/CreateBankTransactionsRequest.md index 3cf1acaf..be7cbae1 100644 --- a/lending/docs/Models/Requests/CreateBankTransactionsRequest.md +++ b/lending/docs/Models/Requests/CreateBankTransactionsRequest.md @@ -3,11 +3,11 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `AccountId` | *string* | :heavy_check_mark: | Unique identifier for an account. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `TimeoutInMinutes` | *int* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | -| `AllowSyncOnPushComplete` | *bool* | :heavy_minus_sign: | Allow a sync upon push completion. | | -| `AccountingCreateBankTransactions` | [AccountingCreateBankTransactions](../../Models/Components/AccountingCreateBankTransactions.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `AccountId` | *string* | :heavy_check_mark: | Unique identifier for an account. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `TimeoutInMinutes` | *int* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | +| `AllowSyncOnPushComplete` | *bool* | :heavy_minus_sign: | Allow a sync upon push completion. | | +| `AccountingCreateBankTransactions` | [AccountingCreateBankTransactions](../../Models/Components/AccountingCreateBankTransactions.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/Models/Requests/DownloadAccountingBillAttachmentRequest.md b/lending/docs/Models/Requests/DownloadAccountingBillAttachmentRequest.md index 9b9d6e90..55ed2b45 100644 --- a/lending/docs/Models/Requests/DownloadAccountingBillAttachmentRequest.md +++ b/lending/docs/Models/Requests/DownloadAccountingBillAttachmentRequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `BillId` | *string* | :heavy_check_mark: | Unique identifier for a bill. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `BillId` | *string* | :heavy_check_mark: | Unique identifier for a bill. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/Models/Requests/DownloadAccountingCustomerAttachmentRequest.md b/lending/docs/Models/Requests/DownloadAccountingCustomerAttachmentRequest.md index f9795b7d..6be358a6 100644 --- a/lending/docs/Models/Requests/DownloadAccountingCustomerAttachmentRequest.md +++ b/lending/docs/Models/Requests/DownloadAccountingCustomerAttachmentRequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `CustomerId` | *string* | :heavy_check_mark: | Unique identifier for a customer. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `CustomerId` | *string* | :heavy_check_mark: | Unique identifier for a customer. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/Models/Requests/DownloadAccountingDirectCostAttachmentRequest.md b/lending/docs/Models/Requests/DownloadAccountingDirectCostAttachmentRequest.md index 3fdc9e21..8ab8350a 100644 --- a/lending/docs/Models/Requests/DownloadAccountingDirectCostAttachmentRequest.md +++ b/lending/docs/Models/Requests/DownloadAccountingDirectCostAttachmentRequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `DirectCostId` | *string* | :heavy_check_mark: | Unique identifier for a direct cost. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `DirectCostId` | *string* | :heavy_check_mark: | Unique identifier for a direct cost. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/Models/Requests/DownloadAccountingDirectIncomeAttachmentRequest.md b/lending/docs/Models/Requests/DownloadAccountingDirectIncomeAttachmentRequest.md index dd1442ec..3102f95d 100644 --- a/lending/docs/Models/Requests/DownloadAccountingDirectIncomeAttachmentRequest.md +++ b/lending/docs/Models/Requests/DownloadAccountingDirectIncomeAttachmentRequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `DirectIncomeId` | *string* | :heavy_check_mark: | Unique identifier for a direct income. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `DirectIncomeId` | *string* | :heavy_check_mark: | Unique identifier for a direct income. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/Models/Requests/DownloadAccountingInvoiceAttachmentRequest.md b/lending/docs/Models/Requests/DownloadAccountingInvoiceAttachmentRequest.md index 2d95962e..89e1bf13 100644 --- a/lending/docs/Models/Requests/DownloadAccountingInvoiceAttachmentRequest.md +++ b/lending/docs/Models/Requests/DownloadAccountingInvoiceAttachmentRequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `InvoiceId` | *string* | :heavy_check_mark: | Unique identifier for an invoice. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `InvoiceId` | *string* | :heavy_check_mark: | Unique identifier for an invoice. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/Models/Requests/DownloadAccountingInvoicePdfRequest.md b/lending/docs/Models/Requests/DownloadAccountingInvoicePdfRequest.md index a747ae32..44e2a7d4 100644 --- a/lending/docs/Models/Requests/DownloadAccountingInvoicePdfRequest.md +++ b/lending/docs/Models/Requests/DownloadAccountingInvoicePdfRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `InvoiceId` | *string* | :heavy_check_mark: | Unique identifier for an invoice. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `InvoiceId` | *string* | :heavy_check_mark: | Unique identifier for an invoice. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/DownloadAccountingSupplierAttachmentRequest.md b/lending/docs/Models/Requests/DownloadAccountingSupplierAttachmentRequest.md index 64ad7d5b..0047eccc 100644 --- a/lending/docs/Models/Requests/DownloadAccountingSupplierAttachmentRequest.md +++ b/lending/docs/Models/Requests/DownloadAccountingSupplierAttachmentRequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `SupplierId` | *string* | :heavy_check_mark: | Unique identifier for a supplier. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `SupplierId` | *string* | :heavy_check_mark: | Unique identifier for a supplier. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/Models/Requests/DownloadFilesRequest.md b/lending/docs/Models/Requests/DownloadFilesRequest.md index 304f559d..90b51135 100644 --- a/lending/docs/Models/Requests/DownloadFilesRequest.md +++ b/lending/docs/Models/Requests/DownloadFilesRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `Date` | *string* | :heavy_minus_sign: | Only download files uploaded on this date. | 2022-10-23T00:00:00Z | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `Date` | *string* | :heavy_minus_sign: | Only download files uploaded on this date. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GenerateLoanSummaryQueryParamSourceType.md b/lending/docs/Models/Requests/GenerateLoanSummaryQueryParamSourceType.md index 2431d749..70a1bd9d 100644 --- a/lending/docs/Models/Requests/GenerateLoanSummaryQueryParamSourceType.md +++ b/lending/docs/Models/Requests/GenerateLoanSummaryQueryParamSourceType.md @@ -2,6 +2,14 @@ Data source type. +## Example Usage + +```csharp +using Codat.Lending.Models.Requests; + +var value = GenerateLoanSummaryQueryParamSourceType.Banking; +``` + ## Values diff --git a/lending/docs/Models/Requests/GetAccountingAccountRequest.md b/lending/docs/Models/Requests/GetAccountingAccountRequest.md index 1cb86db5..7ad74f4c 100644 --- a/lending/docs/Models/Requests/GetAccountingAccountRequest.md +++ b/lending/docs/Models/Requests/GetAccountingAccountRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `AccountId` | *string* | :heavy_check_mark: | Unique identifier for an account. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `AccountId` | *string* | :heavy_check_mark: | Unique identifier for an account. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetAccountingBalanceSheetRequest.md b/lending/docs/Models/Requests/GetAccountingBalanceSheetRequest.md index c5e5f647..d41b37ef 100644 --- a/lending/docs/Models/Requests/GetAccountingBalanceSheetRequest.md +++ b/lending/docs/Models/Requests/GetAccountingBalanceSheetRequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `PeriodLength` | *int* | :heavy_check_mark: | Number of months defining the period of interest. | 4 | -| `PeriodsToCompare` | *int* | :heavy_check_mark: | Number of periods with `periodLength` to compare. | 20 | -| `StartMonth` | *string* | :heavy_minus_sign: | The month the report starts from. | 2022-10-23T00:00:00Z | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `PeriodLength` | *int* | :heavy_check_mark: | Number of months defining the period of interest. | 4 | +| `PeriodsToCompare` | *int* | :heavy_check_mark: | Number of periods with `periodLength` to compare. | 20 | +| `StartMonth` | *string* | :heavy_minus_sign: | The month the report starts from. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetAccountingBankAccountRequest.md b/lending/docs/Models/Requests/GetAccountingBankAccountRequest.md index 1704f057..20012dc0 100644 --- a/lending/docs/Models/Requests/GetAccountingBankAccountRequest.md +++ b/lending/docs/Models/Requests/GetAccountingBankAccountRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `AccountId` | *string* | :heavy_check_mark: | Unique identifier for an account. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `AccountId` | *string* | :heavy_check_mark: | Unique identifier for an account. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetAccountingBillAttachmentRequest.md b/lending/docs/Models/Requests/GetAccountingBillAttachmentRequest.md index 363abc66..4f73a91f 100644 --- a/lending/docs/Models/Requests/GetAccountingBillAttachmentRequest.md +++ b/lending/docs/Models/Requests/GetAccountingBillAttachmentRequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `BillId` | *string* | :heavy_check_mark: | Unique identifier for a bill. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `BillId` | *string* | :heavy_check_mark: | Unique identifier for a bill. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetAccountingBillCreditNoteRequest.md b/lending/docs/Models/Requests/GetAccountingBillCreditNoteRequest.md index 3564ab51..5e503498 100644 --- a/lending/docs/Models/Requests/GetAccountingBillCreditNoteRequest.md +++ b/lending/docs/Models/Requests/GetAccountingBillCreditNoteRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | ----------------------------------------- | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `BillCreditNoteId` | *string* | :heavy_check_mark: | Unique identifier for a bill credit note. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `BillCreditNoteId` | *string* | :heavy_check_mark: | Unique identifier for a bill credit note. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetAccountingBillPaymentRequest.md b/lending/docs/Models/Requests/GetAccountingBillPaymentRequest.md index c1c6e981..9c818971 100644 --- a/lending/docs/Models/Requests/GetAccountingBillPaymentRequest.md +++ b/lending/docs/Models/Requests/GetAccountingBillPaymentRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | ------------------------------------- | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `BillPaymentId` | *string* | :heavy_check_mark: | Unique identifier for a bill payment. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `BillPaymentId` | *string* | :heavy_check_mark: | Unique identifier for a bill payment. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetAccountingBillPaymentResponse.md b/lending/docs/Models/Requests/GetAccountingBillPaymentResponse.md index 1eac691e..bf4d7f71 100644 --- a/lending/docs/Models/Requests/GetAccountingBillPaymentResponse.md +++ b/lending/docs/Models/Requests/GetAccountingBillPaymentResponse.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | -| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | -| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | -| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | -| `AccountingBillPayment` | [AccountingBillPayment](../../Models/Components/AccountingBillPayment.md) | :heavy_minus_sign: | Success | {
"totalAmount": 1000,
"lines": [
{
"amount": 1000,
"links": [
{
"type": "Bill",
"id": "x",
"amount": -1000
}
]
}
]
} | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `ContentType` | *string* | :heavy_check_mark: | HTTP response content type for this operation | | +| `StatusCode` | *int* | :heavy_check_mark: | HTTP response status code for this operation | | +| `RawResponse` | [HttpResponseMessage](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httpresponsemessage?view=net-5.0) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | | +| `AccountingBillPayment` | [AccountingBillPayment](../../Models/Components/AccountingBillPayment.md) | :heavy_minus_sign: | Success | **Example 1:** {
"totalAmount": 1000,
"lines": [
{
"amount": 1000,
"links": [
{
"type": "Bill",
"id": "x",
"amount": -1000
}
]
}
]
}
**Example 2:** {
"totalAmount": 0,
"lines": [
{
"amount": 0,
"links": [
{
"type": "Bill",
"id": "x",
"amount": -1000
},
{
"type": "CreditNote",
"id": "y",
"amount": 1000
}
]
}
]
}
**Example 3:** {
"totalAmount": 2000,
"lines": [
{
"amount": 1000,
"links": [
{
"type": "Bill",
"id": "x",
"amount": -1000
}
]
},
{
"amount": 1000,
"links": [
{
"type": "PaymentOnAccount",
"id": "y",
"amount": -1000
}
]
}
]
}
**Example 4:** {
"totalAmount": -1000,
"lines": [
{
"amount": -1000,
"links": [
{
"type": "CreditNote",
"id": "y",
"amount": 1000
}
]
}
]
}
**Example 5:** {
"totalAmount": -1000,
"lines": [
{
"amount": -1000,
"links": [
{
"type": "PaymentOnAccount",
"id": "y",
"amount": 1000
}
]
}
]
}
**Example 6:** {
"totalAmount": 250,
"lines": [
{
"amount": 0,
"links": [
{
"type": "Bill",
"id": "x",
"amount": -750
},
{
"type": "CreditNote",
"id": "y",
"amount": 750
}
]
},
{
"amount": 250,
"links": [
{
"type": "Bill",
"id": "x",
"amount": -250
}
]
}
]
}
**Example 7:** {
"totalAmount": 1000,
"lines": [
{
"amount": 1000,
"links": [
{
"type": "Bill",
"id": "x",
"amount": -1000
}
]
}
],
"modifiedDate": "2022-10-23T00:00:00Z",
"sourceModifiedDate": "2022-10-23T00:00:00Z"
}
**Example 8:** {
"totalAmount": 2000,
"lines": [
{
"amount": 0,
"links": [
{
"type": "Bill",
"id": "x",
"amount": -1000
},
{
"type": "CreditNote",
"id": "y",
"amount": 1000
}
]
},
{
"amount": 0,
"links": [
{
"type": "Bill",
"id": "x",
"amount": -1000
},
{
"type": "CreditNote",
"id": "z",
"amount": 1000
}
]
},
{
"amount": 1000,
"links": [
{
"type": "Bill",
"id": "x",
"amount": -1000
}
]
},
{
"amount": 1000,
"links": [
{
"type": "PaymentOnAccount",
"id": "customer-001",
"amount": -1000
}
]
}
]
}
**Example 9:** {
"totalAmount": 0,
"lines": [
{
"amount": 0,
"links": [
{
"type": "Bill",
"id": "w",
"amount": -1000
},
{
"type": "Bill",
"id": "x",
"amount": -1000
},
{
"type": "CreditNote",
"id": "y",
"amount": 1000
},
{
"type": "CreditNote",
"id": "z",
"amount": 1000
}
]
}
]
}
**Example 10:** {
"totalAmount": 1000,
"lines": [
{
"amount": 1000,
"links": [
{
"type": "Bill",
"id": "x",
"amount": -1000
}
]
}
],
"modifiedDate": "2022-10-23T00:00:00Z",
"sourceModifiedDate": "2022-10-23T00:00:00Z"
}
**Example 11:** {
"id": "001",
"totalAmount": 5000,
"date": "1901-01-01",
"lines": [
{
"amount": 1000,
"links": [
{
"type": "Bill",
"id": "x",
"amount": -1000
}
]
},
{
"amount": 4000,
"links": [
{
"type": "PaymentOnAccount",
"id": "y",
"amount": -4000
}
]
}
]
}
**Example 12:** {
"id": "001",
"totalAmount": 5000,
"date": "1901-01-01",
"lines": [
{
"amount": 1000,
"links": [
{
"type": "Bill",
"id": "x",
"amount": -1000
}
]
},
{
"amount": 1000,
"links": [
{
"type": "Bill",
"id": "y",
"amount": -1000
}
]
},
{
"amount": 3000,
"links": [
{
"type": "PaymentOnAccount",
"id": "y",
"amount": -3000
}
]
}
]
}
**Example 13:** {
"totalAmount": 500,
"lines": [
{
"amount": 500,
"links": [
{
"type": "Bill",
"id": "a",
"amount": -1000
},
{
"type": "Bill",
"id": "b",
"amount": -1000
},
{
"type": "CreditNote",
"id": "y",
"amount": 750
},
{
"type": "CreditNote",
"id": "z",
"amount": 750
}
]
}
]
} | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetAccountingBillRequest.md b/lending/docs/Models/Requests/GetAccountingBillRequest.md index f2937fe7..7322ba95 100644 --- a/lending/docs/Models/Requests/GetAccountingBillRequest.md +++ b/lending/docs/Models/Requests/GetAccountingBillRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `BillId` | *string* | :heavy_check_mark: | Unique identifier for a bill. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `BillId` | *string* | :heavy_check_mark: | Unique identifier for a bill. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetAccountingCashFlowStatementRequest.md b/lending/docs/Models/Requests/GetAccountingCashFlowStatementRequest.md index fd240301..08722df2 100644 --- a/lending/docs/Models/Requests/GetAccountingCashFlowStatementRequest.md +++ b/lending/docs/Models/Requests/GetAccountingCashFlowStatementRequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `PeriodLength` | *int* | :heavy_check_mark: | Number of months defining the period of interest. | 4 | -| `PeriodsToCompare` | *int* | :heavy_check_mark: | Number of periods with `periodLength` to compare. | 20 | -| `StartMonth` | *string* | :heavy_minus_sign: | The month the report starts from. | 2022-10-23T00:00:00Z | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `PeriodLength` | *int* | :heavy_check_mark: | Number of months defining the period of interest. | 4 | +| `PeriodsToCompare` | *int* | :heavy_check_mark: | Number of periods with `periodLength` to compare. | 20 | +| `StartMonth` | *string* | :heavy_minus_sign: | The month the report starts from. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetAccountingCustomerAttachmentRequest.md b/lending/docs/Models/Requests/GetAccountingCustomerAttachmentRequest.md index fb835f8e..50329cc5 100644 --- a/lending/docs/Models/Requests/GetAccountingCustomerAttachmentRequest.md +++ b/lending/docs/Models/Requests/GetAccountingCustomerAttachmentRequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `CustomerId` | *string* | :heavy_check_mark: | Unique identifier for a customer. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `CustomerId` | *string* | :heavy_check_mark: | Unique identifier for a customer. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetAccountingCustomerRequest.md b/lending/docs/Models/Requests/GetAccountingCustomerRequest.md index 38611a6c..a44d7b60 100644 --- a/lending/docs/Models/Requests/GetAccountingCustomerRequest.md +++ b/lending/docs/Models/Requests/GetAccountingCustomerRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `CustomerId` | *string* | :heavy_check_mark: | Unique identifier for a customer. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `CustomerId` | *string* | :heavy_check_mark: | Unique identifier for a customer. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetAccountingDirectCostAttachmentRequest.md b/lending/docs/Models/Requests/GetAccountingDirectCostAttachmentRequest.md index e0f95423..54552ce6 100644 --- a/lending/docs/Models/Requests/GetAccountingDirectCostAttachmentRequest.md +++ b/lending/docs/Models/Requests/GetAccountingDirectCostAttachmentRequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `DirectCostId` | *string* | :heavy_check_mark: | Unique identifier for a direct cost. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `DirectCostId` | *string* | :heavy_check_mark: | Unique identifier for a direct cost. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetAccountingDirectCostRequest.md b/lending/docs/Models/Requests/GetAccountingDirectCostRequest.md index 32f08072..da971ed6 100644 --- a/lending/docs/Models/Requests/GetAccountingDirectCostRequest.md +++ b/lending/docs/Models/Requests/GetAccountingDirectCostRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `DirectCostId` | *string* | :heavy_check_mark: | Unique identifier for a direct cost. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `DirectCostId` | *string* | :heavy_check_mark: | Unique identifier for a direct cost. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetAccountingDirectIncomeAttachmentRequest.md b/lending/docs/Models/Requests/GetAccountingDirectIncomeAttachmentRequest.md index 7bca0a06..65247e11 100644 --- a/lending/docs/Models/Requests/GetAccountingDirectIncomeAttachmentRequest.md +++ b/lending/docs/Models/Requests/GetAccountingDirectIncomeAttachmentRequest.md @@ -3,10 +3,10 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `DirectIncomeId` | *string* | :heavy_check_mark: | Unique identifier for a direct income. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `TimeoutInMinutes` | *int* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `DirectIncomeId` | *string* | :heavy_check_mark: | Unique identifier for a direct income. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `TimeoutInMinutes` | *int* | :heavy_minus_sign: | Time limit for the push operation to complete before it is timed out. | | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetAccountingDirectIncomeRequest.md b/lending/docs/Models/Requests/GetAccountingDirectIncomeRequest.md index a017b933..182a0b08 100644 --- a/lending/docs/Models/Requests/GetAccountingDirectIncomeRequest.md +++ b/lending/docs/Models/Requests/GetAccountingDirectIncomeRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `DirectIncomeId` | *string* | :heavy_check_mark: | Unique identifier for a direct income. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `DirectIncomeId` | *string* | :heavy_check_mark: | Unique identifier for a direct income. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetAccountingInvoiceAttachmentRequest.md b/lending/docs/Models/Requests/GetAccountingInvoiceAttachmentRequest.md index 8aa416d9..18f755f4 100644 --- a/lending/docs/Models/Requests/GetAccountingInvoiceAttachmentRequest.md +++ b/lending/docs/Models/Requests/GetAccountingInvoiceAttachmentRequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `InvoiceId` | *string* | :heavy_check_mark: | Unique identifier for an invoice. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `InvoiceId` | *string* | :heavy_check_mark: | Unique identifier for an invoice. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetAccountingInvoiceRequest.md b/lending/docs/Models/Requests/GetAccountingInvoiceRequest.md index 41908d49..a26c9df6 100644 --- a/lending/docs/Models/Requests/GetAccountingInvoiceRequest.md +++ b/lending/docs/Models/Requests/GetAccountingInvoiceRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `InvoiceId` | *string* | :heavy_check_mark: | Unique identifier for an invoice. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `InvoiceId` | *string* | :heavy_check_mark: | Unique identifier for an invoice. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetAccountingJournalEntryRequest.md b/lending/docs/Models/Requests/GetAccountingJournalEntryRequest.md index 38204c3c..338c0971 100644 --- a/lending/docs/Models/Requests/GetAccountingJournalEntryRequest.md +++ b/lending/docs/Models/Requests/GetAccountingJournalEntryRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `JournalEntryId` | *string* | :heavy_check_mark: | Unique identifier for a journal entry. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `JournalEntryId` | *string* | :heavy_check_mark: | Unique identifier for a journal entry. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetAccountingPaymentRequest.md b/lending/docs/Models/Requests/GetAccountingPaymentRequest.md index 7c1a9555..c3a8111b 100644 --- a/lending/docs/Models/Requests/GetAccountingPaymentRequest.md +++ b/lending/docs/Models/Requests/GetAccountingPaymentRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `PaymentId` | *string* | :heavy_check_mark: | Unique identifier for a payment. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `PaymentId` | *string* | :heavy_check_mark: | Unique identifier for a payment. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetAccountingProfitAndLossRequest.md b/lending/docs/Models/Requests/GetAccountingProfitAndLossRequest.md index 77b9ab96..a955d003 100644 --- a/lending/docs/Models/Requests/GetAccountingProfitAndLossRequest.md +++ b/lending/docs/Models/Requests/GetAccountingProfitAndLossRequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `PeriodLength` | *int* | :heavy_check_mark: | Number of months defining the period of interest. | 4 | -| `PeriodsToCompare` | *int* | :heavy_check_mark: | Number of periods with `periodLength` to compare. | 20 | -| `StartMonth` | *string* | :heavy_minus_sign: | The month the report starts from. | 2022-10-23T00:00:00Z | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | ----------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `PeriodLength` | *int* | :heavy_check_mark: | Number of months defining the period of interest. | 4 | +| `PeriodsToCompare` | *int* | :heavy_check_mark: | Number of periods with `periodLength` to compare. | 20 | +| `StartMonth` | *string* | :heavy_minus_sign: | The month the report starts from. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetAccountingSupplierAttachmentRequest.md b/lending/docs/Models/Requests/GetAccountingSupplierAttachmentRequest.md index d7215546..b144e3be 100644 --- a/lending/docs/Models/Requests/GetAccountingSupplierAttachmentRequest.md +++ b/lending/docs/Models/Requests/GetAccountingSupplierAttachmentRequest.md @@ -3,9 +3,9 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `SupplierId` | *string* | :heavy_check_mark: | Unique identifier for a supplier. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `SupplierId` | *string* | :heavy_check_mark: | Unique identifier for a supplier. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `AttachmentId` | *string* | :heavy_check_mark: | Unique identifier for an attachment. | 8a210b68-6988-11ed-a1eb-0242ac120002 | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetAccountingSupplierRequest.md b/lending/docs/Models/Requests/GetAccountingSupplierRequest.md index 403ca6b0..a8656cac 100644 --- a/lending/docs/Models/Requests/GetAccountingSupplierRequest.md +++ b/lending/docs/Models/Requests/GetAccountingSupplierRequest.md @@ -3,7 +3,7 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `SupplierId` | *string* | :heavy_check_mark: | Unique identifier for a supplier. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `SupplierId` | *string* | :heavy_check_mark: | Unique identifier for a supplier. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetAccountingTransferRequest.md b/lending/docs/Models/Requests/GetAccountingTransferRequest.md index 6450b4b4..46f6e235 100644 --- a/lending/docs/Models/Requests/GetAccountingTransferRequest.md +++ b/lending/docs/Models/Requests/GetAccountingTransferRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `TransferId` | *string* | :heavy_check_mark: | Unique identifier for a transfer. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `TransferId` | *string* | :heavy_check_mark: | Unique identifier for a transfer. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetBankingAccountRequest.md b/lending/docs/Models/Requests/GetBankingAccountRequest.md index 4cc80e8c..cd4d2701 100644 --- a/lending/docs/Models/Requests/GetBankingAccountRequest.md +++ b/lending/docs/Models/Requests/GetBankingAccountRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `AccountId` | *string* | :heavy_check_mark: | Unique identifier for an account. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `AccountId` | *string* | :heavy_check_mark: | Unique identifier for an account. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetCommerceCustomerRequest.md b/lending/docs/Models/Requests/GetCommerceCustomerRequest.md index 0b5d95a9..44917f9c 100644 --- a/lending/docs/Models/Requests/GetCommerceCustomerRequest.md +++ b/lending/docs/Models/Requests/GetCommerceCustomerRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `CustomerId` | *string* | :heavy_check_mark: | Unique identifier for a customer. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `CustomerId` | *string* | :heavy_check_mark: | Unique identifier for a customer. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetCommerceDisputeRequest.md b/lending/docs/Models/Requests/GetCommerceDisputeRequest.md index d8067a5a..4c210e7f 100644 --- a/lending/docs/Models/Requests/GetCommerceDisputeRequest.md +++ b/lending/docs/Models/Requests/GetCommerceDisputeRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `DisputeId` | *string* | :heavy_check_mark: | Unique identifier for a dispute. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `DisputeId` | *string* | :heavy_check_mark: | Unique identifier for a dispute. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetCommerceLocationRequest.md b/lending/docs/Models/Requests/GetCommerceLocationRequest.md index 9d761662..973c8dcc 100644 --- a/lending/docs/Models/Requests/GetCommerceLocationRequest.md +++ b/lending/docs/Models/Requests/GetCommerceLocationRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `LocationId` | *string* | :heavy_check_mark: | Unique identifier for a location. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `LocationId` | *string* | :heavy_check_mark: | Unique identifier for a location. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetCommerceOrderRequest.md b/lending/docs/Models/Requests/GetCommerceOrderRequest.md index a92cb8c8..4ec11e10 100644 --- a/lending/docs/Models/Requests/GetCommerceOrderRequest.md +++ b/lending/docs/Models/Requests/GetCommerceOrderRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `OrderId` | *string* | :heavy_check_mark: | Unique identifier for an order. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `OrderId` | *string* | :heavy_check_mark: | Unique identifier for an order. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetCommercePaymentMethodRequest.md b/lending/docs/Models/Requests/GetCommercePaymentMethodRequest.md index 1ba1c5e0..b292a168 100644 --- a/lending/docs/Models/Requests/GetCommercePaymentMethodRequest.md +++ b/lending/docs/Models/Requests/GetCommercePaymentMethodRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | --------------------------------------- | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `PaymentMethodId` | *string* | :heavy_check_mark: | Unique identifier for a payment method. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `PaymentMethodId` | *string* | :heavy_check_mark: | Unique identifier for a payment method. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetCommercePaymentRequest.md b/lending/docs/Models/Requests/GetCommercePaymentRequest.md index 92445f3c..f4b9f382 100644 --- a/lending/docs/Models/Requests/GetCommercePaymentRequest.md +++ b/lending/docs/Models/Requests/GetCommercePaymentRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `PaymentId` | *string* | :heavy_check_mark: | Unique identifier for a payment. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `PaymentId` | *string* | :heavy_check_mark: | Unique identifier for a payment. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetCommerceProductCategoryRequest.md b/lending/docs/Models/Requests/GetCommerceProductCategoryRequest.md index e50963d7..aa5ea09c 100644 --- a/lending/docs/Models/Requests/GetCommerceProductCategoryRequest.md +++ b/lending/docs/Models/Requests/GetCommerceProductCategoryRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `ProductId` | *string* | :heavy_check_mark: | Unique identifier for a product. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `ProductId` | *string* | :heavy_check_mark: | Unique identifier for a product. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetCommerceProductRequest.md b/lending/docs/Models/Requests/GetCommerceProductRequest.md index 96f6bc3c..514e8fd5 100644 --- a/lending/docs/Models/Requests/GetCommerceProductRequest.md +++ b/lending/docs/Models/Requests/GetCommerceProductRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `ProductId` | *string* | :heavy_check_mark: | Unique identifier for a product. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `ProductId` | *string* | :heavy_check_mark: | Unique identifier for a product. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetCommerceTransactionRequest.md b/lending/docs/Models/Requests/GetCommerceTransactionRequest.md index 9c7490cb..bfc1fe81 100644 --- a/lending/docs/Models/Requests/GetCommerceTransactionRequest.md +++ b/lending/docs/Models/Requests/GetCommerceTransactionRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `TransactionId` | *string* | :heavy_check_mark: | Unique identifier for a transaction. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `TransactionId` | *string* | :heavy_check_mark: | Unique identifier for a transaction. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetCreateBankTransactionsModelRequest.md b/lending/docs/Models/Requests/GetCreateBankTransactionsModelRequest.md index 8fda6965..c4b972fd 100644 --- a/lending/docs/Models/Requests/GetCreateBankTransactionsModelRequest.md +++ b/lending/docs/Models/Requests/GetCreateBankTransactionsModelRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `AccountId` | *string* | :heavy_check_mark: | Unique identifier for an account. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `AccountId` | *string* | :heavy_check_mark: | Unique identifier for an account. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/GetLoanSummaryQueryParamSourceType.md b/lending/docs/Models/Requests/GetLoanSummaryQueryParamSourceType.md index 990ee90b..536d4824 100644 --- a/lending/docs/Models/Requests/GetLoanSummaryQueryParamSourceType.md +++ b/lending/docs/Models/Requests/GetLoanSummaryQueryParamSourceType.md @@ -2,6 +2,14 @@ Data source type. +## Example Usage + +```csharp +using Codat.Lending.Models.Requests; + +var value = GetLoanSummaryQueryParamSourceType.Banking; +``` + ## Values diff --git a/lending/docs/Models/Requests/ListAccountingBankAccountTransactionsRequest.md b/lending/docs/Models/Requests/ListAccountingBankAccountTransactionsRequest.md index b120cbaa..e05836ba 100644 --- a/lending/docs/Models/Requests/ListAccountingBankAccountTransactionsRequest.md +++ b/lending/docs/Models/Requests/ListAccountingBankAccountTransactionsRequest.md @@ -3,12 +3,12 @@ ## Fields -| Field | Type | Required | Description | Example | -| ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `AccountId` | *string* | :heavy_check_mark: | Unique identifier for an account. | 13d946f0-c5d5-42bc-b092-97ece17923ab | -| `Page` | *int* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | -| `PageSize` | *int* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | -| `Query` | *string* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee | -| `OrderBy` | *string* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `AccountId` | *string* | :heavy_check_mark: | Unique identifier for an account. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | +| `Page` | *int* | :heavy_minus_sign: | Page number. [Read more](https://docs.codat.io/using-the-api/paging). | 1 | +| `PageSize` | *int* | :heavy_minus_sign: | Number of records to return in a page. [Read more](https://docs.codat.io/using-the-api/paging). | 100 | +| `Query` | *string* | :heavy_minus_sign: | Codat query string. [Read more](https://docs.codat.io/using-the-api/querying). | id=e3334455-1aed-4e71-ab43-6bccf12092ee | +| `OrderBy` | *string* | :heavy_minus_sign: | Field to order results by. [Read more](https://docs.codat.io/using-the-api/ordering-results). | -modifiedDate | \ No newline at end of file diff --git a/lending/docs/Models/Requests/ListAccountingBillAttachmentsRequest.md b/lending/docs/Models/Requests/ListAccountingBillAttachmentsRequest.md index 1f377d8c..56a127fa 100644 --- a/lending/docs/Models/Requests/ListAccountingBillAttachmentsRequest.md +++ b/lending/docs/Models/Requests/ListAccountingBillAttachmentsRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `BillId` | *string* | :heavy_check_mark: | Unique identifier for a bill. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `BillId` | *string* | :heavy_check_mark: | Unique identifier for a bill. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/ListAccountingCustomerAttachmentsRequest.md b/lending/docs/Models/Requests/ListAccountingCustomerAttachmentsRequest.md index 10afac71..9a33f6d5 100644 --- a/lending/docs/Models/Requests/ListAccountingCustomerAttachmentsRequest.md +++ b/lending/docs/Models/Requests/ListAccountingCustomerAttachmentsRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `CustomerId` | *string* | :heavy_check_mark: | Unique identifier for a customer. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `CustomerId` | *string* | :heavy_check_mark: | Unique identifier for a customer. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/ListAccountingDirectCostAttachmentsRequest.md b/lending/docs/Models/Requests/ListAccountingDirectCostAttachmentsRequest.md index 0c163709..b668c765 100644 --- a/lending/docs/Models/Requests/ListAccountingDirectCostAttachmentsRequest.md +++ b/lending/docs/Models/Requests/ListAccountingDirectCostAttachmentsRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `DirectCostId` | *string* | :heavy_check_mark: | Unique identifier for a direct cost. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `DirectCostId` | *string* | :heavy_check_mark: | Unique identifier for a direct cost. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/ListAccountingDirectIncomeAttachmentsRequest.md b/lending/docs/Models/Requests/ListAccountingDirectIncomeAttachmentsRequest.md index cc9efc95..3491230e 100644 --- a/lending/docs/Models/Requests/ListAccountingDirectIncomeAttachmentsRequest.md +++ b/lending/docs/Models/Requests/ListAccountingDirectIncomeAttachmentsRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -------------------------------------- | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `DirectIncomeId` | *string* | :heavy_check_mark: | Unique identifier for a direct income. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `DirectIncomeId` | *string* | :heavy_check_mark: | Unique identifier for a direct income. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/ListAccountingInvoiceAttachmentsRequest.md b/lending/docs/Models/Requests/ListAccountingInvoiceAttachmentsRequest.md index 292612cd..9a91fcdf 100644 --- a/lending/docs/Models/Requests/ListAccountingInvoiceAttachmentsRequest.md +++ b/lending/docs/Models/Requests/ListAccountingInvoiceAttachmentsRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `InvoiceId` | *string* | :heavy_check_mark: | Unique identifier for an invoice. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `InvoiceId` | *string* | :heavy_check_mark: | Unique identifier for an invoice. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/ListAccountingSupplierAttachmentsRequest.md b/lending/docs/Models/Requests/ListAccountingSupplierAttachmentsRequest.md index 14de60ec..182a9d7d 100644 --- a/lending/docs/Models/Requests/ListAccountingSupplierAttachmentsRequest.md +++ b/lending/docs/Models/Requests/ListAccountingSupplierAttachmentsRequest.md @@ -3,8 +3,8 @@ ## Fields -| Field | Type | Required | Description | Example | -| ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | ------------------------------------ | -| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | -| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | -| `SupplierId` | *string* | :heavy_check_mark: | Unique identifier for a supplier. | 13d946f0-c5d5-42bc-b092-97ece17923ab | \ No newline at end of file +| Field | Type | Required | Description | Example | +| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `CompanyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 | +| `ConnectionId` | *string* | :heavy_check_mark: | Unique identifier for a connection. | 2e9d2c44-f675-40ba-8049-353bfcb5e171 | +| `SupplierId` | *string* | :heavy_check_mark: | Unique identifier for a supplier. | **Example 1:** 13d946f0-c5d5-42bc-b092-97ece17923ab
**Example 2:** 9wg4lep4ush5cxs79pl8sozmsndbaukll3ind4g7buqbm1h2
**Example 3:** 7110701885
**Example 4:** EILBDVJVNUAGVKRQ | \ No newline at end of file diff --git a/lending/docs/Models/Requests/QueryParamSourceType.md b/lending/docs/Models/Requests/QueryParamSourceType.md index 02da6364..b18e7dac 100644 --- a/lending/docs/Models/Requests/QueryParamSourceType.md +++ b/lending/docs/Models/Requests/QueryParamSourceType.md @@ -2,6 +2,14 @@ Data source type. +## Example Usage + +```csharp +using Codat.Lending.Models.Requests; + +var value = QueryParamSourceType.Banking; +``` + ## Values diff --git a/lending/docs/Models/Requests/SourceType.md b/lending/docs/Models/Requests/SourceType.md index ea13cb9d..a01e3434 100644 --- a/lending/docs/Models/Requests/SourceType.md +++ b/lending/docs/Models/Requests/SourceType.md @@ -2,6 +2,14 @@ Data source type. +## Example Usage + +```csharp +using Codat.Lending.Models.Requests; + +var value = SourceType.Banking; +``` + ## Values diff --git a/lending/docs/Models/Webhooks/ReportsCreditModelGenerateSuccessfulReportGenerationWebhook.md b/lending/docs/Models/Webhooks/ReportsCreditModelGenerateSuccessfulReportGenerationWebhook.md index 70bca907..61e83fe5 100644 --- a/lending/docs/Models/Webhooks/ReportsCreditModelGenerateSuccessfulReportGenerationWebhook.md +++ b/lending/docs/Models/Webhooks/ReportsCreditModelGenerateSuccessfulReportGenerationWebhook.md @@ -6,6 +6,6 @@ | Field | Type | Required | Description | Example | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `Id` | *string* | :heavy_minus_sign: | Unique identifier of the event. | ba29118f-5406-4e59-b05c-ba307ca38d01 | -| `EventType` | *string* | :heavy_minus_sign: | The type of event. | reports.categorizedBankStatement.generate.successful | -| `GeneratedDate` | *string* | :heavy_minus_sign: | 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. | 2022-10-23T00:00:00Z | +| `EventType` | *string* | :heavy_minus_sign: | The type of event. | **Example 1:** reports.categorizedBankStatement.generate.successful
**Example 2:** reports.creditModel.generate.successful | +| `GeneratedDate` | *string* | :heavy_minus_sign: | 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. | **Example 1:** 2022-10-23T00:00:00Z
**Example 2:** 2022-10-23 | | `Payload` | [ReportGenerationPayload](../../Models/Components/ReportGenerationPayload.md) | :heavy_minus_sign: | N/A | | \ No newline at end of file diff --git a/lending/docs/sdks/accountbalances/README.md b/lending/docs/sdks/accountbalances/README.md index bdde70fc..826e8eda 100644 --- a/lending/docs/sdks/accountbalances/README.md +++ b/lending/docs/sdks/accountbalances/README.md @@ -15,9 +15,30 @@ The *List account balances* endpoint returns a list of [account balances](https: Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Basiq - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListBankingAccountBalancesRequest req = new ListBankingAccountBalancesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Banking.AccountBalances.ListAsync(req); + +// handle response +``` +### Example Usage: Plaid + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/accountingbankdata/README.md b/lending/docs/sdks/accountingbankdata/README.md index deedab2d..3102912e 100644 --- a/lending/docs/sdks/accountingbankdata/README.md +++ b/lending/docs/sdks/accountingbankdata/README.md @@ -17,9 +17,163 @@ The *List account bank transactions* endpoint returns a list of [bank account tr Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Dynamics 365 Business Central - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBankAccountTransactionsRequest req = new ListAccountingBankAccountTransactionsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountingBankData.ListTransactionsAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBankAccountTransactionsRequest req = new ListAccountingBankAccountTransactionsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountingBankData.ListTransactionsAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBankAccountTransactionsRequest req = new ListAccountingBankAccountTransactionsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountingBankData.ListTransactionsAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBankAccountTransactionsRequest req = new ListAccountingBankAccountTransactionsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountingBankData.ListTransactionsAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBankAccountTransactionsRequest req = new ListAccountingBankAccountTransactionsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountingBankData.ListTransactionsAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBankAccountTransactionsRequest req = new ListAccountingBankAccountTransactionsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountingBankData.ListTransactionsAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBankAccountTransactionsRequest req = new ListAccountingBankAccountTransactionsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountingBankData.ListTransactionsAsync(req); + +// handle response +``` +### Example Usage: Zoho Books + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/accounts/README.md b/lending/docs/sdks/accounts/README.md index 98a3a3d8..3be9a3fd 100644 --- a/lending/docs/sdks/accounts/README.md +++ b/lending/docs/sdks/accounts/README.md @@ -15,9 +15,349 @@ Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Clear Books - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingAccountsRequest req = new ListAccountingAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.FinancialStatements.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingAccountsRequest req = new ListAccountingAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.FinancialStatements.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingAccountsRequest req = new ListAccountingAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.FinancialStatements.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingAccountsRequest req = new ListAccountingAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.FinancialStatements.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingAccountsRequest req = new ListAccountingAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.FinancialStatements.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingAccountsRequest req = new ListAccountingAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.FinancialStatements.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingAccountsRequest req = new ListAccountingAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.FinancialStatements.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingAccountsRequest req = new ListAccountingAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.FinancialStatements.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingAccountsRequest req = new ListAccountingAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.FinancialStatements.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingAccountsRequest req = new ListAccountingAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.FinancialStatements.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingAccountsRequest req = new ListAccountingAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.FinancialStatements.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingAccountsRequest req = new ListAccountingAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.FinancialStatements.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingAccountsRequest req = new ListAccountingAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.FinancialStatements.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingAccountsRequest req = new ListAccountingAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.FinancialStatements.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingAccountsRequest req = new ListAccountingAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.FinancialStatements.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: Wave + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingAccountsRequest req = new ListAccountingAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.FinancialStatements.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingAccountsRequest req = new ListAccountingAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.FinancialStatements.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: Zoho Books + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -38,34 +378,357 @@ var res = await sdk.FinancialStatements.Accounts.ListAsync(req); ### Parameters -| Parameter | Type | Required | Description | -| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `request` | [ListAccountingAccountsRequest](../../Models/Requests/ListAccountingAccountsRequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `request` | [ListAccountingAccountsRequest](../../Models/Requests/ListAccountingAccountsRequest.md) | :heavy_check_mark: | The request object to use for the request. | + +### Response + +**[ListAccountingAccountsResponse](../../Models/Requests/ListAccountingAccountsResponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| Codat.Lending.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 409, 429 | application/json | +| Codat.Lending.Models.Errors.ErrorMessage | 500, 503 | application/json | +| Codat.Lending.Models.Errors.SDKException | 4XX, 5XX | \*/\* | + +## Get + +The *Get account* endpoint returns a single account for a given accountId. + +[Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions. + +Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + +### Example Usage: Clear Books + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAccountRequest req = new GetAccountingAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.FinancialStatements.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAccountRequest req = new GetAccountingAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.FinancialStatements.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -### Response +GetAccountingAccountRequest req = new GetAccountingAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; -**[ListAccountingAccountsResponse](../../Models/Requests/ListAccountingAccountsResponse.md)** +var res = await sdk.FinancialStatements.Accounts.GetAsync(req); -### Errors +// handle response +``` +### Example Usage: Exact (UK) -| Error Type | Status Code | Content Type | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| Codat.Lending.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 409, 429 | application/json | -| Codat.Lending.Models.Errors.ErrorMessage | 500, 503 | application/json | -| Codat.Lending.Models.Errors.SDKException | 4XX, 5XX | \*/\* | + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; -## Get +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -The *Get account* endpoint returns a single account for a given accountId. +GetAccountingAccountRequest req = new GetAccountingAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; -[Accounts](https://docs.codat.io/lending-api#/schemas/Account) are the categories a business uses to record accounting transactions. +var res = await sdk.FinancialStatements.Accounts.GetAsync(req); -Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAccountRequest req = new GetAccountingAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.FinancialStatements.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAccountRequest req = new GetAccountingAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.FinancialStatements.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAccountRequest req = new GetAccountingAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.FinancialStatements.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAccountRequest req = new GetAccountingAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.FinancialStatements.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAccountRequest req = new GetAccountingAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.FinancialStatements.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAccountRequest req = new GetAccountingAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.FinancialStatements.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAccountRequest req = new GetAccountingAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.FinancialStatements.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAccountRequest req = new GetAccountingAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.FinancialStatements.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAccountRequest req = new GetAccountingAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.FinancialStatements.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAccountRequest req = new GetAccountingAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.FinancialStatements.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAccountRequest req = new GetAccountingAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.FinancialStatements.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: Wave + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAccountRequest req = new GetAccountingAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.FinancialStatements.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: Xero -### Example Usage + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAccountRequest req = new GetAccountingAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.FinancialStatements.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: Zoho Books - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/accounttransactions/README.md b/lending/docs/sdks/accounttransactions/README.md index e87559ce..fa3914e5 100644 --- a/lending/docs/sdks/accounttransactions/README.md +++ b/lending/docs/sdks/accounttransactions/README.md @@ -16,9 +16,93 @@ The *List account transactions* endpoint returns a list of [account transactions Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Clear Books - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingAccountTransactionsRequest req = new ListAccountingAccountTransactionsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.AccountTransactions.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingAccountTransactionsRequest req = new ListAccountingAccountTransactionsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.AccountTransactions.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingAccountTransactionsRequest req = new ListAccountingAccountTransactionsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.AccountTransactions.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingAccountTransactionsRequest req = new ListAccountingAccountTransactionsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.AccountTransactions.ListAsync(req); + +// handle response +``` +### Example Usage: Xero + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -65,9 +149,89 @@ The *Get account transaction* endpoint returns a single account transaction for Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Clear Books + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAccountTransactionRequest req = new GetAccountingAccountTransactionRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountTransactionId = "", +}; + +var res = await sdk.Transactions.AccountTransactions.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAccountTransactionRequest req = new GetAccountingAccountTransactionRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountTransactionId = "", +}; + +var res = await sdk.Transactions.AccountTransactions.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAccountTransactionRequest req = new GetAccountingAccountTransactionRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountTransactionId = "", +}; + +var res = await sdk.Transactions.AccountTransactions.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAccountTransactionRequest req = new GetAccountingAccountTransactionRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountTransactionId = "", +}; + +var res = await sdk.Transactions.AccountTransactions.GetAsync(req); + +// handle response +``` +### Example Usage: Xero - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/balancesheet/README.md b/lending/docs/sdks/balancesheet/README.md index 037a2558..bda0d1ac 100644 --- a/lending/docs/sdks/balancesheet/README.md +++ b/lending/docs/sdks/balancesheet/README.md @@ -55,9 +55,324 @@ var res = await sdk.FinancialStatements.BalanceSheet.GetCategorizedAccountsAsync Gets the latest balance sheet for a company. -### Example Usage +### Example Usage: Clear Books + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBalanceSheetRequest req = new GetAccountingBalanceSheetRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.BalanceSheet.GetAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBalanceSheetRequest req = new GetAccountingBalanceSheetRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.BalanceSheet.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBalanceSheetRequest req = new GetAccountingBalanceSheetRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.BalanceSheet.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBalanceSheetRequest req = new GetAccountingBalanceSheetRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.BalanceSheet.GetAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBalanceSheetRequest req = new GetAccountingBalanceSheetRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.BalanceSheet.GetAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBalanceSheetRequest req = new GetAccountingBalanceSheetRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.BalanceSheet.GetAsync(req); + +// handle response +``` +### Example Usage: MYOB AccountRight and Essentials + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBalanceSheetRequest req = new GetAccountingBalanceSheetRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.BalanceSheet.GetAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBalanceSheetRequest req = new GetAccountingBalanceSheetRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.BalanceSheet.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBalanceSheetRequest req = new GetAccountingBalanceSheetRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.BalanceSheet.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBalanceSheetRequest req = new GetAccountingBalanceSheetRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.BalanceSheet.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBalanceSheetRequest req = new GetAccountingBalanceSheetRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.BalanceSheet.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBalanceSheetRequest req = new GetAccountingBalanceSheetRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.BalanceSheet.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBalanceSheetRequest req = new GetAccountingBalanceSheetRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.BalanceSheet.GetAsync(req); + +// handle response +``` +### Example Usage: Wave + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBalanceSheetRequest req = new GetAccountingBalanceSheetRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.BalanceSheet.GetAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBalanceSheetRequest req = new GetAccountingBalanceSheetRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.BalanceSheet.GetAsync(req); + +// handle response +``` +### Example Usage: Zoho Books - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/bankaccounts/README.md b/lending/docs/sdks/bankaccounts/README.md index bc7cbc16..77ad2946 100644 --- a/lending/docs/sdks/bankaccounts/README.md +++ b/lending/docs/sdks/bankaccounts/README.md @@ -18,9 +18,161 @@ The *Get create/update bank account model* endpoint returns the expected data fo See the *response examples* for integration-specific indicative models. -### Example Usage +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateUpdateBankAccountsModelRequest req = new GetCreateUpdateBankAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.BankAccounts.GetCreateUpdateModelAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateUpdateBankAccountsModelRequest req = new GetCreateUpdateBankAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.BankAccounts.GetCreateUpdateModelAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateUpdateBankAccountsModelRequest req = new GetCreateUpdateBankAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.BankAccounts.GetCreateUpdateModelAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateUpdateBankAccountsModelRequest req = new GetCreateUpdateBankAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.BankAccounts.GetCreateUpdateModelAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateUpdateBankAccountsModelRequest req = new GetCreateUpdateBankAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.BankAccounts.GetCreateUpdateModelAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateUpdateBankAccountsModelRequest req = new GetCreateUpdateBankAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.BankAccounts.GetCreateUpdateModelAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateUpdateBankAccountsModelRequest req = new GetCreateUpdateBankAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.BankAccounts.GetCreateUpdateModelAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateUpdateBankAccountsModelRequest req = new GetCreateUpdateBankAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.BankAccounts.GetCreateUpdateModelAsync(req); + +// handle response +``` +### Example Usage: Sandbox - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -68,7 +220,7 @@ Required data may vary by integration. To see what data to post, first call [Get ### Example Usage - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/bankstatements/README.md b/lending/docs/sdks/bankstatements/README.md index 1ae8e569..57965bae 100644 --- a/lending/docs/sdks/bankstatements/README.md +++ b/lending/docs/sdks/bankstatements/README.md @@ -22,7 +22,7 @@ When you use the [*Upload data*](https://docs.codat.io/lending-api#/operations/u ### Example Usage - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -68,7 +68,7 @@ Each data connection can only have one configuration for each company and extern ### Example Usage - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -162,7 +162,7 @@ Make sure you created configuration for the account using the [*Set upload confi ### Example Usage - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -179,32 +179,32 @@ UploadBankStatementDataRequest req = new UploadBankStatementDataRequest() { new Dictionary() { { "results", new List() { new Dictionary() { + { "id", "1703194f-7805-4da8-bac0-2ba5da4a4216" }, + { "name", "Business Current Account" }, + { "informalName", "Codat" }, + { "holder", "Codat Ltd" }, + { "type", "Debit" }, { "balance", new Dictionary() { { "available", -459987.97D }, { "current", -459964.9D }, { "limit", 5000 }, } }, { "identifiers", new Dictionary() { - { "bic", "LOYDGB21006" }, - { "maskedAccountNumber", "LOYDGB21006" }, { "type", "Depository" }, { "subtype", "checking" }, { "number", "46762629" }, { "bankCode", 9911 }, { "iban", "GB29 LOYD 4773 2346 7626 29" }, + { "bic", "LOYDGB21006" }, + { "maskedAccountNumber", "LOYDGB21006" }, } }, + { "currency", "GBP" }, { "institution", new Dictionary() { { "id", "lloyds-bank" }, { "name", "Lloyds Bank" }, } }, { "modifiedDate", "2022-05-23T16:32:50Z" }, - { "holder", "Codat Ltd" }, - { "currency", "GBP" }, { "sourceModifiedDate", "2021-08-14T05:04:12" }, - { "id", "1703194f-7805-4da8-bac0-2ba5da4a4216" }, - { "name", "Business Current Account" }, - { "informalName", "Codat" }, - { "type", "Debit" }, }, } }, } diff --git a/lending/docs/sdks/banktransactions/README.md b/lending/docs/sdks/banktransactions/README.md index d155e184..bce83c52 100644 --- a/lending/docs/sdks/banktransactions/README.md +++ b/lending/docs/sdks/banktransactions/README.md @@ -69,7 +69,7 @@ Required data may vary by integration. To see what data to post, first call [Get ### Example Usage - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/billcreditnotes/README.md b/lending/docs/sdks/billcreditnotes/README.md index 90187fd7..2055def5 100644 --- a/lending/docs/sdks/billcreditnotes/README.md +++ b/lending/docs/sdks/billcreditnotes/README.md @@ -16,9 +16,269 @@ The *List bill credit notes* endpoint returns a list of [bill credit notes](http Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Dynamics 365 Business Central - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillCreditNotesRequest req = new ListAccountingBillCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillCreditNotesRequest req = new ListAccountingBillCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillCreditNotesRequest req = new ListAccountingBillCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillCreditNotesRequest req = new ListAccountingBillCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillCreditNotesRequest req = new ListAccountingBillCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillCreditNotesRequest req = new ListAccountingBillCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillCreditNotesRequest req = new ListAccountingBillCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillCreditNotesRequest req = new ListAccountingBillCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillCreditNotesRequest req = new ListAccountingBillCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillCreditNotesRequest req = new ListAccountingBillCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillCreditNotesRequest req = new ListAccountingBillCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillCreditNotesRequest req = new ListAccountingBillCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillCreditNotesRequest req = new ListAccountingBillCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: Xero + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -64,9 +324,256 @@ The *Get bill credit note* endpoint returns a single bill credit note for a give Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillCreditNoteRequest req = new GetAccountingBillCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillCreditNoteId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillCreditNoteRequest req = new GetAccountingBillCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillCreditNoteId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillCreditNoteRequest req = new GetAccountingBillCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillCreditNoteId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillCreditNoteRequest req = new GetAccountingBillCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillCreditNoteId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillCreditNoteRequest req = new GetAccountingBillCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillCreditNoteId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillCreditNoteRequest req = new GetAccountingBillCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillCreditNoteId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillCreditNoteRequest req = new GetAccountingBillCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillCreditNoteId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillCreditNoteRequest req = new GetAccountingBillCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillCreditNoteId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillCreditNoteRequest req = new GetAccountingBillCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillCreditNoteId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillCreditNoteRequest req = new GetAccountingBillCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillCreditNoteId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillCreditNoteRequest req = new GetAccountingBillCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillCreditNoteId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillCreditNoteRequest req = new GetAccountingBillCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillCreditNoteId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillCreditNoteRequest req = new GetAccountingBillCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillCreditNoteId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillCreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: Xero - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/billpayments/README.md b/lending/docs/sdks/billpayments/README.md index f851223c..d7cb7e68 100644 --- a/lending/docs/sdks/billpayments/README.md +++ b/lending/docs/sdks/billpayments/README.md @@ -16,9 +16,289 @@ The *List bill payments* endpoint returns a list of [bill payments](https://docs Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Clear Books - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillPaymentsRequest req = new ListAccountingBillPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillPayments.ListAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillPaymentsRequest req = new ListAccountingBillPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillPayments.ListAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillPaymentsRequest req = new ListAccountingBillPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillPayments.ListAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillPaymentsRequest req = new ListAccountingBillPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillPayments.ListAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillPaymentsRequest req = new ListAccountingBillPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillPayments.ListAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillPaymentsRequest req = new ListAccountingBillPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillPayments.ListAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillPaymentsRequest req = new ListAccountingBillPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillPayments.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillPaymentsRequest req = new ListAccountingBillPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillPayments.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillPaymentsRequest req = new ListAccountingBillPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillPayments.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillPaymentsRequest req = new ListAccountingBillPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillPayments.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillPaymentsRequest req = new ListAccountingBillPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillPayments.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillPaymentsRequest req = new ListAccountingBillPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillPayments.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillPaymentsRequest req = new ListAccountingBillPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillPayments.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillPaymentsRequest req = new ListAccountingBillPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.BillPayments.ListAsync(req); + +// handle response +``` +### Example Usage: Xero + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -64,9 +344,275 @@ The *Get bill payment* endpoint returns a single bill payment for a given billPa Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Clear Books + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillPaymentRequest req = new GetAccountingBillPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillPaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillPayments.GetAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillPaymentRequest req = new GetAccountingBillPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillPaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillPayments.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillPaymentRequest req = new GetAccountingBillPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillPaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillPayments.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillPaymentRequest req = new GetAccountingBillPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillPaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillPayments.GetAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillPaymentRequest req = new GetAccountingBillPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillPaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillPayments.GetAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillPaymentRequest req = new GetAccountingBillPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillPaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillPayments.GetAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillPaymentRequest req = new GetAccountingBillPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillPaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillPayments.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillPaymentRequest req = new GetAccountingBillPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillPaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillPayments.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillPaymentRequest req = new GetAccountingBillPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillPaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillPayments.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillPaymentRequest req = new GetAccountingBillPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillPaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillPayments.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillPaymentRequest req = new GetAccountingBillPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillPaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillPayments.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillPaymentRequest req = new GetAccountingBillPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillPaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillPayments.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillPaymentRequest req = new GetAccountingBillPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillPaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillPayments.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillPaymentRequest req = new GetAccountingBillPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillPaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.BillPayments.GetAsync(req); + +// handle response +``` +### Example Usage: Xero - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/bills/README.md b/lending/docs/sdks/bills/README.md index f6c214fb..7538cbb5 100644 --- a/lending/docs/sdks/bills/README.md +++ b/lending/docs/sdks/bills/README.md @@ -23,9 +23,9 @@ Before using this endpoint, you must have [retrieved data for the company](https To access the `paymentAllocations` property, ensure that the `billPayments` data type is queued and cached in Codat before retrieving `bills` from Codat's cache. -### Example Usage +### Example Usage: Clear Books - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -43,41 +43,665 @@ var res = await sdk.AccountsPayable.Bills.ListAsync(req); // handle response ``` +### Example Usage: Dynamics 365 Business Central -### Parameters + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; -| Parameter | Type | Required | Description | -| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `request` | [ListAccountingBillsRequest](../../Models/Requests/ListAccountingBillsRequest.md) | :heavy_check_mark: | The request object to use for the request. | +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -### Response +ListAccountingBillsRequest req = new ListAccountingBillsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; -**[ListAccountingBillsResponse](../../Models/Requests/ListAccountingBillsResponse.md)** +var res = await sdk.AccountsPayable.Bills.ListAsync(req); -### Errors +// handle response +``` +### Example Usage: Exact (Netherlands) -| Error Type | Status Code | Content Type | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| Codat.Lending.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 409, 429 | application/json | -| Codat.Lending.Models.Errors.ErrorMessage | 500, 503 | application/json | -| Codat.Lending.Models.Errors.SDKException | 4XX, 5XX | \*/\* | + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; -## Get +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -The *Get bill* endpoint returns a single bill for a given billId. +ListAccountingBillsRequest req = new ListAccountingBillsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; -[Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. +var res = await sdk.AccountsPayable.Bills.ListAsync(req); -Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). +// handle response +``` +### Example Usage: Exact (UK) -### Tips and traps + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; -To access the `paymentAllocations` property, ensure that the `billPayments` data type is queued and cached in Codat before retrieving `bills` from Codat's cache. +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); +ListAccountingBillsRequest req = new ListAccountingBillsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; -### Example Usage +var res = await sdk.AccountsPayable.Bills.ListAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillsRequest req = new ListAccountingBillsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Bills.ListAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillsRequest req = new ListAccountingBillsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Bills.ListAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillsRequest req = new ListAccountingBillsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Bills.ListAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillsRequest req = new ListAccountingBillsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Bills.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillsRequest req = new ListAccountingBillsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Bills.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillsRequest req = new ListAccountingBillsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Bills.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillsRequest req = new ListAccountingBillsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Bills.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillsRequest req = new ListAccountingBillsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Bills.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillsRequest req = new ListAccountingBillsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Bills.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillsRequest req = new ListAccountingBillsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Bills.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillsRequest req = new ListAccountingBillsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Bills.ListAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillsRequest req = new ListAccountingBillsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Bills.ListAsync(req); + +// handle response +``` +### Example Usage: Zoho Books + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBillsRequest req = new ListAccountingBillsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Bills.ListAsync(req); + +// handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `request` | [ListAccountingBillsRequest](../../Models/Requests/ListAccountingBillsRequest.md) | :heavy_check_mark: | The request object to use for the request. | + +### Response + +**[ListAccountingBillsResponse](../../Models/Requests/ListAccountingBillsResponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| Codat.Lending.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 409, 429 | application/json | +| Codat.Lending.Models.Errors.ErrorMessage | 500, 503 | application/json | +| Codat.Lending.Models.Errors.SDKException | 4XX, 5XX | \*/\* | + +## Get + +The *Get bill* endpoint returns a single bill for a given billId. + +[Bills](https://docs.codat.io/lending-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services. + +Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + +### Tips and traps + +To access the `paymentAllocations` property, ensure that the `billPayments` data type is queued and cached in Codat before retrieving `bills` from Codat's cache. + + +### Example Usage: Clear Books + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillRequest req = new GetAccountingBillRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Bills.GetAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillRequest req = new GetAccountingBillRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Bills.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillRequest req = new GetAccountingBillRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Bills.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillRequest req = new GetAccountingBillRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Bills.GetAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillRequest req = new GetAccountingBillRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Bills.GetAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillRequest req = new GetAccountingBillRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Bills.GetAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillRequest req = new GetAccountingBillRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Bills.GetAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillRequest req = new GetAccountingBillRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Bills.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillRequest req = new GetAccountingBillRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Bills.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillRequest req = new GetAccountingBillRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Bills.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillRequest req = new GetAccountingBillRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Bills.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillRequest req = new GetAccountingBillRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Bills.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillRequest req = new GetAccountingBillRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Bills.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillRequest req = new GetAccountingBillRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Bills.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillRequest req = new GetAccountingBillRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Bills.GetAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBillRequest req = new GetAccountingBillRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + BillId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Bills.GetAsync(req); + +// handle response +``` +### Example Usage: Zoho Books - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/cashflow/README.md b/lending/docs/sdks/cashflow/README.md index 71b60b68..6b27757c 100644 --- a/lending/docs/sdks/cashflow/README.md +++ b/lending/docs/sdks/cashflow/README.md @@ -10,9 +10,114 @@ Gets the latest cash flow statement for a company. -### Example Usage +### Example Usage: Clear Books - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCashFlowStatementRequest req = new GetAccountingCashFlowStatementRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.CashFlow.GetAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCashFlowStatementRequest req = new GetAccountingCashFlowStatementRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.CashFlow.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCashFlowStatementRequest req = new GetAccountingCashFlowStatementRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.CashFlow.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCashFlowStatementRequest req = new GetAccountingCashFlowStatementRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.CashFlow.GetAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCashFlowStatementRequest req = new GetAccountingCashFlowStatementRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.CashFlow.GetAsync(req); + +// handle response +``` +### Example Usage: Zoho Books + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/categorizedstatement/README.md b/lending/docs/sdks/categorizedstatement/README.md index 1352afa8..4605b41d 100644 --- a/lending/docs/sdks/categorizedstatement/README.md +++ b/lending/docs/sdks/categorizedstatement/README.md @@ -16,7 +16,7 @@ The _Get categorized bank statement_ endpoint provides a fully categorized list ### Example Usage - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/codatlendingaccounts/README.md b/lending/docs/sdks/codatlendingaccounts/README.md index 0e30b973..e3c058b9 100644 --- a/lending/docs/sdks/codatlendingaccounts/README.md +++ b/lending/docs/sdks/codatlendingaccounts/README.md @@ -16,9 +16,240 @@ The *List bank accounts* endpoint returns a list of [bank accounts](https://docs Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Dynamics 365 Business Central - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBankAccountsRequest req = new ListAccountingBankAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountingBankData.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBankAccountsRequest req = new ListAccountingBankAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountingBankData.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBankAccountsRequest req = new ListAccountingBankAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountingBankData.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBankAccountsRequest req = new ListAccountingBankAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountingBankData.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBankAccountsRequest req = new ListAccountingBankAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountingBankData.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBankAccountsRequest req = new ListAccountingBankAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountingBankData.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBankAccountsRequest req = new ListAccountingBankAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountingBankData.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBankAccountsRequest req = new ListAccountingBankAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountingBankData.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBankAccountsRequest req = new ListAccountingBankAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountingBankData.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBankAccountsRequest req = new ListAccountingBankAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountingBankData.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingBankAccountsRequest req = new ListAccountingBankAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountingBankData.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: Zoho Books + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -65,9 +296,229 @@ The *Get bank account* endpoint returns a single account for a given accountId. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBankAccountRequest req = new GetAccountingBankAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountingBankData.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBankAccountRequest req = new GetAccountingBankAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountingBankData.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBankAccountRequest req = new GetAccountingBankAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountingBankData.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBankAccountRequest req = new GetAccountingBankAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountingBankData.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBankAccountRequest req = new GetAccountingBankAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountingBankData.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBankAccountRequest req = new GetAccountingBankAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountingBankData.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBankAccountRequest req = new GetAccountingBankAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountingBankData.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBankAccountRequest req = new GetAccountingBankAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountingBankData.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBankAccountRequest req = new GetAccountingBankAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountingBankData.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBankAccountRequest req = new GetAccountingBankAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountingBankData.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingBankAccountRequest req = new GetAccountingBankAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountingBankData.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: Zoho Books - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/codatlendingbankingaccounts/README.md b/lending/docs/sdks/codatlendingbankingaccounts/README.md index 27dd1704..84b12823 100644 --- a/lending/docs/sdks/codatlendingbankingaccounts/README.md +++ b/lending/docs/sdks/codatlendingbankingaccounts/README.md @@ -16,9 +16,30 @@ The *List accounts* endpoint returns a list of [accounts](https://docs.codat.io/ Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Basiq - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListBankingAccountsRequest req = new ListBankingAccountsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Banking.Accounts.ListAsync(req); + +// handle response +``` +### Example Usage: Plaid + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -64,9 +85,29 @@ The *Get account* endpoint returns a single account for a given accountId. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Basiq + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetBankingAccountRequest req = new GetBankingAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Banking.Accounts.GetAsync(req); + +// handle response +``` +### Example Usage: Plaid - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/codatlendingcustomers/README.md b/lending/docs/sdks/codatlendingcustomers/README.md index a4ed32c6..5037bcae 100644 --- a/lending/docs/sdks/codatlendingcustomers/README.md +++ b/lending/docs/sdks/codatlendingcustomers/README.md @@ -16,9 +16,198 @@ The *List customers* endpoint returns a list of [customers](https://docs.codat.i Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: BigCommerce - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceCustomersRequest req = new ListCommerceCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Clover + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceCustomersRequest req = new ListCommerceCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Mollie + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceCustomersRequest req = new ListCommerceCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Mollie Test + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceCustomersRequest req = new ListCommerceCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: PrestaShop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceCustomersRequest req = new ListCommerceCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Shopify + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceCustomersRequest req = new ListCommerceCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Square + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceCustomersRequest req = new ListCommerceCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Stripe Test + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceCustomersRequest req = new ListCommerceCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: WooCommerce + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceCustomersRequest req = new ListCommerceCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Zettle + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -65,9 +254,189 @@ The *Get customer* endpoint returns a single customer for a given customerId. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: BigCommerce + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceCustomerRequest req = new GetCommerceCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Clover + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceCustomerRequest req = new GetCommerceCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Mollie + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceCustomerRequest req = new GetCommerceCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Mollie Test + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceCustomerRequest req = new GetCommerceCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: PrestaShop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceCustomerRequest req = new GetCommerceCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Shopify + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceCustomerRequest req = new GetCommerceCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Square + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceCustomerRequest req = new GetCommerceCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Stripe Test + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceCustomerRequest req = new GetCommerceCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: WooCommerce + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceCustomerRequest req = new GetCommerceCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Zettle - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/codatlendingdirectcosts/README.md b/lending/docs/sdks/codatlendingdirectcosts/README.md index 9fc64b9b..4083d302 100644 --- a/lending/docs/sdks/codatlendingdirectcosts/README.md +++ b/lending/docs/sdks/codatlendingdirectcosts/README.md @@ -18,9 +18,199 @@ The *Get create direct cost model* endpoint returns the expected data for the re See the *response examples* for integration-specific indicative models. -### Example Usage +### Example Usage: Dynamics 365 Business Central - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateDirectCostsModelRequest req = new GetCreateDirectCostsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.DirectCosts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateDirectCostsModelRequest req = new GetCreateDirectCostsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.DirectCosts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateDirectCostsModelRequest req = new GetCreateDirectCostsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.DirectCosts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateDirectCostsModelRequest req = new GetCreateDirectCostsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.DirectCosts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateDirectCostsModelRequest req = new GetCreateDirectCostsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.DirectCosts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateDirectCostsModelRequest req = new GetCreateDirectCostsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.DirectCosts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateDirectCostsModelRequest req = new GetCreateDirectCostsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.DirectCosts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateDirectCostsModelRequest req = new GetCreateDirectCostsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.DirectCosts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateDirectCostsModelRequest req = new GetCreateDirectCostsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.DirectCosts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateDirectCostsModelRequest req = new GetCreateDirectCostsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.DirectCosts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Zoho Books + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -66,9 +256,97 @@ The *Create direct cost* endpoint creates a new [direct cost](https://docs.codat Required data may vary by integration. To see what data to post, first call [Get create direct cost model](https://docs.codat.io/lending-api#/operations/get-create-directCosts-model). -### Example Usage +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using System.Collections.Generic; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreateDirectCostRequest req = new CreateDirectCostRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + DirectCostPrototype = new DirectCostPrototype() { + IssueDate = "2023-02-12", + Currency = "GBP", + LineItems = new List() { + new DirectCostLineItem() { + UnitAmount = 15M, + Quantity = 1M, + SubTotal = 15M, + AccountRef = new AccountRef() { + Id = "288", + }, + }, + }, + PaymentAllocations = new List() { + new AccountingPaymentAllocation() { + Payment = new PaymentAllocationPayment() { + AccountRef = new AccountRef() { + Id = "750-1", + }, + }, + Allocation = new Allocation() {}, + }, + }, + SubTotal = 15M, + TaxAmount = 0M, + TotalAmount = 15M, + }, +}; + +var res = await sdk.LoanWriteback.DirectCosts.CreateAsync(req); + +// handle response +``` +### Example Usage: Malformed query - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using System.Collections.Generic; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreateDirectCostRequest req = new CreateDirectCostRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + DirectCostPrototype = new DirectCostPrototype() { + IssueDate = "2022-10-23T00:00:00Z", + Currency = "GBP", + LineItems = new List() {}, + PaymentAllocations = new List() { + new AccountingPaymentAllocation() { + Payment = new PaymentAllocationPayment() { + AccountRef = new AccountRef() {}, + Currency = "GBP", + PaidOnDate = "2022-10-23T00:00:00Z", + }, + Allocation = new Allocation() { + Currency = "GBP", + AllocatedOnDate = "2022-10-23T00:00:00Z", + }, + }, + }, + SubTotal = 3566.34M, + TaxAmount = 7664.68M, + TotalAmount = 208.93M, + }, +}; + +var res = await sdk.LoanWriteback.DirectCosts.CreateAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -142,6 +420,130 @@ CreateDirectCostRequest req = new CreateDirectCostRequest() { var res = await sdk.LoanWriteback.DirectCosts.CreateAsync(req); +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using System.Collections.Generic; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreateDirectCostRequest req = new CreateDirectCostRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + DirectCostPrototype = new DirectCostPrototype() { + Reference = "test ref", + Note = "Test 1", + IssueDate = "2023-03-31T00:00:00", + Currency = "USD", + CurrencyRate = 0.5M, + LineItems = new List() { + new DirectCostLineItem() { + UnitAmount = 9.99M, + Quantity = 1M, + SubTotal = 9.99M, + TaxAmount = 2M, + TotalAmount = 11.99M, + AccountRef = new AccountRef() { + Id = "195", + }, + }, + }, + PaymentAllocations = new List() { + new AccountingPaymentAllocation() { + Payment = new PaymentAllocationPayment() { + Id = "4355", + Note = "test note", + Reference = "test reference", + AccountRef = new AccountRef() { + Id = "348", + Name = "CMRR Renewal", + }, + Currency = "USD", + PaidOnDate = "2023-03-31T00:00:00", + TotalAmount = 11.99M, + }, + Allocation = new Allocation() { + Currency = "USD", + AllocatedOnDate = "2023-03-31T00:00:00", + TotalAmount = 11.99M, + }, + }, + }, + SubTotal = 9.99M, + TaxAmount = 2M, + TotalAmount = 11.99M, + }, +}; + +var res = await sdk.LoanWriteback.DirectCosts.CreateAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using System.Collections.Generic; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreateDirectCostRequest req = new CreateDirectCostRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + DirectCostPrototype = new DirectCostPrototype() { + Reference = "Scenario One neg DC", + ContactRef = new ContactRef() { + Id = "699f0091-b127-4796-9f15-41a2f42abeb2", + DataType = ContactRefDataType.Suppliers, + }, + IssueDate = "2023-02-25", + Currency = "GBP", + LineItems = new List() { + new DirectCostLineItem() { + Description = "negative direct cost", + UnitAmount = 35M, + Quantity = -1M, + SubTotal = -35M, + TaxAmount = -7M, + TotalAmount = -42M, + TaxRateRef = new TaxRateRef() { + Id = "INPUT2", + }, + ItemRef = new PropertieItemRef() { + Id = "965cfc0e-4d80-4059-9641-4a392f9ad549", + }, + }, + }, + PaymentAllocations = new List() { + new AccountingPaymentAllocation() { + Payment = new PaymentAllocationPayment() { + AccountRef = new AccountRef() { + Id = "bd9e85e0-0478-433d-ae9f-0b3c4f04bfe4", + }, + Currency = "GBP", + }, + Allocation = new Allocation() { + TotalAmount = -42M, + }, + }, + }, + SubTotal = -35M, + TaxAmount = -7M, + TotalAmount = -42M, + }, +}; + +var res = await sdk.LoanWriteback.DirectCosts.CreateAsync(req); + // handle response ``` diff --git a/lending/docs/sdks/codatlendingloanwritebackaccounts/README.md b/lending/docs/sdks/codatlendingloanwritebackaccounts/README.md index 03877aac..a4dd6a85 100644 --- a/lending/docs/sdks/codatlendingloanwritebackaccounts/README.md +++ b/lending/docs/sdks/codatlendingloanwritebackaccounts/README.md @@ -17,9 +17,180 @@ The *Get create account model* endpoint returns the expected data for the reques See the *response examples* for integration-specific indicative models. -### Example Usage +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateChartOfAccountsModelRequest req = new GetCreateChartOfAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Accounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateChartOfAccountsModelRequest req = new GetCreateChartOfAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Accounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: MYOB AccountRight and Essentials + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateChartOfAccountsModelRequest req = new GetCreateChartOfAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Accounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateChartOfAccountsModelRequest req = new GetCreateChartOfAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Accounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateChartOfAccountsModelRequest req = new GetCreateChartOfAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Accounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateChartOfAccountsModelRequest req = new GetCreateChartOfAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Accounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateChartOfAccountsModelRequest req = new GetCreateChartOfAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Accounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateChartOfAccountsModelRequest req = new GetCreateChartOfAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Accounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateChartOfAccountsModelRequest req = new GetCreateChartOfAccountsModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Accounts.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Xero - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -67,7 +238,7 @@ Required data may vary by integration. To see what data to post, first call [Get ### Example Usage - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/codatlendingloanwritebackpayments/README.md b/lending/docs/sdks/codatlendingloanwritebackpayments/README.md index adef5c47..dd567f26 100644 --- a/lending/docs/sdks/codatlendingloanwritebackpayments/README.md +++ b/lending/docs/sdks/codatlendingloanwritebackpayments/README.md @@ -17,9 +17,237 @@ The *Get create payment model* endpoint returns the expected data for the reques See the *response examples* for integration-specific indicative models. -### Example Usage +### Example Usage: FreeAgent - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreatePaymentModelRequest req = new GetCreatePaymentModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Payments.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreatePaymentModelRequest req = new GetCreatePaymentModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Payments.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: MYOB AccountRight and Essentials + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreatePaymentModelRequest req = new GetCreatePaymentModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Payments.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreatePaymentModelRequest req = new GetCreatePaymentModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Payments.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreatePaymentModelRequest req = new GetCreatePaymentModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Payments.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreatePaymentModelRequest req = new GetCreatePaymentModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Payments.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreatePaymentModelRequest req = new GetCreatePaymentModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Payments.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreatePaymentModelRequest req = new GetCreatePaymentModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Payments.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreatePaymentModelRequest req = new GetCreatePaymentModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Payments.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreatePaymentModelRequest req = new GetCreatePaymentModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Payments.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreatePaymentModelRequest req = new GetCreatePaymentModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Payments.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreatePaymentModelRequest req = new GetCreatePaymentModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Payments.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Zoho Books + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -65,9 +293,46 @@ The *Create payment* endpoint creates a new [payment](https://docs.codat.io/lend Required data may vary by integration. To see what data to post, first call [Get create payment model](https://docs.codat.io/lending-api#/operations/get-create-payments-model). -### Example Usage +### Example Usage: Malformed query - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using System.Collections.Generic; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreatePaymentRequest req = new CreatePaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountingPayment = new AccountingPayment() { + ModifiedDate = "2022-10-23T00:00:00Z", + SourceModifiedDate = "2022-10-23T00:00:00Z", + AccountRef = new AccountRef() {}, + PaymentMethodRef = new PaymentMethodRef() { + Id = "EILBDVJVNUAGVKRQ", + Name = "AliPay", + }, + Currency = "GBP", + Date = "2022-10-23T00:00:00Z", + Lines = new List() { + new PaymentLine() { + Amount = 9098.82M, + AllocatedOnDate = "2022-10-23T00:00:00Z", + }, + }, + }, +}; + +var res = await sdk.LoanWriteback.Payments.CreateAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -117,6 +382,155 @@ CreatePaymentRequest req = new CreatePaymentRequest() { var res = await sdk.LoanWriteback.Payments.CreateAsync(req); +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using System.Collections.Generic; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreatePaymentRequest req = new CreatePaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountingPayment = new AccountingPayment() { + CustomerRef = new AccountingCustomerRef() { + Id = "CUST1", + }, + AccountRef = new AccountRef() { + Id = "1200", + Name = "Bank Current Account", + }, + PaymentMethodRef = new PaymentMethodRef() { + Id = "4405", + }, + TotalAmount = 4M, + Currency = "GBP", + CurrencyRate = 1M, + Date = "2023-03-17T11:47:04.792Z", + Note = "note 07/03 14.31", + Lines = new List() { + new PaymentLine() { + Amount = 4M, + Links = new List() { + new PaymentLineLink() { + Type = PaymentLinkType.Invoice, + Id = "INV-31", + Amount = -4M, + CurrencyRate = 1M, + }, + }, + AllocatedOnDate = "2023-02-11T11:47:04.792Z", + }, + }, + Reference = "ref", + }, +}; + +var res = await sdk.LoanWriteback.Payments.CreateAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using System.Collections.Generic; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreatePaymentRequest req = new CreatePaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountingPayment = new AccountingPayment() { + CustomerRef = new AccountingCustomerRef() { + Id = "30444c5bd4964fd787c7f8e2e5301ce1", + CompanyName = "Stanley test customer", + }, + AccountRef = new AccountRef() { + Id = "9a25937b267a11e797950a57719b2edb", + Name = "Current", + }, + TotalAmount = 0.17M, + Currency = "GBP", + CurrencyRate = 1M, + Date = "2023-03-20T11:47:04.792Z", + Note = "Need to send products asap.", + Lines = new List() { + new PaymentLine() { + Amount = 0.17M, + Links = new List() { + new PaymentLineLink() { + Type = PaymentLinkType.Invoice, + Id = "bb85db9226d7450fb99eb83e7fb37505", + Amount = -0.17M, + CurrencyRate = 1M, + }, + }, + AllocatedOnDate = "2023-02-11T11:47:04.792Z", + }, + }, + Reference = "normal payment 20/03 17.05", + }, +}; + +var res = await sdk.LoanWriteback.Payments.CreateAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using System.Collections.Generic; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreatePaymentRequest req = new CreatePaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountingPayment = new AccountingPayment() { + CustomerRef = new AccountingCustomerRef() { + Id = "19", + }, + AccountRef = new AccountRef() { + Id = "81", + }, + TotalAmount = 0M, + Date = "2022-03-12T00:00:00", + Lines = new List() { + new PaymentLine() { + Amount = 0M, + Links = new List() { + new PaymentLineLink() { + Type = PaymentLinkType.Invoice, + Id = "246", + Amount = -1.1M, + }, + new PaymentLineLink() { + Type = PaymentLinkType.CreditNote, + Id = "280", + Amount = 1.1M, + }, + }, + }, + }, + }, +}; + +var res = await sdk.LoanWriteback.Payments.CreateAsync(req); + // handle response ``` diff --git a/lending/docs/sdks/codatlendingpayments/README.md b/lending/docs/sdks/codatlendingpayments/README.md index fd891750..3b03e6d3 100644 --- a/lending/docs/sdks/codatlendingpayments/README.md +++ b/lending/docs/sdks/codatlendingpayments/README.md @@ -16,9 +16,177 @@ The *List payments* endpoint returns a list of [payments](https://docs.codat.io/ Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: BigCommerce - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommercePaymentsRequest req = new ListCommercePaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: Clover + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommercePaymentsRequest req = new ListCommercePaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: Lightspeed K Trial + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommercePaymentsRequest req = new ListCommercePaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: Mollie + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommercePaymentsRequest req = new ListCommercePaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: PrestaShop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommercePaymentsRequest req = new ListCommercePaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: Shopify + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommercePaymentsRequest req = new ListCommercePaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: SumUp + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommercePaymentsRequest req = new ListCommercePaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: WooCommerce + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommercePaymentsRequest req = new ListCommercePaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: Zettle + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -65,9 +233,169 @@ The *Get payment* endpoint returns a single payment for a given paymentId. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: BigCommerce + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommercePaymentRequest req = new GetCommercePaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Payments.GetAsync(req); + +// handle response +``` +### Example Usage: Clover + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommercePaymentRequest req = new GetCommercePaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Payments.GetAsync(req); + +// handle response +``` +### Example Usage: Lightspeed K Trial + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommercePaymentRequest req = new GetCommercePaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Payments.GetAsync(req); + +// handle response +``` +### Example Usage: Mollie + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommercePaymentRequest req = new GetCommercePaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Payments.GetAsync(req); + +// handle response +``` +### Example Usage: PrestaShop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommercePaymentRequest req = new GetCommercePaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Payments.GetAsync(req); + +// handle response +``` +### Example Usage: Shopify + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommercePaymentRequest req = new GetCommercePaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Payments.GetAsync(req); + +// handle response +``` +### Example Usage: SumUp + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommercePaymentRequest req = new GetCommercePaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Payments.GetAsync(req); + +// handle response +``` +### Example Usage: WooCommerce + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommercePaymentRequest req = new GetCommercePaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Payments.GetAsync(req); + +// handle response +``` +### Example Usage: Zettle - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/codatlendingreports/README.md b/lending/docs/sdks/codatlendingreports/README.md index c04b17d1..465ecb44 100644 --- a/lending/docs/sdks/codatlendingreports/README.md +++ b/lending/docs/sdks/codatlendingreports/README.md @@ -54,9 +54,9 @@ var res = await sdk.AccountsReceivable.Reports.IsAgedDebtorsAvailableAsync(req); Returns aged debtors report for company that shows the total outstanding balance due from customers to the business over time. -### Example Usage +### Example Usage: Clear Books - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -76,73 +76,645 @@ var res = await sdk.AccountsReceivable.Reports.GetAgedDebtorsAsync(req); // handle response ``` +### Example Usage: Dynamics 365 Business Central -### Parameters + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `request` | [GetAccountingAgedDebtorsReportRequest](../../Models/Requests/GetAccountingAgedDebtorsReportRequest.md) | :heavy_check_mark: | The request object to use for the request. | +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -### Response +GetAccountingAgedDebtorsReportRequest req = new GetAccountingAgedDebtorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; -**[GetAccountingAgedDebtorsReportResponse](../../Models/Requests/GetAccountingAgedDebtorsReportResponse.md)** +var res = await sdk.AccountsReceivable.Reports.GetAgedDebtorsAsync(req); -### Errors +// handle response +``` +### Example Usage: FreshBooks -| Error Type | Status Code | Content Type | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| Codat.Lending.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | -| Codat.Lending.Models.Errors.ErrorMessage | 500, 503 | application/json | -| Codat.Lending.Models.Errors.SDKException | 4XX, 5XX | \*/\* | + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; -## IsAgedCreditorsAvailable +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -Indicates whether the aged creditor report is available for the company. +GetAccountingAgedDebtorsReportRequest req = new GetAccountingAgedDebtorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; -### Example Usage +var res = await sdk.AccountsReceivable.Reports.GetAgedDebtorsAsync(req); - +// handle response +``` +### Example Usage: KashFlow + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; using Codat.Lending.Models.Requests; +using NodaTime; var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -IsAgedCreditorsReportAvailableRequest req = new IsAgedCreditorsReportAvailableRequest() { +GetAccountingAgedDebtorsReportRequest req = new GetAccountingAgedDebtorsReportRequest() { CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, }; -var res = await sdk.AccountsReceivable.Reports.IsAgedCreditorsAvailableAsync(req); +var res = await sdk.AccountsReceivable.Reports.GetAgedDebtorsAsync(req); // handle response ``` +### Example Usage: MYOB AccountRight and Essentials -### Parameters + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; -| Parameter | Type | Required | Description | -| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `request` | [IsAgedCreditorsReportAvailableRequest](../../Models/Requests/IsAgedCreditorsReportAvailableRequest.md) | :heavy_check_mark: | The request object to use for the request. | +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -### Response +GetAccountingAgedDebtorsReportRequest req = new GetAccountingAgedDebtorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; -**[IsAgedCreditorsReportAvailableResponse](../../Models/Requests/IsAgedCreditorsReportAvailableResponse.md)** +var res = await sdk.AccountsReceivable.Reports.GetAgedDebtorsAsync(req); -### Errors +// handle response +``` +### Example Usage: Oracle NetSuite -| Error Type | Status Code | Content Type | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| Codat.Lending.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | -| Codat.Lending.Models.Errors.ErrorMessage | 500, 503 | application/json | -| Codat.Lending.Models.Errors.SDKException | 4XX, 5XX | \*/\* | + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; -## GetAgedCreditors +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -Returns aged creditors report for company that shows the total balance owed by a business to its suppliers over time. +GetAccountingAgedDebtorsReportRequest req = new GetAccountingAgedDebtorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; -### Example Usage +var res = await sdk.AccountsReceivable.Reports.GetAgedDebtorsAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAgedDebtorsReportRequest req = new GetAccountingAgedDebtorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; + +var res = await sdk.AccountsReceivable.Reports.GetAgedDebtorsAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAgedDebtorsReportRequest req = new GetAccountingAgedDebtorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; + +var res = await sdk.AccountsReceivable.Reports.GetAgedDebtorsAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAgedDebtorsReportRequest req = new GetAccountingAgedDebtorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; + +var res = await sdk.AccountsReceivable.Reports.GetAgedDebtorsAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAgedDebtorsReportRequest req = new GetAccountingAgedDebtorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; + +var res = await sdk.AccountsReceivable.Reports.GetAgedDebtorsAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAgedDebtorsReportRequest req = new GetAccountingAgedDebtorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; + +var res = await sdk.AccountsReceivable.Reports.GetAgedDebtorsAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAgedDebtorsReportRequest req = new GetAccountingAgedDebtorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; + +var res = await sdk.AccountsReceivable.Reports.GetAgedDebtorsAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAgedDebtorsReportRequest req = new GetAccountingAgedDebtorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; + +var res = await sdk.AccountsReceivable.Reports.GetAgedDebtorsAsync(req); + +// handle response +``` +### Example Usage: Zoho Books + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAgedDebtorsReportRequest req = new GetAccountingAgedDebtorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; + +var res = await sdk.AccountsReceivable.Reports.GetAgedDebtorsAsync(req); + +// handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `request` | [GetAccountingAgedDebtorsReportRequest](../../Models/Requests/GetAccountingAgedDebtorsReportRequest.md) | :heavy_check_mark: | The request object to use for the request. | + +### Response + +**[GetAccountingAgedDebtorsReportResponse](../../Models/Requests/GetAccountingAgedDebtorsReportResponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| Codat.Lending.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | +| Codat.Lending.Models.Errors.ErrorMessage | 500, 503 | application/json | +| Codat.Lending.Models.Errors.SDKException | 4XX, 5XX | \*/\* | + +## IsAgedCreditorsAvailable + +Indicates whether the aged creditor report is available for the company. + +### Example Usage + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +IsAgedCreditorsReportAvailableRequest req = new IsAgedCreditorsReportAvailableRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", +}; + +var res = await sdk.AccountsReceivable.Reports.IsAgedCreditorsAvailableAsync(req); + +// handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| `request` | [IsAgedCreditorsReportAvailableRequest](../../Models/Requests/IsAgedCreditorsReportAvailableRequest.md) | :heavy_check_mark: | The request object to use for the request. | + +### Response + +**[IsAgedCreditorsReportAvailableResponse](../../Models/Requests/IsAgedCreditorsReportAvailableResponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| Codat.Lending.Models.Errors.ErrorMessage | 401, 402, 403, 404, 429 | application/json | +| Codat.Lending.Models.Errors.ErrorMessage | 500, 503 | application/json | +| Codat.Lending.Models.Errors.SDKException | 4XX, 5XX | \*/\* | + +## GetAgedCreditors + +Returns aged creditors report for company that shows the total balance owed by a business to its suppliers over time. + +### Example Usage: Clear Books + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAgedCreditorsReportRequest req = new GetAccountingAgedCreditorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; + +var res = await sdk.AccountsReceivable.Reports.GetAgedCreditorsAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAgedCreditorsReportRequest req = new GetAccountingAgedCreditorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; + +var res = await sdk.AccountsReceivable.Reports.GetAgedCreditorsAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAgedCreditorsReportRequest req = new GetAccountingAgedCreditorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; + +var res = await sdk.AccountsReceivable.Reports.GetAgedCreditorsAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAgedCreditorsReportRequest req = new GetAccountingAgedCreditorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; + +var res = await sdk.AccountsReceivable.Reports.GetAgedCreditorsAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAgedCreditorsReportRequest req = new GetAccountingAgedCreditorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; + +var res = await sdk.AccountsReceivable.Reports.GetAgedCreditorsAsync(req); + +// handle response +``` +### Example Usage: MYOB AccountRight and Essentials + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAgedCreditorsReportRequest req = new GetAccountingAgedCreditorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; + +var res = await sdk.AccountsReceivable.Reports.GetAgedCreditorsAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAgedCreditorsReportRequest req = new GetAccountingAgedCreditorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; + +var res = await sdk.AccountsReceivable.Reports.GetAgedCreditorsAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAgedCreditorsReportRequest req = new GetAccountingAgedCreditorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; + +var res = await sdk.AccountsReceivable.Reports.GetAgedCreditorsAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAgedCreditorsReportRequest req = new GetAccountingAgedCreditorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; + +var res = await sdk.AccountsReceivable.Reports.GetAgedCreditorsAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAgedCreditorsReportRequest req = new GetAccountingAgedCreditorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; + +var res = await sdk.AccountsReceivable.Reports.GetAgedCreditorsAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAgedCreditorsReportRequest req = new GetAccountingAgedCreditorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; + +var res = await sdk.AccountsReceivable.Reports.GetAgedCreditorsAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAgedCreditorsReportRequest req = new GetAccountingAgedCreditorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; + +var res = await sdk.AccountsReceivable.Reports.GetAgedCreditorsAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using NodaTime; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingAgedCreditorsReportRequest req = new GetAccountingAgedCreditorsReportRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ReportDate = LocalDate.FromDateTime(System.DateTime.Parse("2022-12-31")), + NumberOfPeriods = 12, + PeriodLengthDays = 30, +}; + +var res = await sdk.AccountsReceivable.Reports.GetAgedCreditorsAsync(req); + +// handle response +``` +### Example Usage: Xero - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/codatlendingsalestransactions/README.md b/lending/docs/sdks/codatlendingsalestransactions/README.md index 64718348..333a9792 100644 --- a/lending/docs/sdks/codatlendingsalestransactions/README.md +++ b/lending/docs/sdks/codatlendingsalestransactions/README.md @@ -16,9 +16,114 @@ The *List transactions* endpoint returns a list of [transactions](https://docs.c Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Mollie - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceTransactionsRequest req = new ListCommerceTransactionsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Transactions.ListAsync(req); + +// handle response +``` +### Example Usage: Mollie Test + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceTransactionsRequest req = new ListCommerceTransactionsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Transactions.ListAsync(req); + +// handle response +``` +### Example Usage: Shopify + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceTransactionsRequest req = new ListCommerceTransactionsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Transactions.ListAsync(req); + +// handle response +``` +### Example Usage: Stripe Test + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceTransactionsRequest req = new ListCommerceTransactionsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Transactions.ListAsync(req); + +// handle response +``` +### Example Usage: SumUp + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceTransactionsRequest req = new ListCommerceTransactionsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Transactions.ListAsync(req); + +// handle response +``` +### Example Usage: Zettle + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -65,9 +170,109 @@ The *Get transaction* endpoint returns a single transaction for a given transact Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Mollie + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceTransactionRequest req = new GetCommerceTransactionRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + TransactionId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Transactions.GetAsync(req); + +// handle response +``` +### Example Usage: Mollie Test + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceTransactionRequest req = new GetCommerceTransactionRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + TransactionId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Transactions.GetAsync(req); + +// handle response +``` +### Example Usage: Shopify + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceTransactionRequest req = new GetCommerceTransactionRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + TransactionId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Transactions.GetAsync(req); + +// handle response +``` +### Example Usage: Stripe Test + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceTransactionRequest req = new GetCommerceTransactionRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + TransactionId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Transactions.GetAsync(req); + +// handle response +``` +### Example Usage: SumUp + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceTransactionRequest req = new GetCommerceTransactionRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + TransactionId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Transactions.GetAsync(req); + +// handle response +``` +### Example Usage: Zettle - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/codatlendingsuppliers/README.md b/lending/docs/sdks/codatlendingsuppliers/README.md index 81c77199..93718b2c 100644 --- a/lending/docs/sdks/codatlendingsuppliers/README.md +++ b/lending/docs/sdks/codatlendingsuppliers/README.md @@ -18,9 +18,237 @@ The *Get create/update supplier model* endpoint returns the expected data for th See the *response examples* for integration-specific indicative models. -### Example Usage +### Example Usage: Exact (Netherlands) - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateUpdateSuppliersModelRequest req = new GetCreateUpdateSuppliersModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Suppliers.GetCreateUpdateModelAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateUpdateSuppliersModelRequest req = new GetCreateUpdateSuppliersModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Suppliers.GetCreateUpdateModelAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateUpdateSuppliersModelRequest req = new GetCreateUpdateSuppliersModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Suppliers.GetCreateUpdateModelAsync(req); + +// handle response +``` +### Example Usage: MYOB AccountRight and Essentials + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateUpdateSuppliersModelRequest req = new GetCreateUpdateSuppliersModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Suppliers.GetCreateUpdateModelAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateUpdateSuppliersModelRequest req = new GetCreateUpdateSuppliersModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Suppliers.GetCreateUpdateModelAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateUpdateSuppliersModelRequest req = new GetCreateUpdateSuppliersModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Suppliers.GetCreateUpdateModelAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateUpdateSuppliersModelRequest req = new GetCreateUpdateSuppliersModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Suppliers.GetCreateUpdateModelAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateUpdateSuppliersModelRequest req = new GetCreateUpdateSuppliersModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Suppliers.GetCreateUpdateModelAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateUpdateSuppliersModelRequest req = new GetCreateUpdateSuppliersModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Suppliers.GetCreateUpdateModelAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateUpdateSuppliersModelRequest req = new GetCreateUpdateSuppliersModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Suppliers.GetCreateUpdateModelAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateUpdateSuppliersModelRequest req = new GetCreateUpdateSuppliersModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Suppliers.GetCreateUpdateModelAsync(req); + +// handle response +``` +### Example Usage: Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateUpdateSuppliersModelRequest req = new GetCreateUpdateSuppliersModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Suppliers.GetCreateUpdateModelAsync(req); + +// handle response +``` +### Example Usage: Xero + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -67,9 +295,67 @@ The *Create supplier* endpoint creates a new [supplier](https://docs.codat.io/le Required data may vary by integration. To see what data to post, first call [Get create/update supplier model](https://docs.codat.io/lending-api#/operations/get-create-update-suppliers-model). -### Example Usage +### Example Usage: Malformed query + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using System.Collections.Generic; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreateSupplierRequest req = new CreateSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountingSupplier = new AccountingSupplier() { + ModifiedDate = "2022-10-23T00:00:00Z", + SourceModifiedDate = "2022-10-23T00:00:00Z", + Id = "C520FFD4-F6F6-4FC2-A6D2-5D7088B2B14F", + SupplierName = "Kelly's Industrial Supplies", + ContactName = "Kelly's Industrial Supplies", + EmailAddress = "sales@kellysupplies.com", + Phone = "07999 999999", + Addresses = new List() { + new AccountingAddress() { + Type = AccountingAddressType.Billing, + Line1 = "Unit 51", + Line2 = "Bakersfield Industrial Estate", + City = "Bakersfield", + Region = "California", + Country = "USA", + }, + }, + RegistrationNumber = "string", + TaxNumber = "string", + Status = SupplierStatus.Unknown, + DefaultCurrency = "string", + Metadata = new Metadata() { + IsDeleted = true, + }, + SupplementalData = new SupplementalData() { + Content = new Dictionary>() { + { "property1", new Dictionary() { + { "property1", "" }, + { "property2", "" }, + } }, + { "property2", new Dictionary() { + { "property1", "" }, + { "property2", "" }, + } }, + }, + }, + }, +}; + +var res = await sdk.LoanWriteback.Suppliers.CreateAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/codatlendingtransactions/README.md b/lending/docs/sdks/codatlendingtransactions/README.md index 57295bdf..c3115abf 100644 --- a/lending/docs/sdks/codatlendingtransactions/README.md +++ b/lending/docs/sdks/codatlendingtransactions/README.md @@ -16,9 +16,30 @@ The *List transactions* endpoint returns a list of [transactions](https://docs.c Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Basiq - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListBankingTransactionsRequest req = new ListBankingTransactionsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Banking.Transactions.ListAsync(req); + +// handle response +``` +### Example Usage: Plaid + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -65,9 +86,29 @@ The *Get transaction* endpoint returns a single transaction for a given transact Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Basiq + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetBankingTransactionRequest req = new GetBankingTransactionRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + TransactionId = "", +}; + +var res = await sdk.Banking.Transactions.GetAsync(req); + +// handle response +``` +### Example Usage: Plaid - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/codatlendingtransfers/README.md b/lending/docs/sdks/codatlendingtransfers/README.md index c6022e8c..2cf532d8 100644 --- a/lending/docs/sdks/codatlendingtransfers/README.md +++ b/lending/docs/sdks/codatlendingtransfers/README.md @@ -18,9 +18,180 @@ The *Get create transfer model* endpoint returns the expected data for the reque See the *response examples* for integration-specific indicative models. -### Example Usage +### Example Usage: Exact (Netherlands) - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateTransfersModelRequest req = new GetCreateTransfersModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Transfers.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateTransfersModelRequest req = new GetCreateTransfersModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Transfers.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateTransfersModelRequest req = new GetCreateTransfersModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Transfers.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateTransfersModelRequest req = new GetCreateTransfersModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Transfers.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateTransfersModelRequest req = new GetCreateTransfersModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Transfers.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateTransfersModelRequest req = new GetCreateTransfersModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Transfers.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateTransfersModelRequest req = new GetCreateTransfersModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Transfers.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateTransfersModelRequest req = new GetCreateTransfersModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Transfers.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCreateTransfersModelRequest req = new GetCreateTransfersModelRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.LoanWriteback.Transfers.GetCreateModelAsync(req); + +// handle response +``` +### Example Usage: Xero + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -66,9 +237,51 @@ The *Create transfer* endpoint creates a new [transfer](https://docs.codat.io/le Required data may vary by integration. To see what data to post, first call [Get create transfer model](https://docs.codat.io/lending-api#/operations/get-create-transfers-model). -### Example Usage +### Example Usage: Malformed query + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; +using System.Collections.Generic; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreateTransferRequest req = new CreateTransferRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + AccountingTransfer = new AccountingTransfer() { + ModifiedDate = "2022-10-23T00:00:00Z", + SourceModifiedDate = "2022-10-23T00:00:00Z", + Date = "2022-10-23T00:00:00Z", + From = new TransferAccount() { + AccountRef = new AccountingRecordRef() { + DataType = "journalEntry", + }, + Currency = "GBP", + }, + To = new TransferAccount() { + AccountRef = new AccountingRecordRef() { + DataType = "journalEntry", + }, + Currency = "GBP", + }, + DepositedRecordRefs = new List() { + new AccountingRecordRef() { + DataType = "journalEntry", + }, + }, + }, +}; + +var res = await sdk.LoanWriteback.Transfers.CreateAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/companies/README.md b/lending/docs/sdks/companies/README.md index df415942..339363f2 100644 --- a/lending/docs/sdks/companies/README.md +++ b/lending/docs/sdks/companies/README.md @@ -33,9 +33,29 @@ For example, you can use the querying to filter companies tagged with a specific - Region: `region != uk` - Owning team and region: `region = uk && owningTeam = invoice-finance` -### Example Usage +### Example Usage: List of Companies + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCompaniesRequest req = new ListCompaniesRequest() { + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", + Tags = "region=uk && team=invoice-finance", +}; - +var res = await sdk.Companies.ListAsync(req); + +// handle response +``` +### Example Usage: One company + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -81,9 +101,63 @@ Each company can have multiple [connections](https://docs.codat.io/lending-api#/ If 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`. -### Example Usage +### Example Usage: Malformed query + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CompanyRequestBody req = new CompanyRequestBody() { + Name = "Bank of Dave", + Description = "Requested early access to the new financing scheme.", +}; + +var res = await sdk.Companies.CreateAsync(req); + +// handle response +``` +### Example Usage: With a description + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CompanyRequestBody req = new CompanyRequestBody() { + Name = "Technicalium", + Description = "Technology services, including web and app design and development", +}; + +var res = await sdk.Companies.CreateAsync(req); + +// handle response +``` +### Example Usage: With a tag + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CompanyRequestBody req = new CompanyRequestBody() { + Name = "Bank of Dave", + Description = "Requested early access to the new financing scheme.", +}; + +var res = await sdk.Companies.CreateAsync(req); - +// handle response +``` +### Example Usage: With no description + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -124,9 +198,53 @@ var res = await sdk.Companies.CreateAsync(req); A [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data. Each company can have multiple [connections](https://docs.codat.io/lending-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. -### Example Usage +### Example Usage: Unauthorized - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ReplaceCompanyRequest req = new ReplaceCompanyRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CompanyRequestBody = new CompanyRequestBody() { + Name = "Bank of Dave", + Description = "Requested early access to the new financing scheme.", + }, +}; + +var res = await sdk.Companies.ReplaceAsync(req); + +// handle response +``` +### Example Usage: Update description + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ReplaceCompanyRequest req = new ReplaceCompanyRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CompanyRequestBody = new CompanyRequestBody() { + Name = "Same name", + Description = "Additional documents required", + }, +}; + +var res = await sdk.Companies.ReplaceAsync(req); + +// handle response +``` +### Example Usage: Update name + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -172,9 +290,52 @@ The *Update company* endpoint doesn't have any required fields. If any of the fi A [company](https://docs.codat.io/lending-api#/schemas/Company) represents a business sharing access to their data. -### Example Usage +### Example Usage: Unauthorized - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +UpdateCompanyRequest req = new UpdateCompanyRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CompanyUpdateRequest = new CompanyUpdateRequest() { + Name = "Bank of Dave", + Description = "Requested early access to the new financing scheme.", + }, +}; + +var res = await sdk.Companies.UpdateAsync(req); + +// handle response +``` +### Example Usage: Update name + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +UpdateCompanyRequest req = new UpdateCompanyRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CompanyUpdateRequest = new CompanyUpdateRequest() { + Name = "New Name", + }, +}; + +var res = await sdk.Companies.UpdateAsync(req); + +// handle response +``` +### Example Usage: Update tags + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -268,9 +429,45 @@ A [company](https://docs.codat.io/lending-api#/schemas/Company) represents a bus Each company can have multiple [connections](https://docs.codat.io/lending-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. -### Example Usage +### Example Usage: Parent multi-entity company + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCompanyRequest req = new GetCompanyRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", +}; + +var res = await sdk.Companies.GetAsync(req); + +// handle response +``` +### Example Usage: Simple company + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCompanyRequest req = new GetCompanyRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", +}; + +var res = await sdk.Companies.GetAsync(req); + +// handle response +``` +### Example Usage: Subsidiary multi-entity company - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/companyinfo/README.md b/lending/docs/sdks/companyinfo/README.md index 6e5d787d..32af9c39 100644 --- a/lending/docs/sdks/companyinfo/README.md +++ b/lending/docs/sdks/companyinfo/README.md @@ -15,7 +15,7 @@ Gets the latest basic info for a company. ### Example Usage - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -60,7 +60,7 @@ social media or website information." ### Example Usage - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/connections/README.md b/lending/docs/sdks/connections/README.md index 7f553de6..cdcc3b93 100644 --- a/lending/docs/sdks/connections/README.md +++ b/lending/docs/sdks/connections/README.md @@ -18,7 +18,7 @@ Create new and manage existing data connections for a company. ### Example Usage - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -61,9 +61,30 @@ var res = await sdk.Connections.ListAsync(req); Use the [List Integrations](https://docs.codat.io/platform-api#/operations/list-integrations) endpoint to access valid platform keys. -### Example Usage +### Example Usage: Connection + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreateConnectionRequest req = new CreateConnectionRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + RequestBody = new CreateConnectionRequestBody() { + PlatformKey = "gbol", + }, +}; + +var res = await sdk.Connections.CreateAsync(req); + +// handle response +``` +### Example Usage: Unauthorized - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -107,7 +128,7 @@ var res = await sdk.Connections.CreateAsync(req); ### Example Usage - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -192,7 +213,7 @@ var res = await sdk.Connections.DeleteAsync(req); ### Example Usage - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/creditnotes/README.md b/lending/docs/sdks/creditnotes/README.md index ad866fe2..7c1449d1 100644 --- a/lending/docs/sdks/creditnotes/README.md +++ b/lending/docs/sdks/creditnotes/README.md @@ -16,9 +16,269 @@ The *List credit notes* endpoint returns a list of [credit notes](https://docs.c Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Dynamics 365 Business Central - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCreditNotesRequest req = new ListAccountingCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCreditNotesRequest req = new ListAccountingCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCreditNotesRequest req = new ListAccountingCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCreditNotesRequest req = new ListAccountingCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCreditNotesRequest req = new ListAccountingCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCreditNotesRequest req = new ListAccountingCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCreditNotesRequest req = new ListAccountingCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCreditNotesRequest req = new ListAccountingCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCreditNotesRequest req = new ListAccountingCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCreditNotesRequest req = new ListAccountingCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCreditNotesRequest req = new ListAccountingCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCreditNotesRequest req = new ListAccountingCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCreditNotesRequest req = new ListAccountingCreditNotesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.ListAsync(req); + +// handle response +``` +### Example Usage: Zoho Books + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -64,9 +324,256 @@ The *Get credit note* endpoint returns a single credit note for a given creditNo Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCreditNoteRequest req = new GetAccountingCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CreditNoteId = "", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCreditNoteRequest req = new GetAccountingCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CreditNoteId = "", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCreditNoteRequest req = new GetAccountingCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CreditNoteId = "", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCreditNoteRequest req = new GetAccountingCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CreditNoteId = "", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCreditNoteRequest req = new GetAccountingCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CreditNoteId = "", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCreditNoteRequest req = new GetAccountingCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CreditNoteId = "", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCreditNoteRequest req = new GetAccountingCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CreditNoteId = "", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCreditNoteRequest req = new GetAccountingCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CreditNoteId = "", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCreditNoteRequest req = new GetAccountingCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CreditNoteId = "", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCreditNoteRequest req = new GetAccountingCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CreditNoteId = "", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCreditNoteRequest req = new GetAccountingCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CreditNoteId = "", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCreditNoteRequest req = new GetAccountingCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CreditNoteId = "", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCreditNoteRequest req = new GetAccountingCreditNoteRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CreditNoteId = "", +}; + +var res = await sdk.AccountsReceivable.CreditNotes.GetAsync(req); + +// handle response +``` +### Example Usage: Zoho Books - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/customers/README.md b/lending/docs/sdks/customers/README.md index 0aab2b6d..27cc8253 100644 --- a/lending/docs/sdks/customers/README.md +++ b/lending/docs/sdks/customers/README.md @@ -19,9 +19,9 @@ The *List customers* endpoint returns a list of [customers](https://docs.codat.i Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Clear Books - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -39,37 +39,700 @@ var res = await sdk.AccountsReceivable.Customers.ListAsync(req); // handle response ``` +### Example Usage: Dynamics 365 Business Central -### Parameters + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; -| Parameter | Type | Required | Description | -| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `request` | [ListAccountingCustomersRequest](../../Models/Requests/ListAccountingCustomersRequest.md) | :heavy_check_mark: | The request object to use for the request. | +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -### Response +ListAccountingCustomersRequest req = new ListAccountingCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; -**[ListAccountingCustomersResponse](../../Models/Requests/ListAccountingCustomersResponse.md)** +var res = await sdk.AccountsReceivable.Customers.ListAsync(req); -### Errors +// handle response +``` +### Example Usage: Exact (Netherlands) -| Error Type | Status Code | Content Type | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| Codat.Lending.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 409, 429 | application/json | -| Codat.Lending.Models.Errors.ErrorMessage | 500, 503 | application/json | -| Codat.Lending.Models.Errors.SDKException | 4XX, 5XX | \*/\* | + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; -## Get +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -The *Get customer* endpoint returns a single customer for a given customerId. +ListAccountingCustomersRequest req = new ListAccountingCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; -[Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. +var res = await sdk.AccountsReceivable.Customers.ListAsync(req); -Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). +// handle response +``` +### Example Usage: Exact (UK) + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; -### Example Usage +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCustomersRequest req = new ListAccountingCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCustomersRequest req = new ListAccountingCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCustomersRequest req = new ListAccountingCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCustomersRequest req = new ListAccountingCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCustomersRequest req = new ListAccountingCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCustomersRequest req = new ListAccountingCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCustomersRequest req = new ListAccountingCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCustomersRequest req = new ListAccountingCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCustomersRequest req = new ListAccountingCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCustomersRequest req = new ListAccountingCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCustomersRequest req = new ListAccountingCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCustomersRequest req = new ListAccountingCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Wave + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCustomersRequest req = new ListAccountingCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCustomersRequest req = new ListAccountingCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Customers.ListAsync(req); + +// handle response +``` +### Example Usage: Zoho Books + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingCustomersRequest req = new ListAccountingCustomersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Customers.ListAsync(req); + +// handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `request` | [ListAccountingCustomersRequest](../../Models/Requests/ListAccountingCustomersRequest.md) | :heavy_check_mark: | The request object to use for the request. | + +### Response + +**[ListAccountingCustomersResponse](../../Models/Requests/ListAccountingCustomersResponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| Codat.Lending.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 409, 429 | application/json | +| Codat.Lending.Models.Errors.ErrorMessage | 500, 503 | application/json | +| Codat.Lending.Models.Errors.SDKException | 4XX, 5XX | \*/\* | + +## Get + +The *Get customer* endpoint returns a single customer for a given customerId. + +[Customers](https://docs.codat.io/lending-api#/schemas/Customer) are people or organizations that buy goods or services from the SMB. + +Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + +### Example Usage: Clear Books + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCustomerRequest req = new GetAccountingCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCustomerRequest req = new GetAccountingCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCustomerRequest req = new GetAccountingCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCustomerRequest req = new GetAccountingCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCustomerRequest req = new GetAccountingCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCustomerRequest req = new GetAccountingCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCustomerRequest req = new GetAccountingCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCustomerRequest req = new GetAccountingCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCustomerRequest req = new GetAccountingCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCustomerRequest req = new GetAccountingCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCustomerRequest req = new GetAccountingCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCustomerRequest req = new GetAccountingCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCustomerRequest req = new GetAccountingCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCustomerRequest req = new GetAccountingCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCustomerRequest req = new GetAccountingCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Wave + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCustomerRequest req = new GetAccountingCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingCustomerRequest req = new GetAccountingCustomerRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + CustomerId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Customers.GetAsync(req); + +// handle response +``` +### Example Usage: Zoho Books - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/directcosts/README.md b/lending/docs/sdks/directcosts/README.md index 9e3b8c62..9b277eb1 100644 --- a/lending/docs/sdks/directcosts/README.md +++ b/lending/docs/sdks/directcosts/README.md @@ -19,9 +19,198 @@ The *List direct costs* endpoint returns a list of [direct costs](https://docs.c Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Clear Books + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingDirectCostsRequest req = new ListAccountingDirectCostsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.DirectCosts.ListAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingDirectCostsRequest req = new ListAccountingDirectCostsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.DirectCosts.ListAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingDirectCostsRequest req = new ListAccountingDirectCostsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.DirectCosts.ListAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingDirectCostsRequest req = new ListAccountingDirectCostsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.DirectCosts.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); - +ListAccountingDirectCostsRequest req = new ListAccountingDirectCostsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.DirectCosts.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingDirectCostsRequest req = new ListAccountingDirectCostsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.DirectCosts.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingDirectCostsRequest req = new ListAccountingDirectCostsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.DirectCosts.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingDirectCostsRequest req = new ListAccountingDirectCostsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.DirectCosts.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingDirectCostsRequest req = new ListAccountingDirectCostsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.DirectCosts.ListAsync(req); + +// handle response +``` +### Example Usage: Xero + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -68,9 +257,189 @@ The *Get direct cost* endpoint returns a single direct cost for a given directCo Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Clear Books + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingDirectCostRequest req = new GetAccountingDirectCostRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + DirectCostId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.DirectCosts.GetAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingDirectCostRequest req = new GetAccountingDirectCostRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + DirectCostId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.DirectCosts.GetAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingDirectCostRequest req = new GetAccountingDirectCostRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + DirectCostId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.DirectCosts.GetAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingDirectCostRequest req = new GetAccountingDirectCostRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + DirectCostId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.DirectCosts.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingDirectCostRequest req = new GetAccountingDirectCostRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + DirectCostId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.DirectCosts.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingDirectCostRequest req = new GetAccountingDirectCostRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + DirectCostId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.DirectCosts.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingDirectCostRequest req = new GetAccountingDirectCostRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + DirectCostId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.DirectCosts.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingDirectCostRequest req = new GetAccountingDirectCostRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + DirectCostId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.DirectCosts.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingDirectCostRequest req = new GetAccountingDirectCostRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + DirectCostId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.DirectCosts.GetAsync(req); + +// handle response +``` +### Example Usage: Xero - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/directincomes/README.md b/lending/docs/sdks/directincomes/README.md index 13a0635b..eb736d6f 100644 --- a/lending/docs/sdks/directincomes/README.md +++ b/lending/docs/sdks/directincomes/README.md @@ -19,9 +19,156 @@ The *List direct incomes* endpoint returns a list of [direct incomes](https://do Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Clear Books + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingDirectIncomesRequest req = new ListAccountingDirectIncomesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.DirectIncomes.ListAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingDirectIncomesRequest req = new ListAccountingDirectIncomesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.DirectIncomes.ListAsync(req); - +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingDirectIncomesRequest req = new ListAccountingDirectIncomesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.DirectIncomes.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingDirectIncomesRequest req = new ListAccountingDirectIncomesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.DirectIncomes.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingDirectIncomesRequest req = new ListAccountingDirectIncomesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.DirectIncomes.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingDirectIncomesRequest req = new ListAccountingDirectIncomesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.DirectIncomes.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingDirectIncomesRequest req = new ListAccountingDirectIncomesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.DirectIncomes.ListAsync(req); + +// handle response +``` +### Example Usage: Xero + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -68,9 +215,149 @@ The *Get direct income* endpoint returns a single direct income for a given dire Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Clear Books + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingDirectIncomeRequest req = new GetAccountingDirectIncomeRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + DirectIncomeId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.DirectIncomes.GetAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingDirectIncomeRequest req = new GetAccountingDirectIncomeRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + DirectIncomeId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.DirectIncomes.GetAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingDirectIncomeRequest req = new GetAccountingDirectIncomeRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + DirectIncomeId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.DirectIncomes.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingDirectIncomeRequest req = new GetAccountingDirectIncomeRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + DirectIncomeId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.DirectIncomes.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingDirectIncomeRequest req = new GetAccountingDirectIncomeRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + DirectIncomeId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.DirectIncomes.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingDirectIncomeRequest req = new GetAccountingDirectIncomeRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + DirectIncomeId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.DirectIncomes.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingDirectIncomeRequest req = new GetAccountingDirectIncomeRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + DirectIncomeId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.DirectIncomes.GetAsync(req); + +// handle response +``` +### Example Usage: Xero - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/disputes/README.md b/lending/docs/sdks/disputes/README.md index 435237b4..ed563c7c 100644 --- a/lending/docs/sdks/disputes/README.md +++ b/lending/docs/sdks/disputes/README.md @@ -16,9 +16,30 @@ The *List disputes* endpoint returns a list of [disputes](https://docs.codat.io/ Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Shopify - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceDisputesRequest req = new ListCommerceDisputesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Disputes.ListAsync(req); + +// handle response +``` +### Example Usage: Stripe Test + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -65,9 +86,29 @@ The *Get dispute* endpoint returns a single dispute for a given disputeId. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Shopify + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceDisputeRequest req = new GetCommerceDisputeRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + DisputeId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Disputes.GetAsync(req); + +// handle response +``` +### Example Usage: Stripe Test - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/invoices/README.md b/lending/docs/sdks/invoices/README.md index 446171d8..e1c6a400 100644 --- a/lending/docs/sdks/invoices/README.md +++ b/lending/docs/sdks/invoices/README.md @@ -74,9 +74,9 @@ Before using this endpoint, you must have [retrieved data for the company](https To access the `paymentAllocations` property, ensure that the `payments` data type is queued and cached in Codat before retrieving `invoices` from Codat's cache. -### Example Usage +### Example Usage: Clear Books - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -94,41 +94,704 @@ var res = await sdk.AccountsReceivable.Invoices.ListAsync(req); // handle response ``` +### Example Usage: Dynamics 365 Business Central -### Parameters + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; -| Parameter | Type | Required | Description | -| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `request` | [ListAccountingInvoicesRequest](../../Models/Requests/ListAccountingInvoicesRequest.md) | :heavy_check_mark: | The request object to use for the request. | +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -### Response +ListAccountingInvoicesRequest req = new ListAccountingInvoicesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; -**[ListAccountingInvoicesResponse](../../Models/Requests/ListAccountingInvoicesResponse.md)** +var res = await sdk.AccountsReceivable.Invoices.ListAsync(req); -### Errors +// handle response +``` +### Example Usage: Exact (Netherlands) -| Error Type | Status Code | Content Type | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| Codat.Lending.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 409, 429 | application/json | -| Codat.Lending.Models.Errors.ErrorMessage | 500, 503 | application/json | -| Codat.Lending.Models.Errors.SDKException | 4XX, 5XX | \*/\* | + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; -## Get +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -The *Get invoice* endpoint returns a single invoice for a given invoiceId. +ListAccountingInvoicesRequest req = new ListAccountingInvoicesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; -[Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. +var res = await sdk.AccountsReceivable.Invoices.ListAsync(req); -Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). +// handle response +``` +### Example Usage: Exact (UK) -### Tips and traps + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; -To access the `paymentAllocations` property, ensure that the `payments` data type is queued and cached in Codat before retrieving `invoices` from Codat's cache. +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); +ListAccountingInvoicesRequest req = new ListAccountingInvoicesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; -### Example Usage +var res = await sdk.AccountsReceivable.Invoices.ListAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingInvoicesRequest req = new ListAccountingInvoicesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Invoices.ListAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingInvoicesRequest req = new ListAccountingInvoicesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Invoices.ListAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingInvoicesRequest req = new ListAccountingInvoicesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Invoices.ListAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingInvoicesRequest req = new ListAccountingInvoicesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Invoices.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingInvoicesRequest req = new ListAccountingInvoicesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Invoices.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingInvoicesRequest req = new ListAccountingInvoicesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Invoices.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingInvoicesRequest req = new ListAccountingInvoicesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Invoices.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingInvoicesRequest req = new ListAccountingInvoicesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Invoices.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingInvoicesRequest req = new ListAccountingInvoicesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Invoices.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingInvoicesRequest req = new ListAccountingInvoicesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Invoices.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingInvoicesRequest req = new ListAccountingInvoicesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Invoices.ListAsync(req); + +// handle response +``` +### Example Usage: Wave + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingInvoicesRequest req = new ListAccountingInvoicesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Invoices.ListAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingInvoicesRequest req = new ListAccountingInvoicesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Invoices.ListAsync(req); + +// handle response +``` +### Example Usage: Zoho Books + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingInvoicesRequest req = new ListAccountingInvoicesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Invoices.ListAsync(req); + +// handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `request` | [ListAccountingInvoicesRequest](../../Models/Requests/ListAccountingInvoicesRequest.md) | :heavy_check_mark: | The request object to use for the request. | + +### Response + +**[ListAccountingInvoicesResponse](../../Models/Requests/ListAccountingInvoicesResponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| Codat.Lending.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 409, 429 | application/json | +| Codat.Lending.Models.Errors.ErrorMessage | 500, 503 | application/json | +| Codat.Lending.Models.Errors.SDKException | 4XX, 5XX | \*/\* | + +## Get + +The *Get invoice* endpoint returns a single invoice for a given invoiceId. + +[Invoices](https://docs.codat.io/lending-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer. + +Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + +### Tips and traps + +To access the `paymentAllocations` property, ensure that the `payments` data type is queued and cached in Codat before retrieving `invoices` from Codat's cache. + + +### Example Usage: Clear Books + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingInvoiceRequest req = new GetAccountingInvoiceRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + InvoiceId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Invoices.GetAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingInvoiceRequest req = new GetAccountingInvoiceRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + InvoiceId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Invoices.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingInvoiceRequest req = new GetAccountingInvoiceRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + InvoiceId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Invoices.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingInvoiceRequest req = new GetAccountingInvoiceRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + InvoiceId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Invoices.GetAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingInvoiceRequest req = new GetAccountingInvoiceRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + InvoiceId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Invoices.GetAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingInvoiceRequest req = new GetAccountingInvoiceRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + InvoiceId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Invoices.GetAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingInvoiceRequest req = new GetAccountingInvoiceRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + InvoiceId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Invoices.GetAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingInvoiceRequest req = new GetAccountingInvoiceRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + InvoiceId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Invoices.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingInvoiceRequest req = new GetAccountingInvoiceRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + InvoiceId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Invoices.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingInvoiceRequest req = new GetAccountingInvoiceRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + InvoiceId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Invoices.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingInvoiceRequest req = new GetAccountingInvoiceRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + InvoiceId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Invoices.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingInvoiceRequest req = new GetAccountingInvoiceRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + InvoiceId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Invoices.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingInvoiceRequest req = new GetAccountingInvoiceRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + InvoiceId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Invoices.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingInvoiceRequest req = new GetAccountingInvoiceRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + InvoiceId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Invoices.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingInvoiceRequest req = new GetAccountingInvoiceRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + InvoiceId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Invoices.GetAsync(req); + +// handle response +``` +### Example Usage: Wave + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingInvoiceRequest req = new GetAccountingInvoiceRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + InvoiceId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Invoices.GetAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingInvoiceRequest req = new GetAccountingInvoiceRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + InvoiceId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Invoices.GetAsync(req); + +// handle response +``` +### Example Usage: Zoho Books - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/journalentries/README.md b/lending/docs/sdks/journalentries/README.md index a933a575..ab1fa68f 100644 --- a/lending/docs/sdks/journalentries/README.md +++ b/lending/docs/sdks/journalentries/README.md @@ -16,9 +16,249 @@ The *List journal entries* endpoint returns a list of [journal entries](https:// Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Clear Books - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingJournalEntriesRequest req = new ListAccountingJournalEntriesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.JournalEntries.ListAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingJournalEntriesRequest req = new ListAccountingJournalEntriesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.JournalEntries.ListAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingJournalEntriesRequest req = new ListAccountingJournalEntriesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.JournalEntries.ListAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingJournalEntriesRequest req = new ListAccountingJournalEntriesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.JournalEntries.ListAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingJournalEntriesRequest req = new ListAccountingJournalEntriesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.JournalEntries.ListAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingJournalEntriesRequest req = new ListAccountingJournalEntriesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.JournalEntries.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingJournalEntriesRequest req = new ListAccountingJournalEntriesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.JournalEntries.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingJournalEntriesRequest req = new ListAccountingJournalEntriesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.JournalEntries.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingJournalEntriesRequest req = new ListAccountingJournalEntriesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.JournalEntries.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingJournalEntriesRequest req = new ListAccountingJournalEntriesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.JournalEntries.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingJournalEntriesRequest req = new ListAccountingJournalEntriesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.JournalEntries.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingJournalEntriesRequest req = new ListAccountingJournalEntriesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.JournalEntries.ListAsync(req); + +// handle response +``` +### Example Usage: Xero + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -64,9 +304,237 @@ The *Get journal entry* endpoint returns a single journal entry for a given jour Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Clear Books + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingJournalEntryRequest req = new GetAccountingJournalEntryRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + JournalEntryId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.JournalEntries.GetAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingJournalEntryRequest req = new GetAccountingJournalEntryRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + JournalEntryId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.JournalEntries.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingJournalEntryRequest req = new GetAccountingJournalEntryRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + JournalEntryId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.JournalEntries.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingJournalEntryRequest req = new GetAccountingJournalEntryRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + JournalEntryId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.JournalEntries.GetAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingJournalEntryRequest req = new GetAccountingJournalEntryRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + JournalEntryId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.JournalEntries.GetAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingJournalEntryRequest req = new GetAccountingJournalEntryRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + JournalEntryId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.JournalEntries.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingJournalEntryRequest req = new GetAccountingJournalEntryRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + JournalEntryId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.JournalEntries.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingJournalEntryRequest req = new GetAccountingJournalEntryRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + JournalEntryId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.JournalEntries.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingJournalEntryRequest req = new GetAccountingJournalEntryRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + JournalEntryId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.JournalEntries.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingJournalEntryRequest req = new GetAccountingJournalEntryRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + JournalEntryId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.JournalEntries.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingJournalEntryRequest req = new GetAccountingJournalEntryRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + JournalEntryId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.JournalEntries.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingJournalEntryRequest req = new GetAccountingJournalEntryRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + JournalEntryId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.JournalEntries.GetAsync(req); + +// handle response +``` +### Example Usage: Xero - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/journals/README.md b/lending/docs/sdks/journals/README.md index 9bb56e64..f5bd2f18 100644 --- a/lending/docs/sdks/journals/README.md +++ b/lending/docs/sdks/journals/README.md @@ -16,9 +16,89 @@ The *List journals* endpoint returns a list of [journals](https://docs.codat.io/ Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Clear Books - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingJournalsRequest req = new ListAccountingJournalsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.Journals.ListAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingJournalsRequest req = new ListAccountingJournalsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.Journals.ListAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingJournalsRequest req = new ListAccountingJournalsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.Journals.ListAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingJournalsRequest req = new ListAccountingJournalsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.Journals.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -64,9 +144,85 @@ The *Get journal* endpoint returns a single journal for a given journalId. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Clear Books + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingJournalRequest req = new GetAccountingJournalRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + JournalId = "", +}; + +var res = await sdk.Transactions.Journals.GetAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingJournalRequest req = new GetAccountingJournalRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + JournalId = "", +}; + +var res = await sdk.Transactions.Journals.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingJournalRequest req = new GetAccountingJournalRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + JournalId = "", +}; + +var res = await sdk.Transactions.Journals.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingJournalRequest req = new GetAccountingJournalRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + JournalId = "", +}; + +var res = await sdk.Transactions.Journals.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/locations/README.md b/lending/docs/sdks/locations/README.md index 6208f2fc..c18ecc85 100644 --- a/lending/docs/sdks/locations/README.md +++ b/lending/docs/sdks/locations/README.md @@ -16,9 +16,66 @@ The *List locations* endpoint returns a list of [locations](https://docs.codat.i Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Clover - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceLocationsRequest req = new ListCommerceLocationsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.Sales.Locations.ListAsync(req); + +// handle response +``` +### Example Usage: Lightspeed K Trial + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceLocationsRequest req = new ListCommerceLocationsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.Sales.Locations.ListAsync(req); + +// handle response +``` +### Example Usage: Shopify + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceLocationsRequest req = new ListCommerceLocationsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", +}; + +var res = await sdk.Sales.Locations.ListAsync(req); + +// handle response +``` +### Example Usage: Square + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -63,9 +120,69 @@ The *Get location* endpoint returns a single location for a given locationId. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Clover + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceLocationRequest req = new GetCommerceLocationRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + LocationId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Locations.GetAsync(req); + +// handle response +``` +### Example Usage: Lightspeed K Trial + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceLocationRequest req = new GetCommerceLocationRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + LocationId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Locations.GetAsync(req); + +// handle response +``` +### Example Usage: Shopify + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceLocationRequest req = new GetCommerceLocationRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + LocationId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Locations.GetAsync(req); + +// handle response +``` +### Example Usage: Square - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/managedata/README.md b/lending/docs/sdks/managedata/README.md index 2b34ed83..1f79f00c 100644 --- a/lending/docs/sdks/managedata/README.md +++ b/lending/docs/sdks/managedata/README.md @@ -12,7 +12,7 @@ Get the state of each data type for a company ### Example Usage - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/managereports/README.md b/lending/docs/sdks/managereports/README.md index ed0f6449..f562bc8a 100644 --- a/lending/docs/sdks/managereports/README.md +++ b/lending/docs/sdks/managereports/README.md @@ -17,7 +17,7 @@ This action triggers the system to refresh and pull the necessary data from the ### Example Usage - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/orders/README.md b/lending/docs/sdks/orders/README.md index 768221a6..435cd2a1 100644 --- a/lending/docs/sdks/orders/README.md +++ b/lending/docs/sdks/orders/README.md @@ -16,9 +16,261 @@ The *List orders* endpoint returns a list of [orders](https://docs.codat.io/lend Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Amazon Seller Central - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceOrdersRequest req = new ListCommerceOrdersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Orders.ListAsync(req); + +// handle response +``` +### Example Usage: BigCommerce + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceOrdersRequest req = new ListCommerceOrdersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Orders.ListAsync(req); + +// handle response +``` +### Example Usage: Clover + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceOrdersRequest req = new ListCommerceOrdersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Orders.ListAsync(req); + +// handle response +``` +### Example Usage: Lightspeed K Trial + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceOrdersRequest req = new ListCommerceOrdersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Orders.ListAsync(req); + +// handle response +``` +### Example Usage: Mollie + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceOrdersRequest req = new ListCommerceOrdersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Orders.ListAsync(req); + +// handle response +``` +### Example Usage: Mollie Test + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceOrdersRequest req = new ListCommerceOrdersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Orders.ListAsync(req); + +// handle response +``` +### Example Usage: Partner Commerce + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceOrdersRequest req = new ListCommerceOrdersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Orders.ListAsync(req); + +// handle response +``` +### Example Usage: PrestaShop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceOrdersRequest req = new ListCommerceOrdersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Orders.ListAsync(req); + +// handle response +``` +### Example Usage: Shopify + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceOrdersRequest req = new ListCommerceOrdersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Orders.ListAsync(req); + +// handle response +``` +### Example Usage: Square + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceOrdersRequest req = new ListCommerceOrdersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Orders.ListAsync(req); + +// handle response +``` +### Example Usage: SumUp + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceOrdersRequest req = new ListCommerceOrdersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Orders.ListAsync(req); + +// handle response +``` +### Example Usage: WooCommerce + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceOrdersRequest req = new ListCommerceOrdersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Orders.ListAsync(req); + +// handle response +``` +### Example Usage: Zettle + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -65,9 +317,249 @@ The *Get order* endpoint returns a single order for a given orderId. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Amazon Seller Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceOrderRequest req = new GetCommerceOrderRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + OrderId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Orders.GetAsync(req); + +// handle response +``` +### Example Usage: BigCommerce + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceOrderRequest req = new GetCommerceOrderRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + OrderId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Orders.GetAsync(req); + +// handle response +``` +### Example Usage: Clover + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceOrderRequest req = new GetCommerceOrderRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + OrderId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Orders.GetAsync(req); + +// handle response +``` +### Example Usage: Lightspeed K Trial + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceOrderRequest req = new GetCommerceOrderRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + OrderId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Orders.GetAsync(req); + +// handle response +``` +### Example Usage: Mollie + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceOrderRequest req = new GetCommerceOrderRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + OrderId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Orders.GetAsync(req); + +// handle response +``` +### Example Usage: Mollie Test + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceOrderRequest req = new GetCommerceOrderRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + OrderId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Orders.GetAsync(req); + +// handle response +``` +### Example Usage: Partner Commerce + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceOrderRequest req = new GetCommerceOrderRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + OrderId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Orders.GetAsync(req); + +// handle response +``` +### Example Usage: PrestaShop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceOrderRequest req = new GetCommerceOrderRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + OrderId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Orders.GetAsync(req); + +// handle response +``` +### Example Usage: Shopify + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceOrderRequest req = new GetCommerceOrderRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + OrderId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Orders.GetAsync(req); + +// handle response +``` +### Example Usage: Square + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceOrderRequest req = new GetCommerceOrderRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + OrderId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Orders.GetAsync(req); + +// handle response +``` +### Example Usage: SumUp + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceOrderRequest req = new GetCommerceOrderRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + OrderId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Orders.GetAsync(req); + +// handle response +``` +### Example Usage: WooCommerce + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceOrderRequest req = new GetCommerceOrderRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + OrderId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Orders.GetAsync(req); + +// handle response +``` +### Example Usage: Zettle - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/paymentmethods/README.md b/lending/docs/sdks/paymentmethods/README.md index 6556b1b7..2ac0b538 100644 --- a/lending/docs/sdks/paymentmethods/README.md +++ b/lending/docs/sdks/paymentmethods/README.md @@ -16,9 +16,156 @@ The *List payment methods* endpoint returns a list of [payment methods](https:// Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Amazon Seller Central - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommercePaymentMethodsRequest req = new ListCommercePaymentMethodsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.PaymentMethods.ListAsync(req); + +// handle response +``` +### Example Usage: BigCommerce + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommercePaymentMethodsRequest req = new ListCommercePaymentMethodsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.PaymentMethods.ListAsync(req); + +// handle response +``` +### Example Usage: Clover + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommercePaymentMethodsRequest req = new ListCommercePaymentMethodsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.PaymentMethods.ListAsync(req); + +// handle response +``` +### Example Usage: Lightspeed K Trial + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommercePaymentMethodsRequest req = new ListCommercePaymentMethodsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.PaymentMethods.ListAsync(req); + +// handle response +``` +### Example Usage: Mollie + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommercePaymentMethodsRequest req = new ListCommercePaymentMethodsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.PaymentMethods.ListAsync(req); + +// handle response +``` +### Example Usage: Mollie Test + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommercePaymentMethodsRequest req = new ListCommercePaymentMethodsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.PaymentMethods.ListAsync(req); + +// handle response +``` +### Example Usage: Square + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommercePaymentMethodsRequest req = new ListCommercePaymentMethodsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.PaymentMethods.ListAsync(req); + +// handle response +``` +### Example Usage: SumUp + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -65,9 +212,149 @@ The *Get payment method* endpoint returns a single payment method for a given pa Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Amazon Seller Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommercePaymentMethodRequest req = new GetCommercePaymentMethodRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + PaymentMethodId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.PaymentMethods.GetAsync(req); + +// handle response +``` +### Example Usage: BigCommerce + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommercePaymentMethodRequest req = new GetCommercePaymentMethodRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + PaymentMethodId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.PaymentMethods.GetAsync(req); + +// handle response +``` +### Example Usage: Clover + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommercePaymentMethodRequest req = new GetCommercePaymentMethodRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + PaymentMethodId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.PaymentMethods.GetAsync(req); + +// handle response +``` +### Example Usage: Lightspeed K Trial + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommercePaymentMethodRequest req = new GetCommercePaymentMethodRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + PaymentMethodId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.PaymentMethods.GetAsync(req); + +// handle response +``` +### Example Usage: Mollie + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommercePaymentMethodRequest req = new GetCommercePaymentMethodRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + PaymentMethodId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.PaymentMethods.GetAsync(req); + +// handle response +``` +### Example Usage: Mollie Test + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommercePaymentMethodRequest req = new GetCommercePaymentMethodRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + PaymentMethodId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.PaymentMethods.GetAsync(req); + +// handle response +``` +### Example Usage: Square + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommercePaymentMethodRequest req = new GetCommercePaymentMethodRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + PaymentMethodId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.PaymentMethods.GetAsync(req); + +// handle response +``` +### Example Usage: SumUp - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/payments/README.md b/lending/docs/sdks/payments/README.md index 519507f4..44c5ef4b 100644 --- a/lending/docs/sdks/payments/README.md +++ b/lending/docs/sdks/payments/README.md @@ -16,9 +16,329 @@ The *List payments* endpoint returns a list of [payments](https://docs.codat.io/ Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Clear Books - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingPaymentsRequest req = new ListAccountingPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingPaymentsRequest req = new ListAccountingPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingPaymentsRequest req = new ListAccountingPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingPaymentsRequest req = new ListAccountingPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingPaymentsRequest req = new ListAccountingPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingPaymentsRequest req = new ListAccountingPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingPaymentsRequest req = new ListAccountingPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingPaymentsRequest req = new ListAccountingPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingPaymentsRequest req = new ListAccountingPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingPaymentsRequest req = new ListAccountingPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingPaymentsRequest req = new ListAccountingPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingPaymentsRequest req = new ListAccountingPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingPaymentsRequest req = new ListAccountingPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingPaymentsRequest req = new ListAccountingPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingPaymentsRequest req = new ListAccountingPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingPaymentsRequest req = new ListAccountingPaymentsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsReceivable.Payments.ListAsync(req); + +// handle response +``` +### Example Usage: Zoho Books + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -39,34 +359,338 @@ var res = await sdk.AccountsReceivable.Payments.ListAsync(req); ### Parameters -| Parameter | Type | Required | Description | -| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `request` | [ListAccountingPaymentsRequest](../../Models/Requests/ListAccountingPaymentsRequest.md) | :heavy_check_mark: | The request object to use for the request. | +| Parameter | Type | Required | Description | +| --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `request` | [ListAccountingPaymentsRequest](../../Models/Requests/ListAccountingPaymentsRequest.md) | :heavy_check_mark: | The request object to use for the request. | + +### Response + +**[ListAccountingPaymentsResponse](../../Models/Requests/ListAccountingPaymentsResponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| Codat.Lending.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 409, 429 | application/json | +| Codat.Lending.Models.Errors.ErrorMessage | 500, 503 | application/json | +| Codat.Lending.Models.Errors.SDKException | 4XX, 5XX | \*/\* | + +## Get + +The *Get payment* endpoint returns a single payment for a given paymentId. + +[Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. + +Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + +### Example Usage: Clear Books + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingPaymentRequest req = new GetAccountingPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Payments.GetAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -### Response +GetAccountingPaymentRequest req = new GetAccountingPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; -**[ListAccountingPaymentsResponse](../../Models/Requests/ListAccountingPaymentsResponse.md)** +var res = await sdk.AccountsReceivable.Payments.GetAsync(req); -### Errors +// handle response +``` +### Example Usage: Exact (Netherlands) -| Error Type | Status Code | Content Type | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| Codat.Lending.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 409, 429 | application/json | -| Codat.Lending.Models.Errors.ErrorMessage | 500, 503 | application/json | -| Codat.Lending.Models.Errors.SDKException | 4XX, 5XX | \*/\* | + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; -## Get +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -The *Get payment* endpoint returns a single payment for a given paymentId. +GetAccountingPaymentRequest req = new GetAccountingPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; -[Payments](https://docs.codat.io/lending-api#/schemas/Payment) represent an allocation of money within any customer accounts receivable account. +var res = await sdk.AccountsReceivable.Payments.GetAsync(req); -Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingPaymentRequest req = new GetAccountingPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Payments.GetAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingPaymentRequest req = new GetAccountingPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Payments.GetAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingPaymentRequest req = new GetAccountingPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Payments.GetAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingPaymentRequest req = new GetAccountingPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Payments.GetAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingPaymentRequest req = new GetAccountingPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Payments.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingPaymentRequest req = new GetAccountingPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Payments.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingPaymentRequest req = new GetAccountingPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Payments.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingPaymentRequest req = new GetAccountingPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Payments.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingPaymentRequest req = new GetAccountingPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Payments.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingPaymentRequest req = new GetAccountingPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Payments.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingPaymentRequest req = new GetAccountingPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Payments.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingPaymentRequest req = new GetAccountingPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Payments.GetAsync(req); + +// handle response +``` +### Example Usage: Xero -### Example Usage + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingPaymentRequest req = new GetAccountingPaymentRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PaymentId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsReceivable.Payments.GetAsync(req); + +// handle response +``` +### Example Usage: Zoho Books - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/productcategories/README.md b/lending/docs/sdks/productcategories/README.md index 01365286..4d038eda 100644 --- a/lending/docs/sdks/productcategories/README.md +++ b/lending/docs/sdks/productcategories/README.md @@ -18,7 +18,7 @@ Before using this endpoint, you must have [retrieved data for the company](https ### Example Usage - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -67,7 +67,7 @@ Before using this endpoint, you must have [retrieved data for the company](https ### Example Usage - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/products/README.md b/lending/docs/sdks/products/README.md index ce493183..e02c6fff 100644 --- a/lending/docs/sdks/products/README.md +++ b/lending/docs/sdks/products/README.md @@ -16,9 +16,198 @@ The *List products* endpoint returns a list of [products](https://docs.codat.io/ Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Amazon Seller Central - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceProductsRequest req = new ListCommerceProductsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Products.ListAsync(req); + +// handle response +``` +### Example Usage: BigCommerce + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceProductsRequest req = new ListCommerceProductsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Products.ListAsync(req); + +// handle response +``` +### Example Usage: Clover + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceProductsRequest req = new ListCommerceProductsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Products.ListAsync(req); + +// handle response +``` +### Example Usage: Lightspeed K Trial + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceProductsRequest req = new ListCommerceProductsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Products.ListAsync(req); + +// handle response +``` +### Example Usage: PrestaShop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceProductsRequest req = new ListCommerceProductsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Products.ListAsync(req); + +// handle response +``` +### Example Usage: Shopify + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceProductsRequest req = new ListCommerceProductsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Products.ListAsync(req); + +// handle response +``` +### Example Usage: Square + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceProductsRequest req = new ListCommerceProductsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Products.ListAsync(req); + +// handle response +``` +### Example Usage: Stripe Test + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceProductsRequest req = new ListCommerceProductsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Products.ListAsync(req); + +// handle response +``` +### Example Usage: WooCommerce + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListCommerceProductsRequest req = new ListCommerceProductsRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Sales.Products.ListAsync(req); + +// handle response +``` +### Example Usage: Zettle + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -65,9 +254,189 @@ The *Get product* endpoint returns a single product for a given productId. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Amazon Seller Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceProductRequest req = new GetCommerceProductRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + ProductId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Products.GetAsync(req); + +// handle response +``` +### Example Usage: BigCommerce + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceProductRequest req = new GetCommerceProductRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + ProductId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Products.GetAsync(req); + +// handle response +``` +### Example Usage: Clover + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceProductRequest req = new GetCommerceProductRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + ProductId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Products.GetAsync(req); + +// handle response +``` +### Example Usage: Lightspeed K Trial + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceProductRequest req = new GetCommerceProductRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + ProductId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Products.GetAsync(req); + +// handle response +``` +### Example Usage: PrestaShop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceProductRequest req = new GetCommerceProductRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + ProductId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Products.GetAsync(req); + +// handle response +``` +### Example Usage: Shopify + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceProductRequest req = new GetCommerceProductRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + ProductId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Products.GetAsync(req); + +// handle response +``` +### Example Usage: Square + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceProductRequest req = new GetCommerceProductRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + ProductId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Products.GetAsync(req); + +// handle response +``` +### Example Usage: Stripe Test + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceProductRequest req = new GetCommerceProductRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + ProductId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Products.GetAsync(req); + +// handle response +``` +### Example Usage: WooCommerce + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetCommerceProductRequest req = new GetCommerceProductRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + ProductId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Sales.Products.GetAsync(req); + +// handle response +``` +### Example Usage: Zettle - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/profitandloss/README.md b/lending/docs/sdks/profitandloss/README.md index cc1025f7..bbf727b6 100644 --- a/lending/docs/sdks/profitandloss/README.md +++ b/lending/docs/sdks/profitandloss/README.md @@ -55,9 +55,345 @@ var res = await sdk.FinancialStatements.ProfitAndLoss.GetCategorizedAccountsAsyn Gets the latest profit and loss for a company. -### Example Usage +### Example Usage: Clear Books + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingProfitAndLossRequest req = new GetAccountingProfitAndLossRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.ProfitAndLoss.GetAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingProfitAndLossRequest req = new GetAccountingProfitAndLossRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.ProfitAndLoss.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingProfitAndLossRequest req = new GetAccountingProfitAndLossRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.ProfitAndLoss.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingProfitAndLossRequest req = new GetAccountingProfitAndLossRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.ProfitAndLoss.GetAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingProfitAndLossRequest req = new GetAccountingProfitAndLossRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.ProfitAndLoss.GetAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingProfitAndLossRequest req = new GetAccountingProfitAndLossRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.ProfitAndLoss.GetAsync(req); + +// handle response +``` +### Example Usage: MYOB AccountRight and Essentials + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingProfitAndLossRequest req = new GetAccountingProfitAndLossRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.ProfitAndLoss.GetAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingProfitAndLossRequest req = new GetAccountingProfitAndLossRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.ProfitAndLoss.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingProfitAndLossRequest req = new GetAccountingProfitAndLossRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.ProfitAndLoss.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingProfitAndLossRequest req = new GetAccountingProfitAndLossRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.ProfitAndLoss.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingProfitAndLossRequest req = new GetAccountingProfitAndLossRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.ProfitAndLoss.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingProfitAndLossRequest req = new GetAccountingProfitAndLossRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.ProfitAndLoss.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingProfitAndLossRequest req = new GetAccountingProfitAndLossRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.ProfitAndLoss.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingProfitAndLossRequest req = new GetAccountingProfitAndLossRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.ProfitAndLoss.GetAsync(req); + +// handle response +``` +### Example Usage: Wave + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingProfitAndLossRequest req = new GetAccountingProfitAndLossRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.ProfitAndLoss.GetAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingProfitAndLossRequest req = new GetAccountingProfitAndLossRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + PeriodLength = 4, + PeriodsToCompare = 20, + StartMonth = "2022-10-23T00:00:00Z", +}; + +var res = await sdk.FinancialStatements.ProfitAndLoss.GetAsync(req); + +// handle response +``` +### Example Usage: Zoho Books - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/pulloperations/README.md b/lending/docs/sdks/pulloperations/README.md index 62417936..aa9db7be 100644 --- a/lending/docs/sdks/pulloperations/README.md +++ b/lending/docs/sdks/pulloperations/README.md @@ -13,7 +13,7 @@ Gets the pull operation history (datasets) for a given company. ### Example Usage - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/sourceaccounts/README.md b/lending/docs/sdks/sourceaccounts/README.md index e36f4b64..1990154b 100644 --- a/lending/docs/sdks/sourceaccounts/README.md +++ b/lending/docs/sdks/sourceaccounts/README.md @@ -15,9 +15,66 @@ The _Create Source Account_ endpoint allows you to create a representation of a > ### 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. -### Example Usage +### Example Usage: Malformed query - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreateSourceAccountRequest req = new CreateSourceAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + RequestBody = CreateSourceAccountRequestBody.CreateSourceAccountPrototype( + new SourceAccountPrototype() { + Id = "", + Currency = "GBP", + ModifiedDate = "2022-10-23T00:00:00Z", + } + ), +}; + +var res = await sdk.LoanWriteback.SourceAccounts.CreateAsync(req); + +// handle response +``` +### Example Usage: Version 1 + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreateSourceAccountRequest req = new CreateSourceAccountRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + RequestBody = CreateSourceAccountRequestBody.CreateSourceAccountPrototype( + new SourceAccountPrototype() { + Id = "acc-002", + AccountName = "account-081", + AccountType = "Credit", + AccountNumber = "12345670", + SortCode = "123456", + Currency = "GBP", + Balance = 99.99M, + ModifiedDate = "2023-01-09T14:14:14.1057478Z", + } + ), +}; + +var res = await sdk.LoanWriteback.SourceAccounts.CreateAsync(req); + +// handle response +``` +### Example Usage: Version 2 + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -72,7 +129,7 @@ A bank feed account mapping is a specified link between the source account (prov ### Example Usage - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -141,9 +198,32 @@ The method of mapping the source account to the target account varies depending | QuickBooks Online | | | ✅ | | Sage | | | ✅ | -### Example Usage +### Example Usage: Example + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +CreateBankAccountMappingRequest req = new CreateBankAccountMappingRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + BankFeedBankAccountMapping = new BankFeedBankAccountMapping() { + SourceAccountId = "acc-002", + TargetAccountId = "account-081", + }, +}; + +var res = await sdk.LoanWriteback.SourceAccounts.CreateMappingAsync(req); + +// handle response +``` +### Example Usage: Malformed query - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/suppliers/README.md b/lending/docs/sdks/suppliers/README.md index 657e4994..ef9f66d5 100644 --- a/lending/docs/sdks/suppliers/README.md +++ b/lending/docs/sdks/suppliers/README.md @@ -19,9 +19,9 @@ The *List suppliers* endpoint returns a list of [suppliers](https://docs.codat.i Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Clear Books - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -39,37 +39,700 @@ var res = await sdk.AccountsPayable.Suppliers.ListAsync(req); // handle response ``` +### Example Usage: Dynamics 365 Business Central -### Parameters + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; -| Parameter | Type | Required | Description | -| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `request` | [ListAccountingSuppliersRequest](../../Models/Requests/ListAccountingSuppliersRequest.md) | :heavy_check_mark: | The request object to use for the request. | +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -### Response +ListAccountingSuppliersRequest req = new ListAccountingSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; -**[ListAccountingSuppliersResponse](../../Models/Requests/ListAccountingSuppliersResponse.md)** +var res = await sdk.AccountsPayable.Suppliers.ListAsync(req); -### Errors +// handle response +``` +### Example Usage: Exact (Netherlands) -| Error Type | Status Code | Content Type | -| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | -| Codat.Lending.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 409, 429 | application/json | -| Codat.Lending.Models.Errors.ErrorMessage | 500, 503 | application/json | -| Codat.Lending.Models.Errors.SDKException | 4XX, 5XX | \*/\* | + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; -## Get +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); -The *Get supplier* endpoint returns a single supplier for a given supplierId. +ListAccountingSuppliersRequest req = new ListAccountingSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; -[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. +var res = await sdk.AccountsPayable.Suppliers.ListAsync(req); -Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). +// handle response +``` +### Example Usage: Exact (UK) + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; -### Example Usage +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingSuppliersRequest req = new ListAccountingSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingSuppliersRequest req = new ListAccountingSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingSuppliersRequest req = new ListAccountingSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingSuppliersRequest req = new ListAccountingSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingSuppliersRequest req = new ListAccountingSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingSuppliersRequest req = new ListAccountingSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingSuppliersRequest req = new ListAccountingSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingSuppliersRequest req = new ListAccountingSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingSuppliersRequest req = new ListAccountingSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingSuppliersRequest req = new ListAccountingSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingSuppliersRequest req = new ListAccountingSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingSuppliersRequest req = new ListAccountingSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: Wave + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingSuppliersRequest req = new ListAccountingSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingSuppliersRequest req = new ListAccountingSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Suppliers.ListAsync(req); + +// handle response +``` +### Example Usage: Zoho Books + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingSuppliersRequest req = new ListAccountingSuppliersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.AccountsPayable.Suppliers.ListAsync(req); + +// handle response +``` + +### Parameters + +| Parameter | Type | Required | Description | +| ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `request` | [ListAccountingSuppliersRequest](../../Models/Requests/ListAccountingSuppliersRequest.md) | :heavy_check_mark: | The request object to use for the request. | + +### Response + +**[ListAccountingSuppliersResponse](../../Models/Requests/ListAccountingSuppliersResponse.md)** + +### Errors + +| Error Type | Status Code | Content Type | +| ---------------------------------------- | ---------------------------------------- | ---------------------------------------- | +| Codat.Lending.Models.Errors.ErrorMessage | 400, 401, 402, 403, 404, 409, 429 | application/json | +| Codat.Lending.Models.Errors.ErrorMessage | 500, 503 | application/json | +| Codat.Lending.Models.Errors.SDKException | 4XX, 5XX | \*/\* | + +## Get + +The *Get supplier* endpoint returns a single supplier for a given supplierId. + +[Suppliers](https://docs.codat.io/lending-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service. + +Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). + + +### Example Usage: Clear Books + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingSupplierRequest req = new GetAccountingSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingSupplierRequest req = new GetAccountingSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (Netherlands) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingSupplierRequest req = new GetAccountingSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: Exact (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingSupplierRequest req = new GetAccountingSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingSupplierRequest req = new GetAccountingSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: FreshBooks + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingSupplierRequest req = new GetAccountingSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: KashFlow + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingSupplierRequest req = new GetAccountingSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingSupplierRequest req = new GetAccountingSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingSupplierRequest req = new GetAccountingSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingSupplierRequest req = new GetAccountingSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingSupplierRequest req = new GetAccountingSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 200cloud + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingSupplierRequest req = new GetAccountingSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: Sage 50 (UK) + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingSupplierRequest req = new GetAccountingSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingSupplierRequest req = new GetAccountingSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingSupplierRequest req = new GetAccountingSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: Wave + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingSupplierRequest req = new GetAccountingSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: Xero + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingSupplierRequest req = new GetAccountingSupplierRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + SupplierId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.AccountsPayable.Suppliers.GetAsync(req); + +// handle response +``` +### Example Usage: Zoho Books - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/transactioncategories/README.md b/lending/docs/sdks/transactioncategories/README.md index 832d9d3b..b23623e9 100644 --- a/lending/docs/sdks/transactioncategories/README.md +++ b/lending/docs/sdks/transactioncategories/README.md @@ -16,9 +16,30 @@ The *List transaction categories* endpoint returns a list of [transaction catego Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Basiq - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListBankingTransactionCategoriesRequest req = new ListBankingTransactionCategoriesRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Banking.TransactionCategories.ListAsync(req); + +// handle response +``` +### Example Usage: Plaid + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -65,9 +86,29 @@ The *Get transaction category* endpoint returns a single transaction category fo Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Basiq + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetBankingTransactionCategoryRequest req = new GetBankingTransactionCategoryRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + TransactionCategoryId = "", +}; + +var res = await sdk.Banking.TransactionCategories.GetAsync(req); + +// handle response +``` +### Example Usage: Plaid - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; diff --git a/lending/docs/sdks/transfers/README.md b/lending/docs/sdks/transfers/README.md index 5bea57fe..fa208399 100644 --- a/lending/docs/sdks/transfers/README.md +++ b/lending/docs/sdks/transfers/README.md @@ -16,9 +16,177 @@ The *List transfers* endpoint returns a list of [transfers](https://docs.codat.i Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Clear Books - + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingTransfersRequest req = new ListAccountingTransfersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.Transfers.ListAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingTransfersRequest req = new ListAccountingTransfersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.Transfers.ListAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingTransfersRequest req = new ListAccountingTransfersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.Transfers.ListAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingTransfersRequest req = new ListAccountingTransfersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.Transfers.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingTransfersRequest req = new ListAccountingTransfersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.Transfers.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingTransfersRequest req = new ListAccountingTransfersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.Transfers.ListAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingTransfersRequest req = new ListAccountingTransfersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.Transfers.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +ListAccountingTransfersRequest req = new ListAccountingTransfersRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + Query = "id=e3334455-1aed-4e71-ab43-6bccf12092ee", + OrderBy = "-modifiedDate", +}; + +var res = await sdk.Transactions.Transfers.ListAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct + + ```csharp using Codat.Lending; using Codat.Lending.Models.Components; @@ -65,9 +233,169 @@ The *Get transfer* endpoint returns a single transfer for a given transferId. Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data). -### Example Usage +### Example Usage: Clear Books + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingTransferRequest req = new GetAccountingTransferRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + TransferId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.Transfers.GetAsync(req); + +// handle response +``` +### Example Usage: Dynamics 365 Business Central + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingTransferRequest req = new GetAccountingTransferRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + TransferId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.Transfers.GetAsync(req); + +// handle response +``` +### Example Usage: FreeAgent + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingTransferRequest req = new GetAccountingTransferRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + TransferId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.Transfers.GetAsync(req); + +// handle response +``` +### Example Usage: Oracle NetSuite + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingTransferRequest req = new GetAccountingTransferRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + TransferId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.Transfers.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Desktop + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingTransferRequest req = new GetAccountingTransferRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + TransferId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.Transfers.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingTransferRequest req = new GetAccountingTransferRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + TransferId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.Transfers.GetAsync(req); + +// handle response +``` +### Example Usage: QuickBooks Online Sandbox + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingTransferRequest req = new GetAccountingTransferRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + TransferId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.Transfers.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Business Cloud Accounting + + +```csharp +using Codat.Lending; +using Codat.Lending.Models.Components; +using Codat.Lending.Models.Requests; + +var sdk = new CodatLending(authHeader: "Basic BASE_64_ENCODED(API_KEY)"); + +GetAccountingTransferRequest req = new GetAccountingTransferRequest() { + CompanyId = "8a210b68-6988-11ed-a1eb-0242ac120002", + ConnectionId = "2e9d2c44-f675-40ba-8049-353bfcb5e171", + TransferId = "13d946f0-c5d5-42bc-b092-97ece17923ab", +}; + +var res = await sdk.Transactions.Transfers.GetAsync(req); + +// handle response +``` +### Example Usage: Sage Intacct - + ```csharp using Codat.Lending; using Codat.Lending.Models.Components;